Metadata-Version: 2.1
Name: snap4frame
Version: 0.1.0
Summary: Creates a snapshot of the python program for later analysis
Author-Email: Panaintescu Adrian Valentin <adrian.cert@gmail.com>
License: GPL-3.0-or-later
Requires-Python: >=3.8
Requires-Dist: importlib-metadata>=7.0.1
Requires-Dist: tox>=4.14.2; extra == "dev"
Requires-Dist: ruff>=0.3.7; extra == "dev"
Requires-Dist: pre-commit>=3.5.0; extra == "dev"
Requires-Dist: msgspec>=0.18.6; extra == "msgspec"
Requires-Dist: requests>=2.31.0; extra == "requests"
Provides-Extra: dev
Provides-Extra: msgspec
Provides-Extra: requests
Description-Content-Type: text/markdown

# **snap4frame**
### creates a snapshot of the python program for later analysis

**snap4frame** is a python package that creates a snapshot of your python program for later analysis. It's designed to help developers understand the state of their program at a specific point in time, which can be useful for debugging and performance optimization.

---

# snap4frame

## Installation

You can install snap4frame using pip:

```bash
pip install snap4frame
```

---

## Usage

Here's a basic example of how to use snap4frame:

```python
import snap4frame

snap4frame.init()
```

---

## Backlog & Known Issues

- [ ] Write a more detailed README
- [ ] Create documentation with MkDocs
- [ ] Create unit test cases
- [ ] Add badges for highlighting quality
- [ ] Add filtering for frames
- [ ] Add processor for lookup on source code

For more details, please see the [TODO document](todo.md).

---

## Contributing

We welcome contributions to snap4frame! Please see our [contributing guide](CONTRIBUTING.md) for more details.

---

## License

Snap4frame is licensed under the [MIT License](LICENSE).
