No project description provided
Project description
RE-Lab_template
Template repository for Python projects
Get started
Simply click on the green Use this template
button on the left of the Clone or download
button.
The detailed instructions to create a new repository from this template can be found here.
src folder
This folder is where you should place the code of your package (package name to be edited in setup.py
under name)
You can install it locally for developing with
python setup.py install
More details for packaging are available on https://packaging.python.org
Docs
To build the docs simply go to the docs
folder
cd docs
Install the requirements
pip install -r docs_requirements.txt
and run
make html (Linux)
make.bat html (Windows)
The output will then be located in docs/_build/html
and can be opened with your favorite browser
Code linting
In this template, 3 possible linters are proposed:
- flake8 only sends warnings and error about linting (PEP8)
- pylint sends warnings and error about linting (PEP8) and also allows warning about imports order
- black sends warning but can also fix the files for you
You can perfectly use the 3 of them or subset, at your preference. Don't forget to edit .travis.yml
if you want to deactivate the automatic testing of some linters!
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for RE_Lab_template-0.0.0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 9276dd8cd6354b6aa2c59599ac392c7c7da52eb1f254837940ba3ac7a1bc3891 |
|
MD5 | da658a39e9aadd907fe39b920813d7dd |
|
BLAKE2b-256 | 3a898bd19807d0fd5a89606b4f4ed14f03b1d160ebdef769b57c23cd2003e378 |