atomically
Write the smallest possible OpenAPI and generate the rest. Read more about this approach in the Atomically repository.
Installation
You can use pipx to install this tool.
You can use pipx to install this tool.
- Install pipx
- Run
pipx install atomically
You can also use pip:
pip install atomically
Usage
As CLI
Run atomically --help to see all options.
To generate an OpenAPI from from an atomic file, run:
atomically generate path-to-atomic-file.yml
Read the Atomically repository to see how to write atomic files. Check the tests/atomic_files directory in this repo to see examples.
As Python library
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:
cd atomically
python -m venv venv
source venv/bin/activate
Now install the dependencies and test dependencies:
pip install -e '.[test]'
To run the tests:
pytest
Metadata
Release files for atomically 0.2.0
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | Provenance | Actions |
|---|---|---|---|---|
| atomically-0.2.0.tar.gz | 10.2 kB | Without provenance | Details for atomically-0.2.0.tar.gz |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Actions Reset |
|---|---|---|---|---|
| atomically-0.2.0-py3-none-any.whl | Python 3 | none | any | Details for atomically-0.2.0-py3-none-any.whl |
Total release size: 20.5 kB
Release files / atomically-0.2.0.tar.gz
| Download URL | atomically-0.2.0.tar.gz |
|---|---|
| Size | 10.2 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
b571a2bbcdd70eaaf00ee79d3215925791515e3ca19197b1f2899c16d1b7ae56
|
|
BLAKE2b-256 checksum How to use checksums |
e18fa7b9d45826a7a8a4210fdbdd45210618b7afb96c0e553331d8569bdcd2b6
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/4.0.2 CPython/3.11.7
|
Release files / atomically-0.2.0-py3-none-any.whl
| Download URL | atomically-0.2.0-py3-none-any.whl |
|---|---|
| Size | 10.2 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
e356f6c4efb984a316968449c17fef7124f98fbc151b315b39679eaaad55a9f5
|
|
BLAKE2b-256 checksum How to use checksums |
85efc4d1c0f62e91630eca53bb7c5a94c97819d3cdc779bb5936fb7e158fe5f5
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/4.0.2 CPython/3.11.7
|
Security for atomically 0.2.0
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
No provenance found
None of the files in this release were uploaded with provenance metadata.
A note on package security
PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.
To learn more about protecting yourself from malicious actors, visit our package security documentation.