Skip to content

Latest commit

 

History

History
118 lines (96 loc) · 4.2 KB

CONTRIBUTING.md

File metadata and controls

118 lines (96 loc) · 4.2 KB
Raw

Contributing

Goals

Part of the Duniter project running the Ğ1 currency, Silkaj project is aiming to create a generic tool to manage his account and wallets, and to monitor the currency.

Install the development environment

We are using Poetry as a development environment solution. Start installing Poetry. This will install a sandboxed Python environment. Dependencies will be installed in it in order to have Silkaj running and to have pre-installed developement tools.

Workflow

  • We use branches for merge requests
  • We prefer fast-forward and rebase method than having a merge commit. This in order to have a clean history.

Branches

  • master branch as stable
  • maintainance branches, to maintain a stable version while developing future version with breaking changes. For instance: 0.7
  • dev branch

Developing with DuniterPy

DuniterPy is a Python library for Duniter clients. It implements a client with multiple APIs, the handling for document signing. As it is coupled with Silkaj, it is oftenly needed to develop in both repositories.

How to use DuniterPy as editable with Poetry

Clone DuniterPy locally alongside of silkaj repository:

silkaj> cd ..
git clone https://git.duniter.org/clients/python/duniterpy

Use DuniterPy as a path dependency:

poetry add ../duniterpy

Formatting

We are using Black formatter tool. To have Black installed in your Poetry virtualenv, you will need Python v3.6 or greater. Run Black on a Python file to format it:

poetry run black silkaj/cli.py

Pre-commit

Then, you can use the pre-commit tool to check staged changes before committing. To do so, you need to run pre-commit install to install the git hook. Black is called on staged files, so commit should fail in case black made changes. You will have to add Black changes in order to commit your changes.

Tests

We are using Pytest as a tests framework. To know more about how Silkaj implement it read the project test documentation.

To run tests, within silkaj repository:

poetry run pytest

How to test a single file

Specifiy the path of the test:

poetry run pytest tests/test_end_to_end.py

Version update

We are using the Semantic Versioning.

To create a release, we use following script which will update the version in different files, and will make a commit and a tag out of it.

./release.sh 0.8.1

Then, a git push --tags is necessary to publish the tag. Git could be configured to publish tags with a simple push.

PyPI and PyPI test distributions

Silkaj is distributed to PyPI, the Python Package Index, for further pip installation. Silkaj can be published to PyPI or to PyPI test for testing purposes. Publishing to PyPI or PyPI test can be directly done from the continuous delivery or from Poetry it-self. The CD jobs does appear on a tag and have to be triggered manually. Only the project maintainers have the rights to publish tags.

PyPI

Publishing to PyPI from Poetry:

poetry publish --build

PyPI test

Publishing to PyPI test from Poetry:

poetry config repositories.pypi_test https://test.pypi.org/legacy/
poetry publish --build --repository pypi_test

To install this package:

pip install --index-url https://test.pypi.org/simple/ --extra-index-url https://pypi.python.org/simple/ silkaj

The --extra-index-url is used to retrieve dependencies packages from the official PyPI not to get issues with missing or testing dependencies comming from PyPI test repositories.

Continuous integration and delivery

Own built Docker images

Jobs

  • Checks:
    • Format
    • Build
  • Tests on supported Python versions:
    • Installation
    • Pytest for v3.6, 3.7, and 3.8
  • PyPI distribution
    • test
    • stable