Update pre-commit configuration, enhance README, add CLI for config display, and update dependencies

Author: nim444

.pre-commit-config.yaml

@@ -1,13 +1,11 @@
-\
 # See https://pre-commit.com for more information
 # See https://pre-commit.com/hooks.html for more hooks
 repos:
--   repo: https://github.com/astral-sh/ruff-pre-commit
-    # Ruff version.
-    rev: v0.5.5
+-   repo: https://github.com/pre-commit/pre-commit-hooks
+    rev: v4.6.0 # Use a recent version
     hooks:
-        # Run the linter.
-        - id: ruff
-          args: [--fix]
-        # Run the formatter.
-        - id: ruff-format
+    -   id: trailing-whitespace
+    -   id: end-of-file-fixer
+    -   id: check-yaml
+    -   id: check-toml
+    -   id: check-added-large-files

README.md

@@ -1,12 +1,13 @@
 # FastAPI User Authentication API
 
-[![Python Version][python-shield]][python-url]
-[![FastAPI Version][fastapi-shield]][fastapi-url]
-[![Code style: ruff][ruff-shield]][ruff-url]
-[![Tests][tests-shield]][tests-url]
-[![Coverage][coverage-shield]][coverage-url]
+[![CI Pipeline](https://github.com/nim444/fastapi-auth-multi-db/actions/workflows/ci.yml/badge.svg)](https://github.com/nim444/fastapi-auth-multi-db/actions/workflows/ci.yml)
+[![Python 3.13](https://img.shields.io/badge/python-3.13-blue.svg)](https://www.python.org/downloads/)
+[![FastAPI >=0.115](https://img.shields.io/badge/fastapi->=0.115-green.svg)](https://fastapi.tiangolo.com/)
+[![Code style: ruff](https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/ruff/main/assets/badge/v2.json)](https://github.com/astral-sh/ruff)
+[![Tests passing](https://img.shields.io/badge/Tests-passing-brightgreen.svg)](#running-tests)
+[![Coverage: 100%](https://img.shields.io/badge/Coverage-100%25-brightgreen.svg)](https://codecov.io/gh/nim444/fastapi-auth-multi-db) <!-- Assuming Codecov is setup -->
 
-A robust FastAPI application demonstrating user registration, JWT authentication, and a flexible repository pattern supporting SQLite, PostgreSQL, and MongoDB backends.
+A robust FastAPI application demonstrating user registration, JWT authentication (including refresh tokens), and a flexible repository pattern supporting SQLite, PostgreSQL, and MongoDB backends.
 
 ## Purpose
 
@@ -21,12 +22,13 @@ This project serves as a template or starting point for building secure and scal
 
 * JWT-based authentication (login, refresh tokens).
 * User registration with password hashing (bcrypt) and validation.
-* Protected user profile endpoint.
+* Protected user profile endpoint (`/users/me`).
 * Flexible database layer using the Repository Pattern.
-* Configuration management with `Dynaconf` (`settings.toml`, `.secrets.toml`, environment variables).
+* Configuration management with `Dynaconf` (`settings.toml`, `.secrets.toml`, environment variables with `FAPI_` prefix).
 * Asynchronous support throughout (FastAPI, database drivers).
 * Automated API documentation (Swagger UI & ReDoc).
-* Comprehensive test suite with `pytest`.
+* Comprehensive test suite with `pytest` (including coverage).
+* Health check endpoint (`/health`).
 
 ## Technology Stack
 
@@ -35,8 +37,9 @@ This project serves as a template or starting point for building secure and scal
 * **Authentication:** python-jose (JWT), passlib, bcrypt
 * **Database ORM/Driver:**
   * SQLAlchemy (>=2.0.40) for SQL databases
-  * Motor (via `mongodb_repository.py`, requires separate install if used) for MongoDB
+  * Motor (>=3.5.0, via `mongodb_repository.py`, requires separate install if used) for MongoDB
   * Psycopg2 (requires separate install if using PostgreSQL)
+  * aiosqlite (>=0.20.0, requires separate install if using async SQLite `sqlite+aiosqlite`)
 * **Configuration:** Dynaconf (>=3.2.0)
 * **Testing:** pytest, pytest-asyncio, pytest-cov, httpx
 * **Dependency Management:** uv
@@ -94,10 +97,11 @@ This project serves as a template or starting point for building secure and scal
     # Install DB-specific drivers if needed (not included by default)
     # uv pip install psycopg2-binary  # For PostgreSQL
     # uv pip install motor           # For MongoDB
+    # uv pip install aiosqlite       # For async SQLite
     ```
 
 4. **Configure Settings:**
-    * Settings are managed by `Dynaconf`, loading from `config/settings.toml`, `config/.secrets.toml`, and environment variables.
+    * Settings are managed by `Dynaconf`, loading from `config/settings.toml`, `config/.secrets.toml`, and environment variables (prefixed with `FAPI_`, e.g., `FAPI_DATABASE_TYPE`, `FAPI_JWT_SECRET_KEY`).
     * **Create `config/.secrets.toml`** by copying `config/.secrets.toml.example`. Add your `JWT_SECRET_KEY` (must be strong and secret). **Do not commit `.secrets.toml`**.
 
         ```toml
@@ -116,18 +120,11 @@ This project serves as a template or starting point for building secure and scal
         * If using MongoDB, set `mongo_db_name`.
 
 5. **Initialize Database:**
-    * **SQL (SQLite/PostgreSQL):** This project uses Alembic for migrations.
+    * **SQL (SQLite/PostgreSQL):** This project includes `alembic` as a dependency for potential migrations.
         * Ensure your database exists.
-        * Run migrations: `alembic upgrade head`
-        * *(You might need to configure Alembic first if not already set up - check for an `alembic.ini` file and a `migrations/` directory)*
-    * **MongoDB:** Ensure unique indexes are created for the `users` collection (username, email). This can be done manually or added to the application startup logic.
-
-        ```javascript
-        // Example in MongoDB shell:
-        use your_db_name; // As defined in settings.toml (mongo_db_name)
-        db.users.createIndex({ "username": 1 }, { unique: true });
-        db.users.createIndex({ "email": 1 }, { unique: true });
-        ```
+        * If you have Alembic migrations set up (e.g., `alembic.ini` file and a `migrations/` directory), run: `alembic upgrade head`
+        * *(If Alembic is not fully configured, you may need to initialize it or manage schema changes manually)*
+    * **MongoDB:** Ensure your MongoDB server is running. The application will automatically attempt to create the required unique indexes for the `users` collection (on `username` and `email`) when it starts up, using the database name specified by `mongo_db_name` in your settings.
 
 ## Running the Application
 
@@ -162,6 +159,15 @@ PYTHONPATH=. pytest --cov=app --cov-report=term-missing --cov-report=html
 
 Coverage report will be in the `htmlcov/` directory.
 
+## Running GitHub Actions Locally (Optional)
+
+If you have `act` installed, you can simulate GitHub Actions workflows locally. This is particularly useful for testing CI/CD pipelines before pushing changes.
+
+```bash
+# Run workflows, specifying architecture if needed (e.g., for M1/M2 Macs)
+act --container-architecture linux/amd64
+```
+
 ## API Documentation
 
 Once the server is running, access the interactive API documentation:
@@ -180,15 +186,3 @@ Once the server is running, access the interactive API documentation:
 4. If switching to SQL, ensure the database exists and migrations are applied (`alembic upgrade head`).
 5. If switching to MongoDB, ensure indexes exist.
 6. Restart the application: `uvicorn main:app --reload ...`
-
-<!-- Badges Definitions (Update URLs as needed) -->
-[python-shield]: https://img.shields.io/badge/Python->=3.13-blue.svg
-[python-url]: https://www.python.org/downloads/
-[fastapi-shield]: https://img.shields.io/badge/FastAPI->=0.115-green.svg
-[fastapi-url]: https://fastapi.tiangolo.com/
-[ruff-shield]: https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/ruff/main/assets/badge/v2.json
-[ruff-url]: https://github.com/astral-sh/ruff
-[tests-shield]: https://img.shields.io/badge/Tests-passing-brightgreen.svg
-[tests-url]: #running-tests <!-- Link to test section -->
-[coverage-shield]: https://img.shields.io/badge/Coverage-100%25-brightgreen.svg
-[coverage-url]: #running-tests <!-- Link to test section -->

app/cli.py

@@ -0,0 +1,29 @@
+# filepath: /Users/nk/Projects/_/fapi/app/cli.py
+import typer
+
+from app.core.config import settings
+
+app = typer.Typer()
+
+
+@app.command()
+def show_config():
+    """Display the current configuration settings."""
+    print("Current Configuration:")
+    print(f"  Database Type: {settings.database_type}")
+    print(f"  SQL Database URL: {settings.get('sql_database_url', 'Not Set')}")
+    print(f"  Mongo Database URL: {settings.get('mongo_database_url', 'Not Set')}")
+    print(f"  Mongo DB Name: {settings.get('mongo_db_name', 'Not Set')}")
+    print(f"  JWT Secret Key: {'Set' if settings.get('jwt_secret_key') else 'Not Set'}")
+
+
+# Add more commands here as needed
+# Example:
+# @app.command()
+# def create_user(username: str, email: str, password: str):
+#     """Create a new user (requires async handling or separate logic)."""
+#     print(f"Creating user {username} (implementation needed)")
+
+
+if __name__ == "__main__":
+    app()

config/settings.toml

@@ -10,7 +10,7 @@ database_type = "mongodb" # Options: sqlite, postgres, mongodb
 # --- SQL Databases (SQLite, PostgreSQL) ---
 sql_database_url = "sqlite:///./test.db" # Keep a default even if unused
 
-# --- MongoDB --- 
+# --- MongoDB ---
 # Add MONGO_DATABASE_URL to .secrets.toml if it contains credentials
 # Example: MONGO_DATABASE_URL = "mongodb://user:password@localhost:27017/"
 # If no auth: MONGO_DATABASE_URL = "mongodb://localhost:27017/"
@@ -33,4 +33,4 @@ reload = false
 # Example for MongoDB in production:
 # database_type = "mongodb"
 # mongo_database_url = "mongodb://prod_user:prod_password@prod_host:27017/"
-# mongo_db_name = "prod_fastapi_db"
+# mongo_db_name = "prod_fastapi_db"

pyproject.toml

@@ -15,6 +15,7 @@ dependencies = [
     "python-multipart>=0.0.6",
     "dynaconf>=3.2.0",
     "httpx>=0.28.1",
+    "typer[all]>=0.12.5", # Add typer
 ]
 
 [project.optional-dependencies]
@@ -58,3 +59,6 @@ line-ending = "auto"
 where = ["."]
 include = ["app*"]
 exclude = ["tests*"]
+
+[project.scripts]
+fapi-cli = "app.cli:app" # Add script entry point

tests/conftest.py

@@ -32,7 +32,7 @@ def db_session(test_engine):
 
 
 @pytest.fixture(autouse=True)
-def override_get_repository(db_session):
+def _override_get_repository(db_session):
     def _get_repo_override():
         return SQLAlchemyRepository(db_session)