trag1c / oddsprout

Generate random JSON with no schemas involved

oddsprout

Oddsprout is a configurable CLI tool and a Python library for generating random JSONs with no schemas involved. I developed this tool out of necessity to test a JSON parser but all solutions I found online involved generating data based on templates.

See the documentation for usage.

Installation

If you only intend to use it as a CLI tool:

pipx install oddsprout

---

Otherwise, install the library from PyPI:

pip install oddsprout

Or from source:

pip install git+https://github.com/trag1c/oddsprout.git

Contributing

Contributions are welcome!

Please open an issue before submitting a pull request (unless it's a minor change like fixing a typo).

To get started:

1. Clone your fork of the project.
2. Set up the project with just (make sure you have poetry installed):

just install

Note

If you don't want to install just, simply look up the recipes in the project's justfile.

3. After you're done, use the following just recipes to check your changes:

just test      # runs pytest and mypy
just lint      # runs the ruff linter and formatter in check mode
just format    # runs the ruff formatter and isort
just coverage  # checks UT and docstring coverage

License

oddsprout is licensed under the MIT License.
© trag1c, 2024