Reading long description from README.md with type="text/markdown". Added TODOs everywhere that something needs to be adjusted
|4 months ago|
|src/package_name||1 year ago|
|tests||1 year ago|
|.gitignore||1 year ago|
|LICENSE||1 year ago|
|MANIFEST.in||1 year ago|
|README.md||1 year ago|
|requirements.txt||1 year ago|
|setup.py||4 months ago|
This repository holds the basic directory layout for new python projects. Additional to a reasonable minimum of features (setup.py, requirements.txt, directory structure, ...) it contains the following extras:
- basic unittest
script.pyand associated entrypoint in
setup.py(allows to call some functionality of the package directly from command line (try
- Rename directory
setupy.py: replace dummy data with real data.
- Add your source. a) Either to
core.pyor b) to your own separate file(s).
- a) simplifies importing your module
- b) is more flexible but you have to take care of importability yourself.
For local development it is recommended to install this (better: your) package in editable mode:
pip install -e . (run from where
Publishing on pypi
To publish your package on Python Package Index (pypi) the following commands should work:
python setup.py sdist
twine upload --repository-url https://upload.pypi.org/legacy/ -u <username> dist/*
- You need to register a username first.
- There is probably a more modern way for uploading to pypi.