Revamp doc

.github/workflows/python-publish.yml → .github/workflows/cd.yml

@@ -1,7 +1,4 @@
-# This workflows will upload a Python Package using Twine when a release is created
-# For more information see: https://help.github.com/en/actions/language-and-framework-guides/using-python-with-github-actions#publishing-to-package-registries
-
-name: Upload Python Package
+name: Publish
 
 on:
   release:
@@ -18,7 +15,7 @@ jobs:
 
       - uses: actions/setup-python@v5
         with:
-          python-version: "3.12"
+          python-version: "3.13"
           cache: "poetry"
 
       - name: Setup poetry

.github/workflows/python-tests.yml → .github/workflows/ci.yml

@@ -1,7 +1,4 @@
-# This workflow will install Python dependencies, run tests and lint with a variety of Python versions
-# For more information see: https://help.github.com/actions/language-and-framework-guides/using-python-with-github-actions
-
-name: Python package
+name: Build
 
 on:
   push:
@@ -41,3 +38,4 @@ jobs:
       - name: Test pydantic v1 compatibility
         working-directory: ./tests
         run: poetry run pip install 'pydantic<2' && poetry run pytest
+      - run: poetry build

CHANGELOG.md

@@ -1,5 +1,9 @@
 # Changelog
 
+## 1.10.3
+
+- Bump dependencies
+
 ## 1.10.2
 
 - Bump dependencies

README.md

@@ -21,7 +21,7 @@ pip install fastapi-login
 
 ## Usage
 
-To begin we have to setup our FastAPI app:
+To begin we have to set up our FastAPI app:
 
 ```python
 from fastapi import FastAPI
@@ -31,10 +31,9 @@ SECRET = 'your-secret-key'
 app = FastAPI()
 ```
 
-To obtain a suitable secret key you can run ``import os; print(os.urandom(24).hex())``.
+To obtain a suitable secret key you can run `import secrets; secrets.token_hex(24)`.
 
-Now we can import and setup the LoginManager, which will handle the process of
-encoding and decoding our Json Web Tokens.
+Now we can import and setup the `LoginManager`, which will handle the process of encoding and decoding our Json Web Tokens.
 
 ```python
 from fastapi_login import LoginManager
@@ -114,7 +113,7 @@ app.add_exception_handler(NotAuthenticatedException, exc_handler)
 ```
 
 To change the expiration date of the token use the ``expires_delta`` argument of the `create_access_token` method
-with a timedelta. The default is set 15 min. Please be aware that setting a long expiry date is not considered a good practice
+with `timedelta`. The default is set 15 min. Please be aware that setting a long expiry date is not considered a good practice
 as it would allow an attacker with the token to use your application as long as he wants.
 
 ```python
@@ -161,5 +160,4 @@ def auth(response: Response, user=Depends(manager)):
     )
     manager.set_cookie(response, token)
     return response
-
 ```

pyproject.toml

@@ -45,7 +45,7 @@ ruff = "^0.8.2"
 
 [tool.poetry.group.test.dependencies]
 async-asgi-testclient = "*"
-pytest = ">=7"
+pytest = ">=8"
 pytest-asyncio = "*"
 pytest-lazy-fixtures = "^1.1.1"