<!--
Copyright (c) 2022-2023 Geosiris.
SPDX-License-Identifier: Apache-2.0
-->
ETP Protocol Implementation
==========
[](https://github.com/geosiris-technologies/etpproto-python/blob/main/LICENSE)
[](https://etpproto-python.readthedocs.io/en/latest/?badge=latest)
[](https://github.com/geosiris-technologies/etpproto-python/actions/workflows/ci-tests.yml)
[](https://badge.fury.io/py/etpproto)
[](https://codecov.io/gh/geosiris-technologies/etpproto-python)
Installation
----------
Etpproto-python can be installed with pip :
```console
pip install etpproto
```
or with poetry:
```console
poetry add etpproto
```
Developing
----------
First clone the repo from gitlab.
```console
git clone https://github.com/geosiris-technologies/etpproto-python.git
```
To develop, you should use **[Poetry](https://python-poetry.org/)**.
Install all necessary packages (including for development) with:
```console
poetry install
```
Then setup the Git pre-commit hook for **[Black](<https://github.com/psf/black>)** and **[Pylint](https://www.pylint.org/)** by running
```console
poetry run pre-commit install
```
as the ``rev`` gets updated through time to track changes of different hooks,
simply run
```console
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
```console
poetry run pytest -v --cache-clear -rf --cov=etpproto/ --cov-report=term --cov-report=html --maxfail=10
```
Test the code validity :
```console
poetry run black .
poetry run flake8 .
poetry run mypy etpproto
```
Raw data
{
"_id": null,
"home_page": "http://www.geosiris.com",
"name": "etpproto",
"maintainer": "Lionel Untereiner",
"docs_url": null,
"requires_python": "<4.0,>=3.9",
"maintainer_email": "lionel.untereiner@geosiris.com",
"keywords": "ETP",
"author": "Lionel Untereiner",
"author_email": "lionel.untereiner@geosiris.com",
"download_url": "https://files.pythonhosted.org/packages/67/21/6f4f38f35e85a6ab3f9c1097196aa9b1b43767f514eb1606c3df0a9263f8/etpproto-1.0.6.tar.gz",
"platform": null,
"description": "<!--\nCopyright (c) 2022-2023 Geosiris.\nSPDX-License-Identifier: Apache-2.0\n-->\nETP Protocol Implementation\n==========\n\n[](https://github.com/geosiris-technologies/etpproto-python/blob/main/LICENSE)\n[](https://etpproto-python.readthedocs.io/en/latest/?badge=latest)\n[](https://github.com/geosiris-technologies/etpproto-python/actions/workflows/ci-tests.yml)\n\n[](https://badge.fury.io/py/etpproto)\n\n[](https://codecov.io/gh/geosiris-technologies/etpproto-python)\n\n\n\n\nInstallation\n----------\n\nEtpproto-python can be installed with pip : \n\n```console\npip install etpproto\n```\n\nor with poetry: \n```console\npoetry add etpproto\n```\n\n\nDeveloping\n----------\n\nFirst clone the repo from gitlab.\n\n```console\n git clone https://github.com/geosiris-technologies/etpproto-python.git\n```\n\nTo develop, you should use **[Poetry](https://python-poetry.org/)**.\n\nInstall all necessary packages (including for development) with:\n\n```console\n poetry install\n```\n\nThen setup the Git pre-commit hook for **[Black](<https://github.com/psf/black>)** and **[Pylint](https://www.pylint.org/)** by running\n\n```console\n poetry run pre-commit install\n```\n\nas the ``rev`` gets updated through time to track changes of different hooks,\nsimply run\n\n```console\n poetry run pre-commit autoupdate\n```\nto have pre-commit install the new version.\n\nTo bump a new version of the project simply publish a release name 'vX.X.X' with X replaced by your numbers\n\nTest\n----------\n\nRun tests with poetry\n```console\npoetry run pytest -v --cache-clear -rf --cov=etpproto/ --cov-report=term --cov-report=html --maxfail=10\n```\n\nTest the code validity : \n```console\npoetry run black .\npoetry run flake8 .\npoetry run mypy etpproto\n```",
"bugtrack_url": null,
"license": "Apache-2.0",
"summary": "ETP protocol implementation",
"version": "1.0.6",
"project_urls": {
"Homepage": "http://www.geosiris.com",
"Repository": "https://github.com/geosiris-technologies/etpproto-python"
},
"split_keywords": [
"etp"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "14af6b2478a250c775536c2572f64a0d78a1a7251c134c7c0a2534827cab2c96",
"md5": "085d7995463960ca2e8b868cca3ab367",
"sha256": "5c87234d6924f902784a6458f5e504f40ff1e1b5b354db0fded77d0772b74608"
},
"downloads": -1,
"filename": "etpproto-1.0.6-py3-none-any.whl",
"has_sig": false,
"md5_digest": "085d7995463960ca2e8b868cca3ab367",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": "<4.0,>=3.9",
"size": 44380,
"upload_time": "2025-01-23T13:58:59",
"upload_time_iso_8601": "2025-01-23T13:58:59.776811Z",
"url": "https://files.pythonhosted.org/packages/14/af/6b2478a250c775536c2572f64a0d78a1a7251c134c7c0a2534827cab2c96/etpproto-1.0.6-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "67216f4f38f35e85a6ab3f9c1097196aa9b1b43767f514eb1606c3df0a9263f8",
"md5": "dcb87b938cb5960aad700d32fe969738",
"sha256": "3a2d1a91b727ae3bb2702075ca3839e82b1e6653c490e3501e0402b17bfbce98"
},
"downloads": -1,
"filename": "etpproto-1.0.6.tar.gz",
"has_sig": false,
"md5_digest": "dcb87b938cb5960aad700d32fe969738",
"packagetype": "sdist",
"python_version": "source",
"requires_python": "<4.0,>=3.9",
"size": 30136,
"upload_time": "2025-01-23T13:59:00",
"upload_time_iso_8601": "2025-01-23T13:59:00.860000Z",
"url": "https://files.pythonhosted.org/packages/67/21/6f4f38f35e85a6ab3f9c1097196aa9b1b43767f514eb1606c3df0a9263f8/etpproto-1.0.6.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2025-01-23 13:59:00",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "geosiris-technologies",
"github_project": "etpproto-python",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "etpproto"
}
JSON
