Skip to content
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
25 changes: 19 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -72,7 +72,7 @@ The **OpenPAYGO Python library** supports the following features:
## Table of Contents

- [Key Features](#key-features)
- [Installing the library](#installing-the-library)
- [Installing the library](#installing-the-openpaygo-python-library)
- [Getting Started - OpenPAYGO Token](#getting-started---openpaygo-token)
- [Generating Tokens (Server Side)](#generating-tokens-server-side)
- [Decoding Tokens (Device Side)](#decoding-tokens-device-side)
Expand All @@ -85,18 +85,31 @@ The **OpenPAYGO Python library** supports the following features:
- Implements token generation and decoding with full support for the v2.3 of the [OpenPAYGO Token](https://github.com/EnAccess/OpenPAYGO-Token) specifications.
- Implements payload authentication (verification + signing) and conversion from simple to condensed payload (and back) with full support of the v1.0-rc1 of the [OpenPAYGO Metrics](https://github.com/openpaygo/metrics) specifications.

## Installing the library
## Installing the OpenPAYGO Python library

### Released version from PyPI

You can install `OpenPAYGO-python` from [PyPI](https://pypi.org/project/openpaygo/).
For example by running `pip install openpaygo` or adding `openpaygo` as a dependency (`uv add openpaygo`).
The easiest and recommended way to install the OpenPAYGO Python library is via [PyPI](https://pypi.org/project/openpaygo/).

You can install it directly using a package manager, for example:

- By adding openpaygo to your project dependencies, via:

```sh
uv add openpaygo
```

- Or via `pip`

```sh
pip install openpaygo
```

### Development setup

- Install [`uv`](https://docs.astral.sh/uv/)
- Run `uv install`
- Run `uv tests`
- Run `uv sync`
- Run `uv run pytest`

## Getting Started - OpenPAYGO Token

Expand Down