Skip to content

Commit 6a37055

Browse files
committed
2 parents d575c0b + 5c3be07 commit 6a37055

File tree

3 files changed

+14
-16
lines changed

3 files changed

+14
-16
lines changed

.github/workflows/pages.yml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,9 @@
1+
# .github/workflows/pages.yml
12
name: Deploy MkDocs to GitHub Pages
23

34
on:
45
push:
5-
branches: [ main ] # ana branch'in adı farklıysa düzelt
6+
branches: [ main ]
67
workflow_dispatch:
78

89
permissions:
@@ -30,7 +31,6 @@ jobs:
3031
run: |
3132
python -m pip install --upgrade pip
3233
pip install mkdocs-material mkdocs-macros-plugin mkdocs-awesome-pages-plugin
33-
# projenin docs için gereken ekstra paketleri varsa buraya ekle
3434
3535
- name: Build site
3636
run: mkdocs build --clean

README.md

Lines changed: 6 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -4,10 +4,11 @@
44
<p align="center"><b><i>Standardising FastAPI responses with clarity, consistency, and control.</i></b></p>
55

66
# APIException: Standardised Exception Handling for FastAPI
7-
[![PyPI version](https://img.shields.io/pypi/v/APIException?cacheSeconds=60)](https://pypi.org/project/APIException/)
7+
8+
[![PyPI version](https://img.shields.io/pypi/v/apiexception?cacheSeconds=300)](https://pypi.org/project/apiexception/)
89
[![Documentation](https://img.shields.io/badge/docs-latest-brightgreen.svg)](https://akutayural.github.io/APIException/)
9-
[![Downloads](https://pepy.tech/badge/APIException)](https://pepy.tech/project/APIException)
10-
[![Python Versions](https://img.shields.io/pypi/pyversions/APIException.svg)](https://pypi.org/project/APIException/)
10+
[![Downloads](https://pepy.tech/badge/apiexception)](https://pepy.tech/project/apiexception)
11+
[![Python Versions](https://img.shields.io/pypi/pyversions/apiexception.svg)](https://pypi.org/project/apiexception/)
1112
[![License](https://img.shields.io/badge/license-MIT-blue.svg)](https://opensource.org/licenses/MIT)
1213
[![Code style: black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/psf/black)
1314

@@ -253,7 +254,7 @@ Always extend BaseExceptionCode — don’t subclass ExceptionCode directly!
253254
from api_exception import BaseExceptionCode
254255

255256
class CustomExceptionCode(BaseExceptionCode):
256-
USER_NOT_FOUND = ("USR-404", "User not found.", "User does not exist.")
257+
USER_NOT_FOUND = ("-404", "User not found.", "User does not exist.")
257258
INVALID_API_KEY = ("API-401", "Invalid API key.", "Key missing or invalid.")
258259
```
259260

@@ -319,8 +320,6 @@ logger.setLevel("DEBUG") # Set logging level
319320

320321
---
321322

322-
323-
324323
## Examples
325324

326325
### All in One Example Application
@@ -341,8 +340,6 @@ This example serves as a **one-stop reference** to see how `api_exception` can b
341340
[**Click to see the example**](https://github.com/akutayural/APIException/blob/main/examples/production_level.py)
342341

343342

344-
345-
346343
---
347344
## ✅ Testing Example
348345

@@ -409,6 +406,7 @@ This can be used as a foundation. Can be extended to include more detailed tests
409406
Benchmark scripts and raw Locust reports are available in the [benchmark](https://github.com/akutayural/APIException/tree/main/benchmark) directory.
410407

411408

409+
---
412410

413411
## 📜 Changelog
414412

pyproject.toml

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
[project]
22
name = "apiexception"
3-
version = "0.1.16"
3+
version = "0.1.17.post1"
44
description = "Consistent JSON response formatting and error handling for FastAPI applications"
55
authors = [{ name = "Ahmet Kutay URAL", email = "[email protected]" }]
66
requires-python = ">=3.10"
@@ -34,6 +34,11 @@ dependencies = [
3434
"click>=8.0.0",
3535
]
3636

37+
[project.urls]
38+
Documentation = "https://akutayural.github.io/APIException/"
39+
Source = "https://github.com/akutayural/APIException"
40+
PyPI = "https://pypi.org/project/apiexception/"
41+
3742
[project.optional-dependencies]
3843
dev = [
3944
"mkdocs-awesome-pages-plugin>=2.10.1",
@@ -43,11 +48,6 @@ dev = [
4348
"setuptools>=80.9.0",
4449
]
4550

46-
[project.urls]
47-
Documentation = "https://akutayural.github.io/APIException/"
48-
Source = "https://github.com/akutayural/APIException"
49-
PyPI = "https://pypi.org/project/APIException/"
50-
5151
[project.scripts]
5252
APIException-info = "api_exception.__main__:main"
5353

0 commit comments

Comments
 (0)