# Cadmium-FastAPI SDK
This SDK captures and sends errors from your FastAPI application to the Cadmium server.
## Installation
```bash
pip install cadmium-fastapi-sdk
```
## Configuration
Add the following to your FastAPI application:
```python
from fastapi import FastAPI
from cadmium_fastapi import CadmiumMiddleware
app = FastAPI()
# Add Cadmium middleware
app.add_middleware(
CadmiumMiddleware,
application_id="your-application-id",
cd_secret="your-secret",
cd_id="your-cd-id"
)
```
## Environment Variables (Alternative Configuration)
You can also configure using environment variables:
```bash
export CADMIUM_APPLICATION_ID="your-application-id"
export CADMIUM_CD_SECRET="your-secret"
export CADMIUM_CD_ID="your-cd-id"
```
Then simply add the middleware without parameters:
```python
from cadmium_fastapi import CadmiumMiddleware
app.add_middleware(CadmiumMiddleware)
```
## Usage
Once configured, any unhandled exception will automatically be sent to the Cadmium server.
## Manual Error Reporting
You can also manually report errors:
```python
from cadmium_fastapi import report_error
try:
# Your code here
pass
except Exception as e:
await report_error(e, request)
```
Raw data
{
"_id": null,
"home_page": "https://github.com/softwares-compound/cadmium-fastapi-sdk",
"name": "cadmium-fastapi-sdk",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.8",
"maintainer_email": null,
"keywords": "fastapi, error-tracking, monitoring, cadmium",
"author": "bannawandoor",
"author_email": "bannawandoor <connect@hasanulbanna.in>",
"download_url": "https://files.pythonhosted.org/packages/d9/6f/d2a275279e58985e1c4ec886b64cd1f7f289795743af2f5e890370cf4d93/cadmium_fastapi_sdk-1.0.0.tar.gz",
"platform": null,
"description": "# Cadmium-FastAPI SDK\n\nThis SDK captures and sends errors from your FastAPI application to the Cadmium server.\n\n## Installation\n\n```bash\npip install cadmium-fastapi-sdk\n```\n\n## Configuration\n\nAdd the following to your FastAPI application:\n\n```python\nfrom fastapi import FastAPI\nfrom cadmium_fastapi import CadmiumMiddleware\n\napp = FastAPI()\n\n# Add Cadmium middleware\napp.add_middleware(\n CadmiumMiddleware,\n application_id=\"your-application-id\",\n cd_secret=\"your-secret\",\n cd_id=\"your-cd-id\"\n)\n```\n\n## Environment Variables (Alternative Configuration)\n\nYou can also configure using environment variables:\n\n```bash\nexport CADMIUM_APPLICATION_ID=\"your-application-id\"\nexport CADMIUM_CD_SECRET=\"your-secret\"\nexport CADMIUM_CD_ID=\"your-cd-id\"\n```\n\nThen simply add the middleware without parameters:\n\n```python\nfrom cadmium_fastapi import CadmiumMiddleware\n\napp.add_middleware(CadmiumMiddleware)\n```\n\n## Usage\n\nOnce configured, any unhandled exception will automatically be sent to the Cadmium server.\n\n## Manual Error Reporting\n\nYou can also manually report errors:\n\n```python\nfrom cadmium_fastapi import report_error\n\ntry:\n # Your code here\n pass\nexcept Exception as e:\n await report_error(e, request)\n```\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "Cadmium SDK for capturing and sending FastAPI errors",
"version": "1.0.0",
"project_urls": {
"Homepage": "https://github.com/softwares-compound/cadmium-fastapi-sdk",
"Issues": "https://github.com/softwares-compound/cadmium-fastapi-sdk/issues",
"Repository": "https://github.com/softwares-compound/cadmium-fastapi-sdk"
},
"split_keywords": [
"fastapi",
" error-tracking",
" monitoring",
" cadmium"
],
"urls": [
{
"comment_text": null,
"digests": {
"blake2b_256": "c6ad17d39b56fb9f4a9bf36d38c37c8b12efce03d998238cf2ca00690d328517",
"md5": "71cf34bc510cbb5ef167c305a60d9b4b",
"sha256": "2771d5a1ad75e15d2e4fc1d0af4cca796b3f4b148156f8db05b7a4a722aaac79"
},
"downloads": -1,
"filename": "cadmium_fastapi_sdk-1.0.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "71cf34bc510cbb5ef167c305a60d9b4b",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.8",
"size": 6742,
"upload_time": "2025-07-31T16:52:49",
"upload_time_iso_8601": "2025-07-31T16:52:49.787810Z",
"url": "https://files.pythonhosted.org/packages/c6/ad/17d39b56fb9f4a9bf36d38c37c8b12efce03d998238cf2ca00690d328517/cadmium_fastapi_sdk-1.0.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": null,
"digests": {
"blake2b_256": "d96fd2a275279e58985e1c4ec886b64cd1f7f289795743af2f5e890370cf4d93",
"md5": "4622115c42d4050f11bfb521513b12d9",
"sha256": "8bd5a8bf3dfa3de841534d9a017a7fcbeb027185157277f7ec2fede734a762b5"
},
"downloads": -1,
"filename": "cadmium_fastapi_sdk-1.0.0.tar.gz",
"has_sig": false,
"md5_digest": "4622115c42d4050f11bfb521513b12d9",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8",
"size": 6254,
"upload_time": "2025-07-31T16:52:51",
"upload_time_iso_8601": "2025-07-31T16:52:51.227937Z",
"url": "https://files.pythonhosted.org/packages/d9/6f/d2a275279e58985e1c4ec886b64cd1f7f289795743af2f5e890370cf4d93/cadmium_fastapi_sdk-1.0.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2025-07-31 16:52:51",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "softwares-compound",
"github_project": "cadmium-fastapi-sdk",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"lcname": "cadmium-fastapi-sdk"
}
JSON
