@@ -3,37 +3,21 @@ Platform-Agnostic Security Tokens for Python
33
44[ ![ Build Status] ( https://travis-ci.com/purificant/python-paseto.svg?branch=main )] ( https://travis-ci.com/purificant/python-paseto )
55[ ![ test-workflow] ( https://github.com/purificant/python-paseto/actions/workflows/test.yaml/badge.svg )] ( https://github.com/purificant/python-paseto/actions/workflows/test.yaml )
6+ [ ![ PyPI version] ( https://badge.fury.io/py/python-paseto.svg )] ( https://badge.fury.io/py/python-paseto )
67[ ![ Coverage Status] ( https://coveralls.io/repos/github/purificant/python-paseto/badge.svg?branch=main )] ( https://coveralls.io/github/purificant/python-paseto?branch=main )
78[ ![ Language grade: Python] ( https://img.shields.io/lgtm/grade/python/g/purificant/python-paseto.svg?logo=lgtm&logoWidth=18 )] ( https://lgtm.com/projects/g/purificant/python-paseto/context:python )
89[ ![ Code style: black] ( https://img.shields.io/badge/code%20style-black-000000.svg )] ( https://github.com/ambv/black )
9- [ ![ PyPI version] ( https://badge.fury.io/py/python-paseto.svg )] ( https://badge.fury.io/py/python-paseto )
1010
1111
1212# Installation
13- Clone the repository, in the future a pip install will be available.
14-
15- [ poetry] ( https://github.com/sdispater/poetry#installation ) is used to manage project
16- dependencies / build / test / publish.
17-
18- Install dependencies with
19- ``` bash
20- poetry install
21- ```
2213
23- Run tests
2414``` bash
25- pytest
26- ```
27-
28- To check code coverage run
29- ``` bash
30- coverage run -m pytest
31- coverage report
15+ pip install python-paseto
3216```
3317
3418# Low level API
35- Initial implementation of the V2 encrypt / decrypt functions. Alpha version .
36- Low level API focuses on solid, high quality, production ready primitives
19+ Implements PASETO V2 encrypt / decrypt functions.
20+ Low level API is focuses on solid, high quality, production ready primitives
3721as specified directly in the [ PASETO] ( https://tools.ietf.org/html/draft-paragon-paseto-rfc-00 )
3822protocol.
3923
@@ -73,7 +57,10 @@ print(f"message={message}")
7357In the future a high level API will provide developer friendly access to low level API
7458and support easy integration into other projects.
7559
76- Code formatting is managed by [ black] ( https://github.com/ambv/black ) . To format run
77- ``` bash
78- black .
79- ```
60+ # Development
61+ Typical dev workflow operations are automated in [ Makefile] ( Makefile ) ,
62+ including testing, linting, code quality checks, benchmarks and dev environment setup.
63+
64+ # Contributing
65+ This library is under active development and maintenance. For any feedback, questions,
66+ comments or if you would like to request a feature, please raise an issue!
0 commit comments