backstage_catalog_client 0.0.1

a python client for the Backstage catalog API

backstage-catalog-client

a python client for the Backstage catalog API

• Github repository: https://github.com/mspiegel31/backstage-catalog-client/
• Documentation https://mspiegel31.github.io/backstage-catalog-client/

Getting started with your project

First, create a repository on GitHub with the same name as this project, and then run the following commands:

git init -b main
git add .
git commit -m "init commit"
git remote add origin [e-mail]:mspiegel31/backstage-catalog-client.git
git push -u origin main

Finally, install the environment and the pre-commit hooks with

make install

You are now ready to start development on your project! The CI/CD pipeline will be triggered when you open a pull request, merge to main, or when you create a new release.

To finalize the set-up for publishing to PyPi or Artifactory, see here. For activating the automatic documentation with MkDocs, see here. To enable the code coverage reports, see here.

Releasing a new version

• Create an API Token on Pypi.
• Add the API Token to your projects secrets with the name PYPI_TOKEN by visiting this page.
• Create a new release on Github.
• Create a new tag in the form *.*.*.

For more details, see here.

---

Repository initiated with fpgmaas/cookiecutter-poetry.

Generating entities

TODO: script

1. run scripts/generate-models.py to fetch jsonschemas in a pydantic-friendly way
2. run datamodel-codegen: datamodel-codegen --input schemas/ --input-file-type jsonschema --output backstage_catalog_client/entity --output-model-type pydantic_v2.BaseModel --use-title-as-name