Metadata-Version: 2.3
Name: snap4frame
Version: 0.1.2
Summary: Creates a snapshot of the python program for later analysis
Author-email: Panaintescu Adrian Valentin <adrian.cert@gmail.com>
License: MIT License
        
        Copyright (c) 2024 Adrian-Valentin Panaintescu
        
        Permission is hereby granted, free of charge, to any person obtaining a copy
        of this software and associated documentation files (the "Software"), to deal
        in the Software without restriction, including without limitation the rights
        to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
        copies of the Software, and to permit persons to whom the Software is
        furnished to do so, subject to the following conditions:
        
        The above copyright notice and this permission notice shall be included in all
        copies or substantial portions of the Software.
        
        THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
        IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
        FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
        AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
        LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
        OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
        SOFTWARE.
Requires-Python: >=3.8
Requires-Dist: importlib-metadata>=7.0.1
Provides-Extra: dev
Requires-Dist: pre-commit>=3.5.0; extra == 'dev'
Requires-Dist: ruff>=0.3.7; extra == 'dev'
Requires-Dist: tox>=4.14.2; extra == 'dev'
Provides-Extra: msgspec
Requires-Dist: msgspec>=0.18.6; extra == 'msgspec'
Provides-Extra: requests
Requires-Dist: requests>=2.31.0; 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.md).
