dbcat


Namedbcat JSON
Version 0.15.0 PyPI version JSON
download
home_pagehttps://tokern.io/
SummaryTokern Data Catalog
upload_time2023-10-16 03:29:55
maintainer
docs_urlNone
authorTokern
requires_python>=3.8,<=3.10.8
licenseMIT
keywords data-catalog postgres snowflake redshift glue bigquery
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            [![dbcat](https://github.com/tokern/dbcat/actions/workflows/ci.yml/badge.svg)](https://github.com/tokern/dbcat/actions/workflows/ci.yml)
[![PyPI](https://img.shields.io/pypi/v/dbcat.svg)](https://pypi.python.org/pypi/dbcat)
[![image](https://img.shields.io/pypi/l/dbcat.svg)](https://pypi.org/project/dbcat/)
[![image](https://img.shields.io/pypi/pyversions/dbcat.svg)](https://pypi.org/project/dbcat/)

# Data Catalog for Databases and Data Warehouses

## Overview

*dbcat* scans and maintains metadata from all your databases and data warehouses. 
*dbcat* also stores metadata generated by other data governance applications such as 
[PIICatcher](https://github.com/tokern/piicatcher) and [Lineage Engine](https://github.com/tokern/data-lineage).
*dbcat* is typically used alongside other applications. It can also be used stand-alone to generate
a very simple data catalog using the CLI or API.  

*dbcat* stores the catalog in a Postgresql or SQLite database. By default, the catalog is stored in a SQLite
database in `~/.config/tokern/catalog.db`

The catalog can be exported to [Datahub](https://datahubproject.io/) or [Amundsen](https://amundsen.io). This is very 
useful to export PII tags or column lineage generated by PIICatcher or Lineage Engine. 
Check [documentation for detailed instructions](https://tokern.io/docs/catalog/export) to set PII tags and 
column-level lineage.


## Quick Start

*dbcat* is distributed as a python application.

    python3 -m venv .env
    source .env/bin/activate
    pip install dbcat
 
    dbcat catalog add-sqlite --name sample --path <path to sqlite db>
    dbcat catalog scan --source-name sample

## Documentation

For advanced usage refer documentation [Catalog Documentation](https://tokern.io/docs/catalog).

## Supported Technologies

The following databases are supported:

* MySQL/Mariadb
* PostgreSQL
* AWS Redshift
* BigQuery
* Snowflake
* AWS Athena


            

Raw data

            {
    "_id": null,
    "home_page": "https://tokern.io/",
    "name": "dbcat",
    "maintainer": "",
    "docs_url": null,
    "requires_python": ">=3.8,<=3.10.8",
    "maintainer_email": "",
    "keywords": "data-catalog,postgres,snowflake,redshift,glue,bigquery",
    "author": "Tokern",
    "author_email": "info@tokern.io",
    "download_url": "https://files.pythonhosted.org/packages/00/07/f02ce063b329a48c07adf77f844f979901748f53d1b25ebc3510d711173f/dbcat-0.15.0.tar.gz",
    "platform": null,
    "description": "[![dbcat](https://github.com/tokern/dbcat/actions/workflows/ci.yml/badge.svg)](https://github.com/tokern/dbcat/actions/workflows/ci.yml)\n[![PyPI](https://img.shields.io/pypi/v/dbcat.svg)](https://pypi.python.org/pypi/dbcat)\n[![image](https://img.shields.io/pypi/l/dbcat.svg)](https://pypi.org/project/dbcat/)\n[![image](https://img.shields.io/pypi/pyversions/dbcat.svg)](https://pypi.org/project/dbcat/)\n\n# Data Catalog for Databases and Data Warehouses\n\n## Overview\n\n*dbcat* scans and maintains metadata from all your databases and data warehouses. \n*dbcat* also stores metadata generated by other data governance applications such as \n[PIICatcher](https://github.com/tokern/piicatcher) and [Lineage Engine](https://github.com/tokern/data-lineage).\n*dbcat* is typically used alongside other applications. It can also be used stand-alone to generate\na very simple data catalog using the CLI or API.  \n\n*dbcat* stores the catalog in a Postgresql or SQLite database. By default, the catalog is stored in a SQLite\ndatabase in `~/.config/tokern/catalog.db`\n\nThe catalog can be exported to [Datahub](https://datahubproject.io/) or [Amundsen](https://amundsen.io). This is very \nuseful to export PII tags or column lineage generated by PIICatcher or Lineage Engine. \nCheck [documentation for detailed instructions](https://tokern.io/docs/catalog/export) to set PII tags and \ncolumn-level lineage.\n\n\n## Quick Start\n\n*dbcat* is distributed as a python application.\n\n    python3 -m venv .env\n    source .env/bin/activate\n    pip install dbcat\n \n    dbcat catalog add-sqlite --name sample --path <path to sqlite db>\n    dbcat catalog scan --source-name sample\n\n## Documentation\n\nFor advanced usage refer documentation [Catalog Documentation](https://tokern.io/docs/catalog).\n\n## Supported Technologies\n\nThe following databases are supported:\n\n* MySQL/Mariadb\n* PostgreSQL\n* AWS Redshift\n* BigQuery\n* Snowflake\n* AWS Athena\n\n",
    "bugtrack_url": null,
    "license": "MIT",
    "summary": "Tokern Data Catalog",
    "version": "0.15.0",
    "project_urls": {
        "Homepage": "https://tokern.io/",
        "Repository": "https://github.com/tokern/dbcat/"
    },
    "split_keywords": [
        "data-catalog",
        "postgres",
        "snowflake",
        "redshift",
        "glue",
        "bigquery"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "57264ccff21b2112992116436ecdcf1f35e0ec8ab7bb8cfd3ecdb8b8aeaf13e1",
                "md5": "64caea40a599fe33e9b9a1a30aeb431f",
                "sha256": "8a1970b84ebd778ae2ab22a96959c7b9544a20a371830940066ae47c13daa6c0"
            },
            "downloads": -1,
            "filename": "dbcat-0.15.0-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "64caea40a599fe33e9b9a1a30aeb431f",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.8,<=3.10.8",
            "size": 32985,
            "upload_time": "2023-10-16T03:29:53",
            "upload_time_iso_8601": "2023-10-16T03:29:53.519943Z",
            "url": "https://files.pythonhosted.org/packages/57/26/4ccff21b2112992116436ecdcf1f35e0ec8ab7bb8cfd3ecdb8b8aeaf13e1/dbcat-0.15.0-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "0007f02ce063b329a48c07adf77f844f979901748f53d1b25ebc3510d711173f",
                "md5": "8a759597a183974d9816937b0220fa74",
                "sha256": "a1f547ed1e0845bf9e3fd45ab58a8d7ec3e40daf7153d2f4a52adaad1ed60a59"
            },
            "downloads": -1,
            "filename": "dbcat-0.15.0.tar.gz",
            "has_sig": false,
            "md5_digest": "8a759597a183974d9816937b0220fa74",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.8,<=3.10.8",
            "size": 26183,
            "upload_time": "2023-10-16T03:29:55",
            "upload_time_iso_8601": "2023-10-16T03:29:55.166049Z",
            "url": "https://files.pythonhosted.org/packages/00/07/f02ce063b329a48c07adf77f844f979901748f53d1b25ebc3510d711173f/dbcat-0.15.0.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2023-10-16 03:29:55",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "tokern",
    "github_project": "dbcat",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": true,
    "lcname": "dbcat"
}
        
Elapsed time: 1.70865s