Boilerplate to create a project with a Python module. More information at @fernandojunior/python-boilerplate.
>>> import module_name
>>> from module_name import hello_world
>>> print(hello_world)
Hello World- coverage.py - Code coverage measurement.
- Flake8 - The modular source code checker: pep8, pyflakes and co.
- pytest - A mature full-featured Python testing tool.
- setuptools - Easily download, build, install, upgrade, and uninstall distribution packages.
- tox - Auto builds and tests distributions in multiple Python versions using virtualenvs.
├── CONTRIBUTING.md
├── LICENSE
├── Makefile
├── MANIFEST.in
├── module_name.py # The core code of the project
├── README.md
├── requirements
│ ├── dev.txt
│ └── prod.txt
├── requirements.txt
├── setup.cfg
├── setup.py
├── tests.py
└── tox.iniMore datails here.
- author_name - Full name of the author.
- github_username - GitHub username.
- module_name - Name of the module using PEP8 style.
- project_name - Short name of your project using slug style.
You can use your preferred text editor or IDE to find the keywords. In Sublime and Atom this is done by Ctrl + Shift + F.
See CONTRIBUTING.
The MIT License.
Copyright (c) 2016 Fernando Felix do Nascimento Junior.