From 96f0a4ef377926fdff7b96e41f556e4a2b438a66 Mon Sep 17 00:00:00 2001 From: Andreas Motl Date: Sun, 22 Dec 2024 02:46:26 +0100 Subject: [PATCH] Documentation: Update README, backlog, and project metadata --- README.md | 89 ++++++++++++++++++++++++++++++++++++------------- docs/backlog.md | 2 ++ pyproject.toml | 10 ++++-- 3 files changed, 74 insertions(+), 27 deletions(-) diff --git a/README.md b/README.md index 759ab7a..2de005a 100644 --- a/README.md +++ b/README.md @@ -14,14 +14,26 @@ # dbt-cratedb2 -[![Package version][badge-package-version]][project-pypi] +[![Bluesky][badge-bluesky]][project-bluesky] +[![Release Notes][badge-release-notes]][project-release-notes] [![Downloads per month][badge-downloads-per-month]][project-downloads] -[![Supported Python versions][badge-python-versions]][project-pypi] + +[![Package version][badge-package-version]][project-pypi] [![License][badge-license]][project-license] [![Status][badge-status]][project-pypi] +[![Supported Python versions][badge-python-versions]][project-pypi] + +ยป [Documentation] +| [Changelog] +| [PyPI] +| [Issues] +| [Source code] +| [License] +| [CrateDB] +| [Community Forum] -The `dbt-cratedb2` package contains all the code enabling [dbt] to work with a -[CrateDB] database. +The `dbt-cratedb2` package contains all the code enabling [dbt] to work with +[CrateDB Self-Managed] or [CrateDB Cloud]. **[dbt]** enables data analysts and engineers to transform their data using the same practices that software engineers use to build applications. @@ -32,6 +44,19 @@ pre-aggregate the raw data in your warehouse so that it's ready for analysis. analyzing massive amounts of data in near real-time, even with complex queries. It is PostgreSQL-compatible, and based on Lucene. +## Installation +Install the most recent version of dbt-cratedb2. +```shell +pip install --upgrade dbt-cratedb2 +``` + +## Getting started + +- [Install dbt](https://docs.getdbt.com/docs/core/installation-overview). +- Read the dbt [introduction](https://docs.getdbt.com/docs/introduction/) and + [viewpoint](https://docs.getdbt.com/community/resources/viewpoint). +- Read about how to [use dbt with CrateDB]. + ## What's Inside CrateDB is PostgreSQL-compatible, that's why dbt-cratedb2 @@ -39,51 +64,67 @@ heavily builds upon the canonical [dbt-postgres] adapter. For more information on using dbt with CrateDB, consult [the docs]. -## Getting started +### `psycopg2` +By default, `dbt-cratedb2` installs `psycopg2-binary`. +For more information, please visit [psycopg2 notes]. -- [Install dbt](https://docs.getdbt.com/docs/core/installation-overview) -- Read the [introduction](https://docs.getdbt.com/docs/introduction/) and - [viewpoint](https://docs.getdbt.com/community/resources/viewpoint) -- Read about how to [use dbt with CrateDB] -## Installation -Install dbt-cratedb2. -```shell -pip install --upgrade 'dbt-cratedb2' -``` +## Project Information -## `psycopg2` -By default, `dbt-cratedb2` installs `psycopg2-binary`. -For more information, please visit [psycopg2 notes]. +### Acknowledgements +Kudos to the authors of all the many software components this library is +inheriting from and building upon, most notably the [dbt-postgres] +package, and [dbt][dbt-core] itself. -## Contribute +### Contributing +The `dbt-cratedb2` package is an open source project, and is +[managed on GitHub]. We appreciate contributions of any kind. -- Want to report a bug or request a feature? Let us know by [opening an issue] -- Want to help us build dbt-cratedb2? Check out the [contributing guide] -- Join the community on the [CrateDB Community Discourse] +- Want to report a bug or request a feature? Let us know by [opening an issue]. +- Want to help us build dbt-cratedb2? Check out the [contributing guide]. +- Join the community on the [CrateDB Community Discourse]. -## Code of Conduct +### License +The project uses the Apache Software License, like the dbt-postgres project +it is deriving from. +### Code of Conduct Everyone interacting with Crate.io's codebases, issue trackers, chat rooms, and mailing lists, please follow the [CrateDB Code of Conduct]. [contributing guide]: https://github.com/crate/dbt-cratedb2/blob/main/CONTRIBUTING.md -[CrateDB]: https://github.com/crate/crate +[CrateDB]: https://cratedb.com/database +[CrateDB Cloud]: https://cratedb.com/database/cloud +[CrateDB Self-Managed]: https://cratedb.com/database/self-managed [CrateDB Code of Conduct]: https://github.com/crate/crate/blob/master/CODE_OF_CONDUCT.md [CrateDB Community Discourse]: https://community.cratedb.com/ [dbt]: https://www.getdbt.com/ -[dbt-postgres]: https://github.com/dbt-labs/dbt-postgres +[dbt-core]: https://pypi.org/project/dbt-core/ +[dbt-postgres]: https://pypi.org/project/dbt-postgres/ [opening an issue]: https://github.com/crate/dbt-cratedb2/issues/new [psycopg2 notes]: https://github.com/crate/dbt-cratedb2/blob/genesis/docs/psycopg2.md [the docs]: https://docs.getdbt.com/docs/core/connect-data-platform/cratedb-setup [use dbt with CrateDB]: https://cratedb.com/docs/guide/integrate/dbt/ +[Changelog]: https://github.com/crate/dbt-cratedb2/blob/main/CHANGELOG.md +[Community Forum]: https://community.cratedb.com/ +[Documentation]: https://cratedb.com/docs/guide/integrate/dbt/ +[Issues]: https://github.com/crate/dbt-cratedb2/issues +[License]: https://github.com/crate/dbt-cratedb2/blob/main/LICENSE +[managed on GitHub]: https://github.com/crate/dbt-cratedb2 +[PyPI]: https://pypi.org/project/dbt-cratedb2/ +[Source code]: https://github.com/crate/dbt-cratedb2 + +[badge-bluesky]: https://img.shields.io/badge/Bluesky-0285FF?logo=bluesky&logoColor=fff&label=Follow%20%40CrateDB [badge-downloads-per-month]: https://pepy.tech/badge/dbt-cratedb2/month [badge-license]: https://img.shields.io/github/license/crate/dbt-cratedb2.svg [badge-package-version]: https://img.shields.io/pypi/v/dbt-cratedb2.svg [badge-python-versions]: https://img.shields.io/pypi/pyversions/dbt-cratedb2.svg +[badge-release-notes]: https://img.shields.io/github/release/crate/dbt-cratedb2?label=Release+Notes [badge-status]: https://img.shields.io/pypi/status/dbt-cratedb2.svg +[project-bluesky]: https://bsky.app/search?q=cratedb [project-downloads]: https://pepy.tech/project/dbt-cratedb2/ [project-license]: https://github.com/crate/dbt-cratedb2/blob/main/LICENSE [project-pypi]: https://pypi.org/project/dbt-cratedb2 +[project-release-notes]: https://github.com/crate/dbt-cratedb2/releases diff --git a/docs/backlog.md b/docs/backlog.md index 45bfd0f..ea9a02c 100644 --- a/docs/backlog.md +++ b/docs/backlog.md @@ -16,6 +16,8 @@ From `release-internal.yml` GHA workflow. ```shell python -c "import dbt.adapters.cratedb" ``` +- https://docs.getdbt.com/docs/build/data-tests +- https://docs.getdbt.com/reference/node-selection/test-selection-examples ## Testing (from upstream) diff --git a/pyproject.toml b/pyproject.toml index dd0506c..d7426cf 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -16,6 +16,7 @@ classifiers = [ "License :: OSI Approved :: Apache Software License", "Operating System :: MacOS :: MacOS X", "Operating System :: Microsoft :: Windows", + "Operating System :: OS Independent", "Operating System :: POSIX :: Linux", "Programming Language :: Python :: 3.9", "Programming Language :: Python :: 3.10", @@ -29,11 +30,14 @@ dependencies = [ "sql-metadata<3", ] [project.urls] +Changelog = "https://github.com/crate/dbt-cratedb2/blob/main/CHANGELOG.md" +Documentation = "https://cratedb.com/docs/guide/integrate/dbt/" +Downloads = "https://pypi.org/project/dbt-cratedb2/#files" Homepage = "https://github.com/crate/dbt-cratedb2" -Documentation = "https://github.com/crate/dbt-cratedb2/" -Repository = "https://github.com/crate/dbt-cratedb2.git" Issues = "https://github.com/crate/dbt-cratedb2/issues" -Changelog = "https://github.com/crate/dbt-cratedb2/blob/main/CHANGELOG.md" +"Release Notes" = "https://github.com/crate/dbt-cratedb2/releases" +Repository = "https://github.com/crate/dbt-cratedb2" +"Source Code" = "https://github.com/crate/dbt-cratedb2" [build-system] requires = ["hatchling"]