Skip to content

Commit be8886a

Browse files
authored
Merge pull request #14 from Athroniaeth/development
Development
2 parents bd7415d + 936a6e3 commit be8886a

35 files changed

+2758
-3218
lines changed

README.md

Lines changed: 3 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -22,15 +22,10 @@ keys.
2222

2323
- **Security-first**: secrets are hashed with a salt and a pepper, and never logged or returned after creation
2424
- **Prod-ready**: services and repositories are async, and battle-tested
25-
26-
27-
- **Agnostic hasher**: you can use any async-compatible hashing strategy (default: Argon2)
28-
- **Agnostic backend**: you can use any async-compatible database (default: SQLAlchemy)
29-
- **Connector**: create a Typer, FastAPI router wired to api key systems
30-
31-
25+
- **Agnostic hasher**: choose between Argon2 (default) or Bcrypt hashing strategies
26+
- **Agnostic backend**: abstract repository pattern, currently with SQLAlchemy implementation
27+
- **Connectors**: FastAPI router and Typer CLI for API key management
3228
- **Envvar support**: easily configure peppers and other secrets via environment variables
33-
- **Extensible**: customize models, repositories, hashers, and services to fit your needs
3429
- **Scopes support**: assign scopes to API keys for fine-grained access control
3530

3631
## Standards compliance

docs/index.md

Lines changed: 4 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -22,14 +22,10 @@ keys.
2222

2323
- **Security-first**: secrets are hashed with a salt and a pepper, and never logged or returned after creation
2424
- **Prod-ready**: services and repositories are async, and battle-tested
25-
26-
- **Agnostic hasher**: you can use any async-compatible hashing strategy (default: Argon2)
27-
- **Agnostic backend**: you can use any async-compatible database (default: SQLAlchemy)
28-
- **Connector**: create a Typer, FastAPI router wired to api key systems
29-
30-
25+
- **Agnostic hasher**: choose between Argon2 (default) or Bcrypt hashing strategies
26+
- **Agnostic backend**: abstract repository pattern, currently with SQLAlchemy implementation
27+
- **Connectors**: FastAPI router and Typer CLI for API key management
3128
- **Envvar support**: easily configure peppers and other secrets via environment variables
32-
- **Extensible**: customize models, repositories, hashers, and services to fit your needs
3329
- **Scopes support**: assign scopes to API keys for fine-grained access control
3430

3531
## Standards compliance
@@ -80,4 +76,4 @@ Here is a diagram showing what happens after you initialize your API key service
8076
## What to read next
8177

8278
1. Head to the [Quickstart](quickstart.md) to wire the service in a REPL or script.
83-
2. Browse the [Usage](usage/custom/) section to reuse the example applications that ship with the project.
79+
2. Browse the [Usage](usage/fastapi.md) section to see example applications that ship with the project.

docs/usage/custom.md

Lines changed: 0 additions & 39 deletions
This file was deleted.

docs/usage/dotenv.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ fak generate
88
```
99

1010
```bash
11-
Set in your .env : "API_KEY_DEV: ak-e71947d5509e48e9-Dryc0fsQRaTv9Gl7mTScMFARDE6FgwZPUnm38MlX1OSJZCYCkKi4jsoTXxEtGGNC"
11+
Set in your .env : "API_KEY_DEV=ak-dcde9fa8eec44aa2-n8JK2HPXoosH6UXPL5h2YeO3OdW55WESb97CKc7mbVUzFpWFQYLuDD7Xs8fbco5d"
1212
```
1313

1414
## Example

examples/example_fastapi_custom.py

Lines changed: 0 additions & 184 deletions
This file was deleted.

0 commit comments

Comments
 (0)