<!--
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": ">=3.9,<4.0",
"maintainer_email": "lionel.untereiner@geosiris.com",
"keywords": "ETP",
"author": "Lionel Untereiner",
"author_email": "lionel.untereiner@geosiris.com",
"download_url": "https://files.pythonhosted.org/packages/72/2e/3e14d03e66ff68101b99dc3ca4d9a0556c3ba96316bcdc0bdcacbbee08a1/etpproto-1.0.5.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.5",
"project_urls": {
"Homepage": "http://www.geosiris.com",
"Repository": "https://github.com/geosiris-technologies/etpproto-python"
},
"split_keywords": [
"etp"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "49b7b0f548b5c5bb336051a184f5df727fb3dd5f169eecfcd2252aecc51de0f2",
"md5": "8007a6e8e094aa6cf62bba54d7f48296",
"sha256": "390466de3638768eb55fcc9c094dfd57f6998d1ca21d3485cc753f914801d9a4"
},
"downloads": -1,
"filename": "etpproto-1.0.5-py3-none-any.whl",
"has_sig": false,
"md5_digest": "8007a6e8e094aa6cf62bba54d7f48296",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.9,<4.0",
"size": 44275,
"upload_time": "2023-12-15T08:48:49",
"upload_time_iso_8601": "2023-12-15T08:48:49.986384Z",
"url": "https://files.pythonhosted.org/packages/49/b7/b0f548b5c5bb336051a184f5df727fb3dd5f169eecfcd2252aecc51de0f2/etpproto-1.0.5-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "722e3e14d03e66ff68101b99dc3ca4d9a0556c3ba96316bcdc0bdcacbbee08a1",
"md5": "9c756a4ba477e2f81d795fff51f39e75",
"sha256": "bfdc12cf5030ac41e3d0e7c36bbdc7d4e72b0e99839ed0c6b79a7ed5922b0a71"
},
"downloads": -1,
"filename": "etpproto-1.0.5.tar.gz",
"has_sig": false,
"md5_digest": "9c756a4ba477e2f81d795fff51f39e75",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.9,<4.0",
"size": 30548,
"upload_time": "2023-12-15T08:48:51",
"upload_time_iso_8601": "2023-12-15T08:48:51.183985Z",
"url": "https://files.pythonhosted.org/packages/72/2e/3e14d03e66ff68101b99dc3ca4d9a0556c3ba96316bcdc0bdcacbbee08a1/etpproto-1.0.5.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-12-15 08:48:51",
"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
