- Use syntax compatible with Python
3.1+
. - Use docstrings with
sphinx
in mind - 4 spaces are the preferred indentation method.
- No trailing white spaces are allowed.
- Restrict each line of code to 80 characters.
- Follow the PEP8 style guide: https://www.python.org/dev/peps/pep-0008/
- Always run
make test
before submitting a new PR. You need to runpip3 install -e .[develop]
in the papis directory before running the tests.
Send patches, created with git format-patch
, to the email address
or open a pull request on GitHub.
Three numbers, A.B.C
, where
A
changes on a rewriteB
changes when major configuration incompatibilities occurC
changes with each release (bug fixes..)
- Add a default value in
config.py
, along with a comment that describes the option.
The setting is now accessible with papis.config.get('myoption')
or through the cli interface papis config myoption
.
- You can add scripts for everyone to share to the folder
examples/scripts/
in the repository. These scripts will not be shipped with papis, but they are there for other users to use and modify.
TODO: explain how to add new downloaders