Skip to content

Commit 3b5b947

Browse files
authored
Update README (#17)
* Update README * Update README
1 parent 2119122 commit 3b5b947

File tree

2 files changed

+26
-51
lines changed

2 files changed

+26
-51
lines changed

README.md

Lines changed: 23 additions & 48 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,14 @@
11
<p align="center">
2-
<a href="https://github.com/EnAccess/OpenPAYGO-Token">
2+
<a href="https://github.com/EnAccess/OpenPAYGO-python">
33
<img
44
src="https://enaccess.org/wp-content/uploads/2024/02/OpenPAYGO-Graphics-GitHub-2240-×-800.svg"
5-
alt="OpenPAYGO Token"
5+
alt="OpenPAYGO"
66
width="640"
77
>
88
</a>
99
</p>
1010
<p align="center">
11-
<em>The OpenPAYGO is an open source token system to enable PAYGO functionality in new products.</em>
11+
<em>OpenPAYGO is an Open Source ecosystem to enable pay-as-you-go functionality in new devices and products.</em>
1212
</p>
1313
<p align="center">
1414
<img
@@ -31,12 +31,31 @@
3131

3232
# OpenPAYGO - Python Lib
3333

34-
This repository contains the Python library for using implementing the different OpenPAYGOToken Suite technologies on your server (for generating tokens and decoding openpaygo metrics payloads) or device (for decoding tokens and making openpaygo metrics payloads).
34+
This repository contains the **Python** implementions of different OpenPAYGO technologies to run on your server or device.
35+
36+
Server-side tasks include
37+
38+
- generating OpenPAYGO tokens
39+
- decoding OpenPAYGO metrics payloads
40+
41+
Device side tasks
42+
43+
- decoding OpenPAYGO tokens
44+
- generating OpenPAYGO metrics payloads
45+
46+
## Documentation
47+
48+
OpenPAYGO documentation is hosted on [https://enaccess.github.io/OpenPAYGO-docs/](https://enaccess.github.io/OpenPAYGO-docs/).
3549

3650
## Credits
3751

3852
This open-source project was developped by Solaris Offgrid. Sponsorship for the original OpenPAYGO Token implementation was provided by EnAccess and sponsorphip for OpenPAYGO Metrics was provided by Solaris Offgrid.
3953

54+
## Support
55+
56+
- [OSEA Discord](https://discord.osea-community.org/) (`#openpaygo` channel)
57+
- [EnAccess](https://enaccess.org/)
58+
4059
## Table of Contents
4160

4261
- [Key Features](#key-features)
@@ -47,7 +66,6 @@ This open-source project was developped by Solaris Offgrid. Sponsorship for the
4766
- [Getting Started - OpenPAYGO Metrics](#getting-started---openpaygo-metrics)
4867
- [Generating a Request (Device Side)](#generating-a-request-device-side)
4968
- [Handling a Request and Generating a Response (Server Side)](#handling-a-request-and-generating-a-response-server-side)
50-
- [Changelog](#changelog)
5169

5270
## Key Features
5371

@@ -324,46 +342,3 @@ def device_data():
324342
# The handler handles the signature, etc.
325343
return metrics.get_answer_payload(), 200
326344
```
327-
328-
## Changelog
329-
330-
### 2023-10-13 - v0.5.4
331-
332-
- Safe handling of datetime before UNIX timestamp minimum when generating answer timestamp
333-
334-
### 2023-10-13 - v0.5.3
335-
336-
- Fix handling of `last_request_timestamp` when checking auth
337-
338-
### 2023-10-12 - v0.5.2
339-
340-
- Clarification in the doc of the behaviour when `secret_key` is missing
341-
- Implemented coherent behaviour when `secret_key` is missing
342-
343-
### 2023-10-12 - v0.5.1
344-
345-
- Fixes typo in function name
346-
347-
### 2023-10-12 - v0.5.0
348-
349-
- Added convenience functions for accessing the current request count and request timestamp
350-
- Improved documentation on how to avoid replay attacks
351-
352-
### 2023-10-12 - v0.4.0
353-
354-
- Added convenience functions for accessing token count and data timestamp
355-
- Added automatic verification of last request count or timestamp during auth
356-
- Fixed issues in documentation
357-
358-
### 2023-10-09 - v0.3.0
359-
360-
- Fix token generation issue
361-
- Add support for OpenPAYGO Metrics Request Generation
362-
- Add support for OpenPAYGO Metrics Request Decoding
363-
- Add support for OpenPAYGO Metrics Response Generation
364-
365-
### 2023-10-03 - v0.2.0
366-
367-
- First working version published on PyPI
368-
- Has support for OpenPAYGO Token
369-
- Has working CI for pushing to PyPI

setup.cfg

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,15 @@
11
[metadata]
22
name = openpaygo
33
version = 0.5.4
4-
description = OpenPAYGO library in Python
4+
description = OpenPAYGO Python library
55
long_description = file: README.md
66
long_description_content_type = text/markdown
77
url = https://github.com/EnAccess/OpenPAYGO-python/
88
license = MIT License
99
license_files = LICENSE
1010
project_urls =
11-
Homepage = https://github.com/EnAccess/OpenPAYGO-python/
12-
Documentation = https://github.com/EnAccess/OpenPAYGO-python/
11+
Homepage = https://enaccess.github.io/OpenPAYGO-docs/
12+
Documentation = https://enaccess.github.io/OpenPAYGO-docs/
1313
Changes = https://github.com/EnAccess/OpenPAYGO-python/releases
1414
Source = https://github.com/EnAccess/OpenPAYGO-python/
1515
Issues = https://github.com/EnAccess/OpenPAYGO-python/issues

0 commit comments

Comments
 (0)