diff --git a/plugins/pypi/README.md b/plugins/pypi/README.md index 765f1b260..73f4d5c07 100644 --- a/plugins/pypi/README.md +++ b/plugins/pypi/README.md @@ -7,3 +7,11 @@ To access this plugin, add the parameter `pypi` to the plugins array of your zsh plugins=(... pypi) ``` +## Aliases + +| Alias Command | Original Command | Description | +|------------------------|-----------------------------------------------------------------------|----------------------------------------------------------------------------------------| +| `pypi-check` | `pip3 install twine setuptools` | Used to check the required libraries to upload a package in pypi | +| `pypi-ltest` | `python3 setup.py sdist && python3 -m pip install dist/*` | Used to install setup.py file to local machine for testing before uploading into pypi. | +| `pypi-tupload` | `python3 setup.py sdist && twine upload --repository testpypi dist/*` | Used to upload a python package to testpypi for testing | +| `pypi-upload` | `python3 setup.py sdist && twine upload dist/*` | Used to upload a python package to pypi. |