diff --git a/README.md b/README.md index f4b28af..3dd2015 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,13 @@ -# polar_bare or Barely Polar? +# Klondike -`polar_bare` offers a lightweight API to manage data ingestion between Polars DataFrames and several common DB-API frameworks. \ No newline at end of file + + +Klondike offers a lightweight API to read and write data to various database endpoints using Polars. + +## Installation + +Install at the command line + +``` +pip install klondike==0.1.0 +``` \ No newline at end of file diff --git a/polar_bare/__init__.py b/klondike/__init__.py similarity index 78% rename from polar_bare/__init__.py rename to klondike/__init__.py index a02f035..dc64159 100644 --- a/polar_bare/__init__.py +++ b/klondike/__init__.py @@ -24,10 +24,10 @@ __all__ = [] POLAR_OBJECTS = [ - ("polar_bare.bigquery.bigquery", "PolarBigQuery"), - ("polar_bare.postgres.postgres", "PolarPostgres"), - ("polar_bare.redshift.redshift", "PolarRedshift"), - ("polar_bare.snowflake.snowflake", "PolarSnowflake"), + ("klondike.bigquery.bigquery", "PolarBigQuery"), + ("klondike.postgres.postgres", "PolarPostgres"), + ("klondike.redshift.redshift", "PolarRedshift"), + ("klondike.snowflake.snowflake", "PolarSnowflake"), ] for module_, object_ in POLAR_OBJECTS: diff --git a/polar_bare/bigquery/__init__.py b/klondike/base/__init__.py similarity index 100% rename from polar_bare/bigquery/__init__.py rename to klondike/base/__init__.py diff --git a/polar_bare/pbear/generic_db.py b/klondike/base/generic_db.py similarity index 100% rename from polar_bare/pbear/generic_db.py rename to klondike/base/generic_db.py diff --git a/polar_bare/pbear/__init__.py b/klondike/bigquery/__init__.py similarity index 100% rename from polar_bare/pbear/__init__.py rename to klondike/bigquery/__init__.py diff --git a/polar_bare/bigquery/bigquery.py b/klondike/bigquery/bigquery.py similarity index 97% rename from polar_bare/bigquery/bigquery.py rename to klondike/bigquery/bigquery.py index 7390bcf..341f162 100644 --- a/polar_bare/bigquery/bigquery.py +++ b/klondike/bigquery/bigquery.py @@ -4,7 +4,7 @@ from google.cloud import bigquery from google.cloud.bigquery import dbapi -from polar_bare.pbear.generic_db import PolarBareDB +from klondike.base.generic_db import PolarBareDB import json import os import tempfile diff --git a/polar_bare/postgres/__init__.py b/klondike/postgres/__init__.py similarity index 100% rename from polar_bare/postgres/__init__.py rename to klondike/postgres/__init__.py diff --git a/polar_bare/postgres/postgres.py b/klondike/postgres/postgres.py similarity index 97% rename from polar_bare/postgres/postgres.py rename to klondike/postgres/postgres.py index 0ff7d17..aeb0a88 100644 --- a/polar_bare/postgres/postgres.py +++ b/klondike/postgres/postgres.py @@ -4,7 +4,7 @@ import psycopg -from polar_bare.pbear.generic_db import PolarBareDB +from klondike.base.generic_db import PolarBareDB ########## diff --git a/polar_bare/redshift/__init__.py b/klondike/redshift/__init__.py similarity index 100% rename from polar_bare/redshift/__init__.py rename to klondike/redshift/__init__.py diff --git a/polar_bare/snowflake/__init__.py b/klondike/utils/__init__.py similarity index 100% rename from polar_bare/snowflake/__init__.py rename to klondike/utils/__init__.py diff --git a/polar_bare/utils/__init__.py b/polar_bare/utils/__init__.py deleted file mode 100644 index e69de29..0000000 diff --git a/requirements.txt b/requirements.txt new file mode 100644 index 0000000..5894718 --- /dev/null +++ b/requirements.txt @@ -0,0 +1,4 @@ +google-cloud-bigquery==3.19.0 +polars==0.20.16 +petl==1.7.15 +psycopg==3.1.18 \ No newline at end of file