Metadata-Version: 2.1
Name: quetz-sql-authenticator
Version: 0.0.5
Summary: Manage simple credentials for your Quetz server
Home-page: https://github.com/mamba-org/quetz-sql-authenticator
Author: QuantStack & Quetz contributors
Author-email: wolf.vollprecht@quantstack.net
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Requires-Python: >=3.8
Description-Content-Type: text/markdown
License-File: LICENSE

## SQL Authenticator

An authenticator that stores credentials in the Quetz SQL database using passlib. It ships with REST routes for CRUD operations on the credentials table.

### Installation

Locally after cloning:

```
pip install -e .
```

Once uploaded to conda-forge:

```
mamba install -c conda-forge quetz-sql-authenticator
```

### Usage

The authenticator should be active now. You can login by navigating to `<HOST>/auth/sql/login`.

### CRUD operations

The authenticator provides REST routes to create, update, and delete credentials and to reset the entire table.

`GET /api/sqlauth/credentials/`: List all users.

`GET /api/sqlauth/credentials/{username}`: Verify that a user exists.

`POST /api/sqlauth/credentials/{username}?password={password}`: Create a new user.

`PUT /api/sqlauth/credentials/{username}?password={password}`: Update a user's password.

`DELETE /api/sqlauth/credentials/{username}`: Delete a user.
