Skip to content

Commit

Permalink
docs/rewording readme (#68)
Browse files Browse the repository at this point in the history
* docs: rewording readme

* fix: update poetry lock

* fix: update changelog for debian package
  • Loading branch information
juanmanuel-tirado authored Aug 1, 2024
1 parent b00531a commit 0785926
Show file tree
Hide file tree
Showing 4 changed files with 21 additions and 21 deletions.
20 changes: 7 additions & 13 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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/).
Expand All @@ -128,14 +117,19 @@ 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

Create the virtual environment and install the dependencies:

```bash
$ poetry install --no-root
poetry install --no-root
```

#### Pre-commit
Expand Down
8 changes: 7 additions & 1 deletion debian/changelog
Original file line number Diff line number Diff line change
@@ -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 <[email protected]> Thu, 24 Jun 2024 14:00:15 +0000

pantos-service-node (1.8.1) RELEASED; urgency=medium

* pantos-service-node: Initial debian packaging

Expand Down
12 changes: 6 additions & 6 deletions poetry.lock

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion pyproject.toml
Original file line number Diff line number Diff line change
@@ -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 <[email protected]>"]
license = "GPL-3.0-only"
Expand Down

0 comments on commit 0785926

Please sign in to comment.