Skip to content

Latest commit

 

History

History
68 lines (48 loc) · 1.63 KB

README.md

File metadata and controls

68 lines (48 loc) · 1.63 KB
Raw

jsonype

Usage

See documentation.

Similar tools

  • typedload is also a package to "Load and dump json-like data into typed data structures in Python3". It uses a less permissive license.
  • Pydantic is a widely used data validation library for Python. It is often used for converting to and from JSON, but offers much more than that. Unlike in case of jsonype classes that should be converted from/to JSON need to inherit from a base class (BaseModel).

Development

Prerequisites

  • Python >= 3.11: Can be installed with pyenv:

    • pyenv install 3.11

  • Poetry >=1.2: Can be installed with pipx:

    • pipx install poetry

    See Poetry's documentation for alternative installation options, but make sure that poetry plugins can be installed.

  • make for building documentation

Setup virtual env

poetry self add poetry-setuptools-scm-plugin@latest
poetry install
poetry shell

All commands below assume that they are executed in a corresponding virtual environment (e.g. in a shell started by poetry shell) and the current directory is set to the project's root folder.

Run checks

./check.sh

Run build

./build.sh

Release

./release.sh [#.#.#]
git push [GITHUB-REPO] v[#.#.#]

Documentation

Add new modules/packages

cd docs
sphinx-apidoc -o source ../jsonype/