openapi-elm-client generates Elm client code from OpenAPI 2.0 specification.
Usage
Basic usage is like this:
openapi-elm-client my_spec.yaml Some.Module.Name
This will read the OpenAPI spec from my_spec.yaml and create an Elm module named Some.Module.Name. This writes the output to stdout, so a more typical invocation might be:
openapi-elm-client my_spec.yaml Some.Module.Name > src/Some/Module/Name.elm
Generated code
openapi-elm-client produces a named type alias for each definition in the input spec. It also produces a function for calling each endpoint defined in the spec, along with appropriate JSON encoders and decoders.
Tests
You can run the tests by first installing the test dependencies:
pip install ".[test]"
and then invoking pytest:
pytest tests
Approval tests
openapi-elm-client uses godkjenn for approval testing. We have collection of input specs along with “approved” versions of the code generated by openapi-elm-client; if the generated code ever changes, we have to see if it’s still correct.
1 maintainer
Metadata
1 maintainer
Release files for openapi-elm-client 0.3.3
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 | |
|---|---|---|---|---|
| openapi_elm_client-0.3.3.tar.gz | 6.7 kB | Without provenance | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| openapi_elm_client-0.3.3-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 17.9 kB
Release files / openapi_elm_client-0.3.3.tar.gz
| Download URL | openapi_elm_client-0.3.3.tar.gz |
|---|---|
| Size | 6.7 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
812777ed0a1d5b2e9daad588f172228316b1f86043d54fabcc75a208f49af7b7
|
|
BLAKE2b-256 checksum How to use checksums |
ff0e9e85293722fab83e23ba86814c28f2eb6d3955daa3976aca3d22ff3cac7d
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/3.4.1 importlib_metadata/3.10.0 pkginfo/1.7.0 requests/2.25.1 requests-toolbelt/0.9.1 tqdm/4.60.0 CPython/3.9.4
|
Release files / openapi_elm_client-0.3.3-py3-none-any.whl
| Download URL | openapi_elm_client-0.3.3-py3-none-any.whl |
|---|---|
| Size | 11.2 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
955bc5077c4862a8fc5c60896a55ae6a2496acd2c165346308efdd93c5301312
|
|
BLAKE2b-256 checksum How to use checksums |
1b31d754a412a42050dc821ff876fb49000c4e75a591afb4de4fc7147649237d
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/3.4.1 importlib_metadata/3.10.0 pkginfo/1.7.0 requests/2.25.1 requests-toolbelt/0.9.1 tqdm/4.60.0 CPython/3.9.4
|
Security for openapi-elm-client 0.3.3
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.
