Metadata-Version: 2.1
Name: atomically
Version: 0.1.0
Summary: Write the smallest possible OpenAPI and generate the rest
Author: Stephen Mizell
License: Apache-2.0
Project-URL: Homepage, https://github.com/smizell/atomically
Project-URL: Changelog, https://github.com/smizell/atomically/releases
Project-URL: Issues, https://github.com/smizell/atomically/issues
Project-URL: CI, https://github.com/smizell/atomically/actions
Classifier: License :: OSI Approved :: Apache Software License
Requires-Python: >=3.8
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: inflection
Requires-Dist: PyYAML
Provides-Extra: test
Requires-Dist: ipython; extra == "test"
Requires-Dist: pytest; extra == "test"
Requires-Dist: openapi-spec-validator; extra == "test"
Requires-Dist: snapshottest; extra == "test"

# atomically

[![PyPI](https://img.shields.io/pypi/v/atomically.svg)](https://pypi.org/project/atomically/)
[![Tests](https://github.com/smizell/atomically/actions/workflows/test.yml/badge.svg)](https://github.com/smizell/atomically/actions/workflows/test.yml)
[![Changelog](https://img.shields.io/github/v/release/smizell/atomically?include_prereleases&label=changelog)](https://github.com/smizell/atomically/releases)
[![License](https://img.shields.io/badge/license-Apache%202.0-blue.svg)](https://github.com/smizell/atomically/blob/main/LICENSE)

Write the smallest possible OpenAPI and generate the rest. Read more about this approach in the [Atomically repository](https://github.com/smizell/atomically-spec).

## Installation

Install this library using `pip`:
```bash
pip install atomically
```
## Usage

```python
from atomically import Atomically


openapi = Atomically.from_file("atomically.yaml").generate()
with open("openapi.yaml", "w") as f:
    f.write(openapi.to_yaml())
```

## Development

To contribute to this library, first checkout the code. Then create a new virtual environment:

```bash
cd atomically
python -m venv venv
source venv/bin/activate
```

Now install the dependencies and test dependencies:

```bash
pip install -e '.[test]'
```

To run the tests:

```bash
pytest
```
