[go: up one dir, main page]

Skip to content

CLI for developers. It contains many useful features when working on using BO4E in your own projects.

Notifications You must be signed in to change notification settings

bo4e/BO4E-CLI

Repository files navigation

BO4E-CLI

Unittests status badge Coverage status badge Linting status badge Black status badge

This is a command line interface (CLI) for developers working or wanting to work with BO4E models. It contains several features which can make your life easier when working with BO4E.

It uses the JSON-Schemas of the BO4E standard as source of truth.

Features

  • Pull JSON schemas of specific version conveniently from GitHub and replace the online references with relative paths.
  • Edit JSON schemas using a static config file to customize the BO4E models to your usecase.
  • Generate the models in one of the supported languages: Python (pydantic v1, pydantic v2, sql-model).
  • Compare BO4E schemas of different versions. Creates machine-readable output.
    • Create a difference matrix comparing multiple versions consecutively.
    • Decide if a Diff between two versions is functional or technical.

How to use this Repository on Your Machine

Follow the instructions in our Python template repository.

Contribute

You are very welcome to contribute to this repository by opening a pull request against the main branch.

About

CLI for developers. It contains many useful features when working on using BO4E in your own projects.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published