Show how to structure a Python project.
.. image:: https://travis-ci.org/bast/somepackage.svg?branch=master :target: https://travis-ci.org/bast/somepackage/builds .. image:: https://img.shields.io/badge/license-%20MPL--v2.0-blue.svg :target: ../master/LICENSE
Show how to structure a Python project.
Inspired by https://github.com/kennethreitz/samplemod.
Please browse this blog post for a good summary of recommendatios and templates: https://medium.com/@jonas.r.kemper/understanding-best-practice-python-tooling-by-comparing-popular-project-templates-6eba49229106
if __name__ == '__main__':).
somepackage/using
from .somemodule import something.
somepackage/__init__.pydefine what should be visible to the outside.
requirements.txt.
setup.py.
pycodestyleto automatically check for PEP8.
I used to recommend reStructuredText for READMEs in contrast to Markdown but PyPI no longer requires reStructuredText. You can use Markdown as noted on https://pypi.org/help/ under "How can I upload a project description in a different format?".
Example shown here: https://packaging.python.org/tutorials/packaging-projects/#creating-setup-py
Yes please!