https://medium.com/@joel.barmettler/how-to-upload-your-python-package-to-pypi-65edc5fe9c56
The Python Package Index, abbreviated as PyPI, is the official repository of software for the Python programming language. By default, pip — which is the most popular Python package manager — uses PyPI as the source for retrieving package dependencies.
PyPI lets you find, install and even publish your Python packages so that they are widely available to the public. More than 300,000 different packages are currently published in the index with more than 2,500,000 releases being distributed to users.
To create a package, create a folder that is named exactly how you want your package to be named. Place all the files setup.py , README.txt, manifest.in, LICENSE.txt,__init__.py Changelog.txt.
Now, create a file called __init__.py (again two underscores). Open the file with your text editor of choice. In this file, you write nothing but import statements that have the following schema:
The init.py file is used to mark which classes you want the user to access through the package interface.
Then, remove all print-statements and all the code that does not sit inside of a class. Finally, create the init.py-file and import all the methods that the user should access. MyLib -init.py -File1.py -File1.py
Create a PyPi account You can register yourself for a PyPi account here. Remember your username (not the Name, not the E-Mail Address) and your password, you will need it later for the upload process. Upload your package to github.com Create a github repo including all the files we are going to create in a second, as well as your package folder. Name the repo exactly as the package. You find an example of such a repo here. Create the files PyPi needs PyPi needs three files in order to work: setup.py setup.cfg LICENSE.txt README.md (optinal but highly recommended) Place all these files outside of your package folder: MyLib setup.py setup.cfg LICENSE.txt README.md Let’s go through this files one-by-one setup.py The setup.py file contains information about your package that PyPi needs, like its name, a description, the current version etc. Copy and Paste the following Code and replace the Strings with your matching content:
Let me explain the download_url and the install_requires a bit further. download_url You have previously uploaded your project to your github repository. Now, we create a new release version of your project on github. This release will then be downloaded by anyone that runs the “pip install YourPackage” command. First, go to github.com and navigate to your repository. Next, click on the tab “releases” and then on “Create a new release”. Now, define a Tag verion (it is best to use the same number as you used in your setup.py version-field: v_01. Add a release title and a description (not that important), then click on “publish release”. Now you see a new release and under Assets, there is a link to Source Code (tar.gz). Right-click on this link and chose Copy Link Address. Paste this link-address into the download_url field in the setup.py file. Every time you want to update your package later on, upload a new version to github, create a new release as we just discussed, specify a new release tag and copy-paste the link to Source into the setup.py file (do not forget to also increment the version number). Install_requires Here, you define all the dependencies your package has — all the pip packages that you are importing. Simply speaking: Go through all your Classes and watch what you have imported. Every package that you have imported and downloaded via pip (most propably all, except the standard libraries) must be listed here as an install_requires by adding the package name. Let me give you an example
The packages “numpy” and “scrapeasy” were downloaded via pip, so you need to add “numpy” and “scrapeasy” in your dependencies. But how do you know whether a package is a standard library or downloaded via pip? Well, simply open your cmd and type pip install packagename. If you get “Requirement already satisfied”, you are good to go. If you get an error stating “Could not find a version that satisfies the requirement”, you know that this package is either not installed via pip or a standard library. The resulting install_requires field would look like this:
setup.cfg This is a short one. Create a new file called “setup.cfg”. If you have a description file (and you definitely should!), you can specify it here:
LICENSE.txt Use this file to define all license details. Most propably, just copy-paste the license text from this website into the LICENSE.txt file. I always use the MIT license for my projects, but feel free to use your own.
README.md (Optional) Create a markdown file with this beautiful website, then download it and place it into your directory. Upload your package to PyPi Now, the final step has come: uploading your project to PyPi. First, open the command prompt and navigate into your the folder where you have all your files and your package located: cd "C://PATH//TO//YOUR//FOLDER" Now, we create a source distribution with the following command: python setup.py sdist You might get a warning stating “Unknown distribution option: ‘install_requires’. Just ignore it. We will need twine for the upload process, so first install twine via pip: pip install twine Then, run the following command: twine upload dist/* You will be asked to provide your username and password. Provide the credentials you used to register to PyPi earlier. Congratulations, your package is now uploaded! Visit https://pypi.org/project/YOURPACKAGENAME/ to see your package online! Install your own package using pip Okay, now let’s test this out. Open your console and type the following command: pip install YOURPACKAGENAME It works! Now open the python SHELL/IDLE and import your package.