Skip to content

Commit 0a15efa

Browse files
Athroniaethclaude
andcommitted
docs: rename project from fastapi-api-key to keyshield and add missing framework connectors
Update README, docs/index.md and mkdocs.yml to reflect the GitHub rename from fastapi-api-key to keyshield, and expose Litestar, Quart and Django connector pages in the MkDocs navigation. Co-Authored-By: Claude Sonnet 4.6 (1M context) <noreply@anthropic.com>
1 parent f4d425d commit 0a15efa

File tree

3 files changed

+9
-6
lines changed

3 files changed

+9
-6
lines changed

README.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# FastAPI Api Key
1+
# Keyshield
22

33
![Python Version from PEP 621 TOML](https://img.shields.io/python/required-version-toml?tomlFilePath=https%3A%2F%2Fraw.githubusercontent.com%2FAthroniaeth%2Fkeyshield%2Fmain%2Fpyproject.toml)
44
[![Tested with pytest](https://img.shields.io/badge/tests-pytest-informational.svg)](https://pytest.org/)
@@ -9,7 +9,7 @@
99
[![Deps: uv](https://img.shields.io/badge/deps-managed%20with%20uv-3E4DD8.svg)](https://docs.astral.sh/uv/)
1010
[![Code style: Ruff](https://img.shields.io/badge/code%20style-ruff-4B32C3.svg)](https://docs.astral.sh/ruff/)
1111

12-
`keyshield` provides a backend-agnostic library that provides a production-ready, secure API key system, with optional FastAPI and Typer connectors.
12+
`keyshield` provides a backend-agnostic library that provides a production-ready, secure API key system, with optional connectors for FastAPI, Litestar, Quart, Django, and Typer CLI.
1313

1414
## Links
1515

@@ -22,7 +22,7 @@
2222
- **Prod-ready**: services and repositories are async, and battle-tested
2323
- **Agnostic hasher**: choose between Argon2 (default) or Bcrypt hashing strategies (with caching support)
2424
- **Agnostic backend**: abstract repository pattern, currently with SQLAlchemy implementation
25-
- **Connectors**: FastAPI router and Typer CLI for API key management
25+
- **Connectors**: FastAPI, Litestar, Quart, and Django routers, plus Typer CLI for API key management
2626
- **Envvar support**: easily configure peppers and other secrets via environment variables
2727
- **Scopes support**: assign scopes to API keys for fine-grained access control
2828

docs/index.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# FastAPI Api Key
1+
# Keyshield
22

33
![Python Version from PEP 621 TOML](https://img.shields.io/python/required-version-toml?tomlFilePath=https%3A%2F%2Fraw.githubusercontent.com%2FAthroniaeth%2Fkeyshield%2Fmain%2Fpyproject.toml)
44
[![Tested with pytest](https://img.shields.io/badge/tests-pytest-informational.svg)](https://pytest.org/)
@@ -9,7 +9,7 @@
99
[![Deps: uv](https://img.shields.io/badge/deps-managed%20with%20uv-3E4DD8.svg)](https://docs.astral.sh/uv/)
1010
[![Code style: Ruff](https://img.shields.io/badge/code%20style-ruff-4B32C3.svg)](https://docs.astral.sh/ruff/)
1111

12-
`keyshield` provides a backend-agnostic library that provides a production-ready, secure API key system, with optional FastAPI and Typer connectors.
12+
`keyshield` provides a backend-agnostic library that provides a production-ready, secure API key system, with optional connectors for FastAPI, Litestar, Quart, Django, and Typer CLI.
1313

1414
## Links
1515

@@ -22,7 +22,7 @@
2222
- **Prod-ready**: services and repositories are async, and battle-tested
2323
- **Agnostic hasher**: choose between Argon2 (default) or Bcrypt hashing strategies (with caching support)
2424
- **Agnostic backend**: abstract repository pattern, currently with SQLAlchemy implementation
25-
- **Connectors**: FastAPI router and Typer CLI for API key management
25+
- **Connectors**: FastAPI, Litestar, Quart, and Django routers, plus Typer CLI for API key management
2626
- **Envvar support**: easily configure peppers and other secrets via environment variables
2727
- **Scopes support**: assign scopes to API keys for fine-grained access control
2828

mkdocs.yml

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -72,6 +72,9 @@ nav:
7272
- Database: usage/database.md
7373
- Cache: usage/cache.md
7474
- FastAPI: usage/fastapi.md
75+
- Litestar: usage/litestar.md
76+
- Quart: usage/quart.md
77+
- Django: usage/django.md
7578
- Scopes: usage/scopes.md
7679
- Typer: usage/typer.md
7780
extra:

0 commit comments

Comments
 (0)