backstage_catalog_client 0.1.0

a python client for the Backstage catalog API

backstage-catalog-client

A python client for the Backstage catalog API. Only uses native python datatypes.

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

Installation

backstage_catalog_client is available on PyPi. Requires python 3.8+

python3 -m pip install backstage_catalog_client

Usage

to use a ready-made client, import it and make requests

import asyncio
import json
from backstage_catalog_client import HttpxClient


async def main():
    catalog = HttpxClient("https://demo.backstage.io/")
    data = await catalog.get_entities()
    for entity in data.items[:1]:
        print(json.dumps(entity, indent=2))


if __name__ == "__main__":
    asyncio.run(main())

Documentation

project documentation is available at the main documentation site

Prior Art

1. JS Catalog Client: backstage-catalog-client
2. Go Catalog Client: go-backstage

---

Repository initiated with fpgmaas/cookiecutter-poetry.