keyshield/pyproject.toml at 80e88a19376ac5eeb264107bf9941f30ad51686c · Athroniaeth/keyshield · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
[project]
name = "fastapi-api-key"
version = "0.4.0"
description = "fastapi-api-key provides secure, production-ready API key management for FastAPI. It offers pluggable hashing strategies (Argon2, bcrypt, or custom), backend-agnostic persistence (SQLAlchemy, in-memory, or your own repository), and an optional cache layer (aiocache, Redis). Includes a Typer CLI and a FastAPI router for CRUD management of keys."
readme = "README.md"
authors = [
    { name = "Athroniaeth", email = "pierre.chaumont@hotmail.fr" }
]
keywords = [
    "api",
    "api key",
    "authentication",
    "authorization",
    "security",
    "backend-agnostic",
    "fastapi",
    "typer",
]

classifiers = [
    "Intended Audience :: Developers",
    "License :: OSI Approved :: MIT License",
    "Programming Language :: Python :: 3",
    "Programming Language :: Python :: 3.9",
    "Programming Language :: Python :: 3.10",
    "Programming Language :: Python :: 3.11",
    "Programming Language :: Python :: 3.12",
    "Programming Language :: Python :: 3.13",
    "Framework :: FastAPI",
    "Environment :: Web Environment",
    "Topic :: Security",
    "Topic :: Security :: Cryptography",
    "Topic :: Internet :: WWW/HTTP",
    "Typing :: Typed",
]
requires-python = ">=3.9"
dependencies = []

[project.urls]
Homepage = "https://github.com/Athroniaeth/fastapi-api-key"
Documentation = "https://github.com/Athroniaeth/fastapi-api-key#readme"
Issues = "https://github.com/Athroniaeth/fastapi-api-key/issues"
Changelog = "https://github.com/Athroniaeth/fastapi-api-key/blob/main/CHANGELOG.md"


[project.optional-dependencies]
bcrypt = [
    "bcrypt>=5.0.0",
]
argon2 = [
    "argon2-cffi>=25.1.0",
]
sqlalchemy = [
    "sqlalchemy>=2.0.43",
]
core = [
    "sqlalchemy>=2.0.43",
    "argon2-cffi>=25.1.0",
    "bcrypt>=5.0.0",
]
aiocache = [
    "aiocache>=0.12.3",
]
fastapi = [
    "fastapi>=0.118.0",
]
all = [
    "fastapi>=0.118.0",
    "sqlalchemy>=2.0.43",
    "argon2-cffi>=25.1.0",
    "bcrypt>=5.0.0",
    "aiocache>=0.12.3",
]
cli = [
    "typer>=0.12.5",
]

[build-system]
requires = ["hatchling"]
build-backend = "hatchling.build"

[project.scripts]
lint = "fastapi_api_key.__init__:lint"
test = "fastapi_api_key.__init__:test"

[dependency-groups]
dev = [
    "ty>=0.0.1a21",
    "ruff>=0.13.2",
    "bandit>=1.8.6",
    "pytest>=8.4.2",
    "pytest-cov>=7.0.0",
    "pytest-asyncio>=1.2.0",
    "pre-commit>=4.3.0",
    "commitizen>=4.9.1",
    "aiosqlite>=0.21.0",
    "uvicorn>=0.37.0",
    "typer>=0.12.5",
]

[tool.commitizen]
name = "cz_conventional_commits"
tag_format = "$version"
version_scheme = "pep440"
version_provider = "uv"
update_changelog_on_bump = true
major_version_zero = true
git_tag_version = true

[tool.pytest.ini_options]
# Automatically create html and xml coverage reports
addopts = [
    "--cov=src",
    "--cov-report=xml",
    "--doctest-modules",
    "--cov-report=html",
    "--cov-report=term-missing",
]

doctest_optionflags = [
    # Allow "..." in expected outputs
    "ELLIPSIS",
    # Ignore the multiple spaces
    "NORMALIZE_WHITESPACE",
    # Allow to test the type of exception
    "IGNORE_EXCEPTION_DETAIL",
]
testpaths = ["src", "tests"]


[tool.coverage.run]
omit = ["src/fastapi_api_key/__init__.py"]