geosiris-technologies / etpproto-python

A pure-Python, bring-your-own-I/O, implementation of ETP v1.2

ETP Protocol Implementation

Installation

Etpproto-python can be installed with pip :

pip install etpproto

or with poetry:

poetry add etpproto

Developing

First clone the repo from gitlab.

    git clone https://github.com/geosiris-technologies/etpproto-python.git

To develop, you should use Poetry.

Install all necessary packages (including for development) with:

    poetry install

Then setup the Git pre-commit hook for Black and Pylint by running

    poetry run pre-commit install

as the rev gets updated through time to track changes of different hooks, simply run

    poetry run pre-commit autoupdate

to have pre-commit install the new version.

To bump a new version of the project simply publish a release name 'vX.X.X' with X replaced by your numbers

Test

Run tests with poetry

poetry run pytest -v --cache-clear -rf --cov=etpproto/ --cov-report=term --cov-report=html --maxfail=10

Test the code validity :

poetry run black .
poetry run flake8 .
poetry run mypy etpproto

etpproto-python's Issues

Licence

Add Spdx license format and copyright to all files