Skip to content

Commit 37265f6

Browse files
committed
Release v0.0.1
Add release_notes.rst
1 parent 1adfce7 commit 37265f6

File tree

3 files changed

+33
-3
lines changed

3 files changed

+33
-3
lines changed

README.md

Lines changed: 18 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -10,8 +10,12 @@ Python module to add username and password authentication to specific FastAPI ro
1010

1111
## Installation
1212

13-
```bash
14-
pip install https://github.com/thevickypedia/FastAPIAuthenticator.git
13+
```shell
14+
repo="thevickypedia/FastAPIAuthenticator"
15+
16+
latest=$(curl -s https://api.github.com/repos/${repo}/tags | jq -r '.[0].name')
17+
18+
pip install "git+https://github.com/${repo}.git@${latest}"
1519
```
1620

1721
## Usage
@@ -40,6 +44,17 @@ fastapiauthenticator.Authenticator(app=app, secure_function=private_route)
4044
Docstring format: [`Google`][google-docs] <br>
4145
Styling conventions: [`PEP 8`][pep8] and [`isort`][isort]
4246

47+
## [Release Notes][release-notes]
48+
**Requirement**
49+
```shell
50+
python -m pip install gitverse
51+
```
52+
53+
**Usage**
54+
```shell
55+
gitverse-release reverse -f release_notes.rst -t 'Release Notes'
56+
```
57+
4358
## Linting
4459

4560
**Requirement**
@@ -68,3 +83,4 @@ Licensed under the [MIT License][license]
6883

6984
[label-pyversion]: https://img.shields.io/badge/python-3.11%20%7C%203.12-blue
7085
[label-platform]: https://img.shields.io/badge/Platform-Linux|macOS|Windows-1f425f.svg
86+
[release-notes]: https://github.com/thevickypedia/FastAPIAuthenticator/blob/main/release_notes.rst

fastapiauthenticator/version.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1 @@
1-
version = "0.0.0-a"
1+
version = "0.0.1"

release_notes.rst

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
Release Notes
2+
=============
3+
4+
v0.0.1 (06/22/2025)
5+
-------------------
6+
- Create a base python module to enable `username`/`password` authentication for any specific route
7+
- Transmits `username` and `password` securely by encrypting `credentials` → `hex` → `hash + timestamp`
8+
- Includes basic UI templates for login
9+
- **Full Changelog**: https://github.com/thevickypedia/FastAPIAuthenticator/compare/v0.0.0-a...v0.0.1
10+
11+
v0.0.0-a (06/21/2025)
12+
---------------------
13+
- Release alpha version
14+
- **Full Changelog**: https://github.com/thevickypedia/FastAPIAuthenticator/commits/v0.0.0-a

0 commit comments

Comments
 (0)