[x] Install setuptools and twine using pip if they aren't already. Create a setup.py in your source folder as follows (check out setuptools docs for more detailed setup options):
# replace:
# <your_package> with your actual package name.
# <you> with your name.
# <your_email> with your public email address.
# <your_github_repo_url> with your github project's url.
from setuptools import setup, find_packages
s = setup(
name="<your_package>",
version="1.0.0",
license="<LISCENCE>",
description="scotia",
url='<your_github_repo_url>",
packages=find_packages(),
install_requires=[],
python_requires = ">= 3.4",
author="<you>",
author_email="<your_email>",
)
[x] Optional: Bump up the version number (and git commit) if this isn't your first release:
In preperation for release on pypi here's a generic checklist of things to do:
Checklist: Initallize a package for publishing to PyPi
[x] #13
[x] Create:
HISTORY.md
,LICENSE.txt
, andsetup.py
[x] Update
HISTORY.md
with changes or "project start"[x] Commit the changes:
[x] Install
setuptools
andtwine
usingpip
if they aren't already. Create asetup.py
in your source folder as follows (check out setuptools docs for more detailed setup options):[x] Optional: Bump up the version number (and git commit) if this isn't your first release:
[x] Run
python setup.py sdist
from your source folder to generate a source distribution.[x] Optional: Sign the newly generated package with your
gpg
signature:[x] Upload your package using
twine
:If you've signed the package, then you may also add the signed .asc file as the argument like this:
[x] Visit https://pypi.org/project/your_package to verify that your package has been uploaded.
[x] Run
pip install <your_package>
to verify the package installation using pip package manager.[x] Optional: Tag the commit with the new version number: