mkdocs added

Author: MehrazRumman

.github/workflows/docs.yml

@@ -4,12 +4,16 @@ on:
   push:
     paths:
       - "docs/**"
+      - "mkdocs.yml"
       - "README.md"
+      - "pyproject.toml"
       - ".github/workflows/docs.yml"
   pull_request:
     paths:
       - "docs/**"
+      - "mkdocs.yml"
       - "README.md"
+      - "pyproject.toml"
       - ".github/workflows/docs.yml"
 
 jobs:
@@ -19,7 +23,17 @@ jobs:
       - name: Checkout
         uses: actions/checkout@v4
 
-      - name: Verify docs layout
+      - name: Set up Python
+        uses: actions/setup-python@v5
+        with:
+          python-version: "3.12"
+          cache: "pip"
+
+      - name: Install docs dependencies
+        run: |
+          python -m pip install --upgrade pip
+          python -m pip install -e ".[docs]"
+
+      - name: Build docs
         run: |
-          test -f README.md
-          test -d docs
+          mkdocs build --strict

.github/workflows/tests.yml

@@ -38,3 +38,11 @@ jobs:
 
       - name: Run tests via tox
         run: tox -e ${{ matrix.toxenv }}
+
+      - name: Upload coverage artifact
+        if: always()
+        uses: actions/upload-artifact@v4
+        with:
+          name: coverage-${{ matrix.python-version }}
+          path: coverage.xml
+          if-no-files-found: ignore

README.md

@@ -1,2 +1,75 @@
 # fastapi-observer
-FastApi Logs visualization
+
+FastAPI Observer provides structured logging and observability helpers for FastAPI applications.
+
+## Python compatibility
+
+- Supported Python versions: `3.10`, `3.11`, `3.12`, `3.13`, `3.14`
+- Enforced in CI with tox matrix: `py310`, `py311`, `py312`, `py313`, `py314`
+
+## Package versions
+
+### Runtime
+
+- `pydantic>=2.0,<3.0`
+
+### Testing
+
+- `pytest>=8.0`
+- `pytest-cov>=5.0`
+
+### Documentation
+
+- `mkdocs>=1.6`
+- `mkdocs-material>=9.5`
+
+### Development
+
+- `pre-commit>=3.7`
+- `black>=24.10`
+
+## Install
+
+```bash
+pip install fastapi-observer
+```
+
+For development:
+
+```bash
+pip install -e ".[test,docs,dev]"
+```
+
+## Tests and coverage
+
+Run tests:
+
+```bash
+pytest -q
+```
+
+Run tests with coverage:
+
+```bash
+pytest -q --cov=fastapi_observer --cov-report=term-missing --cov-report=xml
+```
+
+Run full Python version matrix locally:
+
+```bash
+tox
+```
+
+## Docs
+
+Build docs:
+
+```bash
+mkdocs build --strict
+```
+
+Serve docs locally:
+
+```bash
+mkdocs serve
+```

docs/index.md

@@ -0,0 +1,22 @@
+# FastAPI Observer
+
+FastAPI Observer provides structured logging building blocks for FastAPI projects.
+
+## Current scope
+
+- Typed and validated configuration via `ObserverConfig`
+- Structured event model via `LogEvent`
+- Logger factory with console/file handlers and JSON/text formatting
+
+## Compatibility
+
+- Python: `3.10` to `3.14`
+- Test matrix: `py310`, `py311`, `py312`, `py313`, `py314` via `tox` and GitHub Actions
+
+## Quick start
+
+```bash
+pip install fastapi-observer
+```
+
+See [Installation](installation.md) for development, docs, and test commands.

docs/installation.md

@@ -0,0 +1,32 @@
+# Installation
+
+## Runtime install
+
+```bash
+pip install fastapi-observer
+```
+
+## Development install
+
+```bash
+pip install -e ".[test,docs,dev]"
+```
+
+## Run tests locally
+
+```bash
+pytest -q --cov=fastapi_observer --cov-report=term-missing --cov-report=xml
+```
+
+## Run multi-version tests with tox
+
+```bash
+tox
+```
+
+## Build docs
+
+```bash
+mkdocs build --strict
+mkdocs serve
+```

mkdocs.yml

@@ -0,0 +1,16 @@
+site_name: FastAPI Observer
+site_description: Logging and observability helpers for FastAPI applications.
+repo_name: fastapi-observer
+
+theme:
+  name: material
+
+nav:
+  - Home: index.md
+  - Installation: installation.md
+
+markdown_extensions:
+  - admonition
+  - codehilite
+  - toc:
+      permalink: true

pyproject.toml

@@ -17,6 +17,11 @@ dependencies = [
 [project.optional-dependencies]
 test = [
   "pytest>=8.0",
+  "pytest-cov>=5.0",
+]
+docs = [
+  "mkdocs>=1.6",
+  "mkdocs-material>=9.5",
 ]
 dev = [
   "pre-commit>=3.7",
@@ -33,3 +38,11 @@ testpaths = ["tests"]
 [tool.black]
 line-length = 88
 target-version = ["py310"]
+
+[tool.coverage.run]
+source = ["fastapi_observer"]
+branch = true
+
+[tool.coverage.report]
+show_missing = true
+skip_covered = false

tox.ini

@@ -6,4 +6,4 @@ skip_missing_interpreters = true
 [testenv]
 description = Run test suite
 extras = test
-commands = pytest -q {posargs}
+commands = pytest -q --cov=fastapi_observer --cov-report=term-missing --cov-report=xml {posargs}