File tree Expand file tree Collapse file tree
Expand file tree Collapse file tree Original file line number Diff line number Diff line change @@ -23,5 +23,5 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
2323- MkDocs documentation site with quickstart, API reference, and best-practices guides
2424- CI/CD pipelines for testing (Python 3.10–3.14), coverage badge, and PyPI publishing
2525
26- [ Unreleased ] : https://github.com/MehrazRumman/fastapi-observer /compare/v0.1.0...HEAD
27- [ 0.1.0 ] : https://github.com/MehrazRumman/fastapi-observer /releases/tag/v0.1.0
26+ [ Unreleased ] : https://github.com/MehrazRumman/fastapi-inspector /compare/v0.1.0...HEAD
27+ [ 0.1.0 ] : https://github.com/MehrazRumman/fastapi-inspector /releases/tag/v0.1.0
Original file line number Diff line number Diff line change 1- # Contributing to fastapi-observer
1+ # Contributing to fastapi-inspector
22
33Thank you for your interest in contributing!
44
55## Getting Started
66
771 . Fork the repository and clone your fork:
88 ``` bash
9- git clone https://github.com/< your-username> /fastapi-observer .git
10- cd fastapi-observer
9+ git clone https://github.com/< your-username> /fastapi-inspector .git
10+ cd fastapi-inspector
1111 ```
1212
13132 . Install all development dependencies:
@@ -70,11 +70,11 @@ mkdocs build # build static site into /site
7070
7171## Reporting Bugs
7272
73- Open an issue at < https://github.com/MehrazRumman/fastapi-observer /issues > with:
73+ Open an issue at < https://github.com/MehrazRumman/fastapi-inspector /issues > with:
7474
7575- A minimal reproducible example
7676- Expected vs. actual behaviour
77- - Python version and fastapi-observer version
77+ - Python version and fastapi-inspector version
7878
7979## Security Issues
8080
Original file line number Diff line number Diff line change 1- # fastapi-observer
1+ # fastapi-inspector
22
33Structured logging and observability middleware for FastAPI applications.
44
5- [ ![ Test] ( https://github.com/MehrazRumman/fastapi-observer /actions/workflows/tests.yml/badge.svg )] ( https://github.com/MehrazRumman/fastapi-observer /actions/workflows/tests.yml )
6- [ ![ coverage] ( assets/coverage.svg )] ( https://github.com/MehrazRumman/fastapi-observer /actions/workflows/coverage-badge.yml )
7- [ ![ pypi package] ( https://img.shields.io/pypi/v/fastapi-observer ?logo=pypi&label=pypi%20package )] ( https://pypi.org/project/fastapi-observer / )
5+ [ ![ Test] ( https://github.com/MehrazRumman/fastapi-inspector /actions/workflows/tests.yml/badge.svg )] ( https://github.com/MehrazRumman/fastapi-inspector /actions/workflows/tests.yml )
6+ [ ![ coverage] ( assets/coverage.svg )] ( https://github.com/MehrazRumman/fastapi-inspector /actions/workflows/coverage-badge.yml )
7+ [ ![ pypi package] ( https://img.shields.io/pypi/v/fastapi-inspector ?logo=pypi&label=pypi%20package )] ( https://pypi.org/project/fastapi-inspector / )
88[ ![ python] ( https://img.shields.io/badge/python-3.10%20%7C%203.11%20%7C%203.12%20%7C%203.13%20%7C%203.14-brightgreen?logo=python&logoColor=white )] ( #python-compatibility )
99
10- ** [ Documentation] ( https://mehrazrumman.github.io/fastapi-observer / ) ** · [ Changelog] ( CHANGELOG.md ) · [ Contributing] ( CONTRIBUTING.md )
10+ ** [ Documentation] ( https://mehrazrumman.github.io/fastapi-inspector / ) ** · [ Changelog] ( CHANGELOG.md ) · [ Contributing] ( CONTRIBUTING.md )
1111
1212---
1313
@@ -26,7 +26,7 @@ Structured logging and observability middleware for FastAPI applications.
2626## Install
2727
2828``` bash
29- pip install fastapi-observer
29+ pip install fastapi-inspector
3030```
3131
3232---
Original file line number Diff line number Diff line change @@ -13,7 +13,7 @@ Please **do not** open a public GitHub issue for security vulnerabilities.
1313Instead, report them by emailing ** blackndmaroon@gmail.com ** with the subject line:
1414
1515```
16- [fastapi-observer ] Security vulnerability report
16+ [fastapi-inspector ] Security vulnerability report
1717```
1818
1919Include as much of the following as you can:
Original file line number Diff line number Diff line change @@ -18,7 +18,7 @@ FastAPI Observer provides structured logging building blocks for FastAPI project
1818## Quick start
1919
2020``` bash
21- pip install fastapi-observer
21+ pip install fastapi-inspector
2222```
2323
2424See [ Installation] ( installation.md ) for development, docs, and test commands.
Original file line number Diff line number Diff line change 33## Runtime install
44
55``` bash
6- pip install fastapi-observer
6+ pip install fastapi-inspector
77```
88
99## Development install
Original file line number Diff line number Diff line change 1- site_name : FastAPI Observer
1+ site_name : FastAPI Inspector
22site_description : Logging and observability helpers for FastAPI applications.
3- repo_name : fastapi-observer
3+ repo_name : fastapi-inspector
44
55theme :
66 name : material
Original file line number Diff line number Diff line change @@ -3,7 +3,7 @@ requires = ["setuptools>=69", "wheel"]
33build-backend = " setuptools.build_meta"
44
55[project ]
6- name = " fastapi-observer "
6+ name = " fastapi-inspector "
77version = " 0.1.0"
88description = " Logging and observability helpers for FastAPI applications."
99readme = " README.md"
You can’t perform that action at this time.
0 commit comments