Skip to content

Latest commit

 

History

History
102 lines (77 loc) · 1.12 KB

CONTRIBUTING.md

File metadata and controls

102 lines (77 loc) · 1.12 KB

Contributing

Contributions are welcome!

Dependencies

pipenv --rm
pipenv sync
pipenv sync --dev

pipenv check
pipenv update
pipenv update --dev
vim requirements.txt
vim requirements_dev.txt

Version

  • arpa/__init__.py
    • __date__
    • __version__
  • docs/conf.py
    • release
    • version
  • setup.py
    • version
  • AUTHORS.md
  • HISTORY.md

Format

pipenv run yapf -e docs/conf.py -i -r .
pipenv run flake8 .

Documentation

cd docs
pipenv run sphinx-apidoc -f -o . ../arpa
cd docs
pipenv run make html
cd docs
pipenv run sphinx-build -nWT -b html -d _build/doctrees . _build/html

Packaging

git clean -dxn
git clean -dxf
pipenv run check-manifest -v
pipenv run pyroma .

Tests

pipenv run python setup.py test

Release

pipenv run python setup.py check

pipenv run python setup.py sdist
pipenv run python setup.py bdist_wheel

pipenv run twine check dist/*

pipenv run twine upload dist/*