From 07859264993b07864bb8b097f27ad6f390dea0c4 Mon Sep 17 00:00:00 2001 From: "Juan M. Tirado" Date: Thu, 1 Aug 2024 09:41:14 +0200 Subject: [PATCH] docs/rewording readme (#68) * docs: rewording readme * fix: update poetry lock * fix: update changelog for debian package --- README.md | 20 +++++++------------- debian/changelog | 8 +++++++- poetry.lock | 12 ++++++------ pyproject.toml | 2 +- 4 files changed, 21 insertions(+), 21 deletions(-) diff --git a/README.md b/README.md index f3a8e78..104bd41 100644 --- a/README.md +++ b/README.md @@ -89,23 +89,12 @@ If you're hosting this on a cloud provider (AWS, GCP, Azure or alike), these are #### Python package -We distribute the package in test-pypi and pypi under the following projects: https://test.pypi.org/project/pantos-service-node/ and https://pypi.org/project/pantos-service-node/. You can install it to your project by using `pip install pantos-service-node`. +We distribute the package in pypi under the following project and https://pypi.org/project/pantos-service-node/. You can install it to your project by using `pip install pantos-service-node`. ### 2.2 Prerequisites Please make sure that your environment meets the following requirements: -#### Conda - -Conda is only required to build the package, but you can also use it as your python version management tool. To install conda, follow the instructions [here](https://docs.conda.io/projects/conda/en/latest/user-guide/install/linux.html). - -After activating it, you can directly call poetry install on your new environment: - -```bash -conda env create -f environment.yml -conda activate default -``` - #### Python Version The Pantos Service Node supports **Python 3.10** or higher. Ensure that you have the correct Python version installed before the installation steps. You can download the latest version of Python from the official [Python website](https://www.python.org/downloads/). @@ -128,6 +117,11 @@ By default poetry creates the venv directory under under ```{cache-dir}/virtuale poetry config virtualenvs.in-project true ``` +#### Conda (Debian package building only) + +Conda is only required to build the Debian package. To install conda, follow the instructions [here](https://docs.conda.io/projects/conda/en/latest/user-guide/install/linux.html). Check the installation was correct running `conda -version`. + + ### 2.2 Installation Steps #### Libraries @@ -135,7 +129,7 @@ poetry config virtualenvs.in-project true Create the virtual environment and install the dependencies: ```bash -$ poetry install --no-root +poetry install --no-root ``` #### Pre-commit diff --git a/debian/changelog b/debian/changelog index f38f6ea..0cdcdb9 100644 --- a/debian/changelog +++ b/debian/changelog @@ -1,4 +1,10 @@ -pantos-service-node (1.8.1) UNRELEASED; urgency=medium +pantos-service-node (1.8.2) UNRELEASED; urgency=medium + + * NA + + -- Pantos GmbH Thu, 24 Jun 2024 14:00:15 +0000 + +pantos-service-node (1.8.1) RELEASED; urgency=medium * pantos-service-node: Initial debian packaging diff --git a/poetry.lock b/poetry.lock index 9afce65..41ddf16 100644 --- a/poetry.lock +++ b/poetry.lock @@ -1173,13 +1173,13 @@ test = ["hypothesis (>=4.43.0)", "mypy (==0.971)", "pytest (>=7.0.0)", "pytest-x [[package]] name = "exceptiongroup" -version = "1.2.1" +version = "1.2.2" description = "Backport of PEP 654 (exception groups)" optional = false python-versions = ">=3.7" files = [ - {file = "exceptiongroup-1.2.1-py3-none-any.whl", hash = "sha256:5258b9ed329c5bbdd31a309f53cbfb0b155341807f6ff7606a1e801a891b29ad"}, - {file = "exceptiongroup-1.2.1.tar.gz", hash = "sha256:a4785e48b045528f5bfe627b6ad554ff32def154f42372786903b7abcfe1aa16"}, + {file = "exceptiongroup-1.2.2-py3-none-any.whl", hash = "sha256:3111b9d131c238bec2f8f516e123e14ba243563fb135d3fe885990585aa7795b"}, + {file = "exceptiongroup-1.2.2.tar.gz", hash = "sha256:47c2edf7c6738fafb49fd34290706d1a1a2f4d1c6df275526b62cbb4aa5393cc"}, ] [package.extras] @@ -1526,13 +1526,13 @@ files = [ [[package]] name = "importlib-metadata" -version = "8.0.0" +version = "8.2.0" description = "Read metadata from Python packages" optional = false python-versions = ">=3.8" files = [ - {file = "importlib_metadata-8.0.0-py3-none-any.whl", hash = "sha256:15584cf2b1bf449d98ff8a6ff1abef57bf20f3ac6454f431736cd3e660921b2f"}, - {file = "importlib_metadata-8.0.0.tar.gz", hash = "sha256:188bd24e4c346d3f0a933f275c2fec67050326a856b9a359881d7c2a697e8812"}, + {file = "importlib_metadata-8.2.0-py3-none-any.whl", hash = "sha256:11901fa0c2f97919b288679932bb64febaeacf289d18ac84dd68cb2e74213369"}, + {file = "importlib_metadata-8.2.0.tar.gz", hash = "sha256:72e8d4399996132204f9a16dcc751af254a48f8d1b20b9ff0f98d4a8f901e73d"}, ] [package.dependencies] diff --git a/pyproject.toml b/pyproject.toml index d9ae1e2..25eea0f 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -1,6 +1,6 @@ [tool.poetry] name = "pantos-service-node" -version = "1.8.1" +version = "1.8.2" description = "Pantos Service Node (reference implementation)" authors = ["Pantos GmbH "] license = "GPL-3.0-only"