https://github.com/carte-data/carte

A Python library to generate static data catalog sites. Carte scrapes metadata from your data assets and generates a fully searchable front end that's just HTML.
https://github.com/carte-data/carte

carte data-catalog data-discovery data-documentation lightweight-data-catalogs python-library

Last synced: 8 days ago
JSON representation

A Python library to generate static data catalog sites. Carte scrapes metadata from your data assets and generates a fully searchable front end that's just HTML.

• Host: GitHub
• URL: https://github.com/carte-data/carte
• Owner: carte-data
• License: gpl-3.0
• Created: 2020-12-07T09:28:08.000Z (about 4 years ago)
• Default Branch: main
• Last Pushed: 2022-07-07T13:58:44.000Z (over 2 years ago)
• Last Synced: 2024-11-07T12:53:06.172Z (about 1 month ago)
• Topics: carte, data-catalog, data-discovery, data-documentation, lightweight-data-catalogs, python-library
• Language: Python
• Homepage: https://docs.cartedata.com
• Size: 268 KB
• Stars: 26
• Watchers: 3
• Forks: 0
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • License: COPYING

Awesome Lists containing this project

• jimsghstars - carte-data/carte - A Python library to generate static data catalog sites. Carte scrapes metadata from your data assets and generates a fully searchable front end that's just HTML. (Python)

README

        
# Carte

[![PyPI version](https://badge.fury.io/py/carte-cli.svg)](https://badge.fury.io/py/carte-cli)

![PyPI - License](https://img.shields.io/pypi/l/carte-cli)

[![PyPI - Python Version](https://img.shields.io/pypi/pyversions/carte_cli.svg)](https://pypi.org/project/carte-cli/)

Carte is a Python library for extracting metadata from your data sources and generating structured Markdown files from it. It can also scaffold an MkDocs based static site that provides an easy to use, fully searchable UI that you can simply upload to any static site hosting provider. Carte currently supports the AWS Glue catalog, PostgreSQL, and JSON schemas (only basic support). More sources are coming soon. (You can also use sources from the [Amundsen Databuilder](https://github.com/amundsen-io/amundsendatabuilder) library with a bit of scripting, see [the docs](https://docs.cartedata.com/reference/databuilder/) for details)

## Installation

``` sh

pip install carte-cli

```

If you plan to use PostgreSQL as a data source, you should also install the related optional dependencies using the following command instead of the first one:

``` sh

pip install carte-cli[postgres]

```

## Usage

See [the docs](https://docs.cartedata.com)