Metadata-Version: 2.4
Name: pygco-dump
Version: 0.1.0
Summary: Low-impact Python GC object dump producer for pygco
Project-URL: Homepage, https://github.com/ivan-94/py-gc-objects-analyze
Project-URL: Repository, https://github.com/ivan-94/py-gc-objects-analyze
Project-URL: Documentation, https://github.com/ivan-94/py-gc-objects-analyze/tree/main/docs
Project-URL: Issues, https://github.com/ivan-94/py-gc-objects-analyze/issues
Project-URL: Changelog, https://github.com/ivan-94/py-gc-objects-analyze/blob/main/CHANGELOG.md
Author: py-gc-objects-analyze maintainers
Maintainer: py-gc-objects-analyze maintainers
License-Expression: MIT
Keywords: debugging,forensics,gc,memory,python
Classifier: Development Status :: 3 - Alpha
Classifier: Environment :: Web Environment
Classifier: Framework :: FastAPI
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.13
Classifier: Topic :: Software Development :: Debuggers
Classifier: Topic :: System :: Monitoring
Requires-Python: >=3.10
Provides-Extra: fastapi
Requires-Dist: fastapi>=0.115.0; extra == 'fastapi'
Provides-Extra: test
Requires-Dist: fastapi>=0.115.0; extra == 'test'
Requires-Dist: httpx>=0.27.0; extra == 'test'
Requires-Dist: pytest>=8.0.0; extra == 'test'
Description-Content-Type: text/markdown

# pygco-dump

`pygco-dump` writes low-impact Python GC object dumps in the `pygco-dump-jsonl` v1 format.

```python
from pathlib import Path
from pygco_dump import write_gc_dump

with Path("heap.jsonl.gz").open("wb") as file:
    write_gc_dump(file)
```

FastAPI:

```python
from fastapi import FastAPI
from pygco_dump.fastapi import gc_heap_dump_route

app = FastAPI()
app.add_api_route("/debug/gc-heap-dump", gc_heap_dump_route(), methods=["GET"])
```

Framework-agnostic integrations only need a binary file-like object. See `examples/` for
plain file, WSGI, ASGI, and FastAPI variants.

For Celery workers, signal-triggered dumps, and multi-process integration guidance, see
`../../docs/producer-integration.md`.
