Metadata-Version: 2.5
Name: srptools
Version: 2.0.0
Summary: Tools to implement Secure Remote Password (SRP) authentication
Project-URL: Homepage, https://github.com/idlesign/srptools
Project-URL: Documentation, https://srptools.readthedocs.io/
Author-email: Igor Starikov <idlesign@yandex.ru>
License-Expression: BSD-3-Clause
License-File: LICENSE
Keywords: SRP,authentication,security
Requires-Python: >=3.10
Provides-Extra: cli
Requires-Dist: click>=4.0; extra == 'cli'
Description-Content-Type: text/markdown

# srptools

https://github.com/idlesign/srptools

[![PyPI - Version](https://img.shields.io/pypi/v/srptools)](https://pypi.python.org/pypi/srptools)
[![License](https://img.shields.io/pypi/l/srptools)](https://pypi.python.org/pypi/srptools)
[![Coverage](https://img.shields.io/coverallsCoverage/github/idlesign/srptools)](https://coveralls.io/r/idlesign/srptools)
[![Docs](https://img.shields.io/readthedocs/srptools)](https://srptools.readthedocs.io/)

## Description

*Tools to implement Secure Remote Password (SRP) authentication*

SRP is a secure password-based authentication and key-exchange protocol —
a password-authenticated key agreement protocol (PAKE).

!!! note 
    This package contains protocol implementation for Python 3.
    The last version with Python 2 support is `1.0.1`.

You may import it into your applications and use its API or you may use
`srptools` command-line utility (CLI).

## Documentation

More information can be found at https://srptools.readthedocs.io/


## Development

### Quickstart

Use [makeapp](https://pypi.org/project/makeapp/) to streamline the development:

```shell
$ uv tool install makeapp
# or
$ uv tool upgrade makeapp
```

Clone the source code from the repository and switch into its directory:

```shell
# bootstrap the utilities
$ ma tools
# initialize the environment
$ ma up
```

Check code style and run tests before your pull request:

```shell
$ ma style
$ ma tests
```
