Chore: rename 'airbyte-lib' and 'airbyte_lib' to 'PyAirbyte' or 'airbyte' (#40)

Author: aaronsteers

.gitignore

@@ -1,3 +1,7 @@
+# Virtual Environments
+.venv
+.venv-*
+
 # Byte-compiled / optimized / DLL files
 __pycache__/
 *.py[cod]

README.md

@@ -1,6 +1,6 @@
-# airbyte-lib
+# PyAirbyte
 
-airbyte-lib is a library that allows to run Airbyte syncs embedded into any Python application, without the need to run Airbyte server.
+PyAirbyte is a library that allows to run Airbyte syncs embedded into any Python application, without the need to run Airbyte server.
 
 ## Development
 
@@ -25,12 +25,12 @@ AirbyteLib can auto-import secrets from the following sources:
 3. [Google Colab secrets](https://medium.com/@parthdasawant/how-to-use-secrets-in-google-colab-450c38e3ec75).
 4. Manual entry via [`getpass`](https://docs.python.org/3.9/library/getpass.html).
 
-_Note: Additional secret store options may be supported in the future. [More info here.](https://github.com/airbytehq/airbyte-lib-private-beta/discussions/5)_
+_Note: Additional secret store options may be supported in the future. [More info here.](https://github.com/airbytehq/PyAirbyte-private-beta/discussions/5)_
 
 ### Retrieving Secrets
 
 ```python
-from airbyte_lib import get_secret, SecretSource
+from airbyte import get_secret, SecretSource
 
 source = get_connection("source-github")
 source.set_config(
@@ -56,7 +56,7 @@ A unit test validates the documentation is up to date.
 
 ## Connector compatibility
 
-To make a connector compatible with airbyte-lib, the following requirements must be met:
+To make a connector compatible with PyAirbyte, the following requirements must be met:
 * The connector must be a Python package, with a `pyproject.toml` or a `setup.py` file.
 * In the package, there must be a `run.py` file that contains a `run` method. This method should read arguments from the command line, and run the connector with them, outputting messages to stdout.
 * The `pyproject.toml` or `setup.py` file must specify a command line entry point for the `run` method called `source-<connector name>`. This is usually done by adding a `console_scripts` section to the `pyproject.toml` file, or a `entry_points` section to the `setup.py` file. For example:

airbyte/__init__.py

@@ -0,0 +1,26 @@
+"""AirbyteLib brings Airbyte ELT to every Python developer."""
+from __future__ import annotations
+
+from airbyte._factories.cache_factories import get_default_cache, new_local_cache
+from airbyte._factories.connector_factories import get_source
+from airbyte.caches import DuckDBCache, DuckDBCacheConfig
+from airbyte.datasets import CachedDataset
+from airbyte.registry import get_available_connectors
+from airbyte.results import ReadResult
+from airbyte.secrets import SecretSource, get_secret
+from airbyte.source import Source
+
+
+__all__ = [
+    "CachedDataset",
+    "DuckDBCache",
+    "DuckDBCacheConfig",
+    "get_available_connectors",
+    "get_source",
+    "get_default_cache",
+    "get_secret",
+    "new_local_cache",
+    "ReadResult",
+    "SecretSource",
+    "Source",
+]

airbyte_lib/_executor.py airbyte/_executor.py

@@ -12,9 +12,9 @@
 
 from rich import print
 
-from airbyte_lib import exceptions as exc
-from airbyte_lib.registry import ConnectorMetadata
-from airbyte_lib.telemetry import SourceTelemetryInfo, SourceType
+from airbyte import exceptions as exc
+from airbyte.registry import ConnectorMetadata
+from airbyte.telemetry import SourceTelemetryInfo, SourceType
 
 
 if TYPE_CHECKING:
@@ -435,13 +435,13 @@ def ensure_installation(
 
     def install(self) -> NoReturn:
         raise exc.AirbyteConnectorInstallationError(
-            message="Connector cannot be installed because it is not managed by airbyte-lib.",
+            message="Connector cannot be installed because it is not managed by PyAirbyte.",
             connector_name=self.name,
         )
 
     def uninstall(self) -> NoReturn:
         raise exc.AirbyteConnectorInstallationError(
-            message="Connector cannot be uninstalled because it is not managed by airbyte-lib.",
+            message="Connector cannot be uninstalled because it is not managed by PyAirbyte.",
             connector_name=self.name,
         )
 

airbyte_lib/_factories/__init__.py airbyte/_factories/__init__.py

@@ -5,8 +5,8 @@
 
 import ulid
 
-from airbyte_lib import exceptions as exc
-from airbyte_lib.caches.duckdb import DuckDBCache, DuckDBCacheConfig
+from airbyte import exceptions as exc
+from airbyte.caches.duckdb import DuckDBCache, DuckDBCacheConfig
 
 
 def get_default_cache() -> DuckDBCache:

airbyte_lib/_factories/cache_factories.py airbyte/_factories/cache_factories.py

@@ -6,10 +6,10 @@
 from pathlib import Path
 from typing import Any
 
-from airbyte_lib import exceptions as exc
-from airbyte_lib._executor import PathExecutor, VenvExecutor
-from airbyte_lib.registry import ConnectorMetadata, get_connector_metadata
-from airbyte_lib.source import Source
+from airbyte import exceptions as exc
+from airbyte._executor import PathExecutor, VenvExecutor
+from airbyte.registry import ConnectorMetadata, get_connector_metadata
+from airbyte.source import Source
 
 
 def get_connector(

airbyte_lib/_factories/connector_factories.py airbyte/_factories/connector_factories.py

@@ -11,8 +11,8 @@
 
 from overrides import overrides
 
-from airbyte_lib._processors import BatchHandle, RecordProcessor
-from airbyte_lib.config import CacheConfigBase
+from airbyte._processors import BatchHandle, RecordProcessor
+from airbyte.config import CacheConfigBase
 
 
 if TYPE_CHECKING:

airbyte_lib/_file_writers/__init__.py airbyte/_file_writers/__init__.py

@@ -11,13 +11,13 @@
 from overrides import overrides
 from pyarrow import parquet
 
-from airbyte_lib import exceptions as exc
-from airbyte_lib._file_writers.base import (
+from airbyte import exceptions as exc
+from airbyte._file_writers.base import (
     FileWriterBase,
     FileWriterBatchHandle,
     FileWriterConfigBase,
 )
-from airbyte_lib._util.text_util import lower_case_set
+from airbyte._util.text_util import lower_case_set
 
 
 class ParquetWriterConfig(FileWriterConfigBase):

airbyte_lib/_file_writers/base.py airbyte/_file_writers/base.py

@@ -31,17 +31,17 @@
     Type,
 )
 
-from airbyte_lib import exceptions as exc
-from airbyte_lib._util import protocol_util
-from airbyte_lib.progress import progress
-from airbyte_lib.strategies import WriteStrategy
+from airbyte import exceptions as exc
+from airbyte._util import protocol_util
+from airbyte.progress import progress
+from airbyte.strategies import WriteStrategy
 
 
 if TYPE_CHECKING:
     from collections.abc import Generator, Iterable, Iterator
 
-    from airbyte_lib.caches._catalog_manager import CatalogManager
-    from airbyte_lib.config import CacheConfigBase
+    from airbyte.caches._catalog_manager import CatalogManager
+    from airbyte.config import CacheConfigBase
 
 
 DEFAULT_BATCH_SIZE = 10_000

airbyte_lib/_file_writers/parquet.py airbyte/_file_writers/parquet.py

@@ -6,7 +6,7 @@
 """
 from __future__ import annotations
 
-from airbyte_lib._util.pip_util import connector_pip_url, github_pip_url
+from airbyte._util.pip_util import connector_pip_url, github_pip_url
 
 
 __all__ = [

airbyte_lib/_processors.py airbyte/_processors.py

@@ -12,7 +12,7 @@
     Type,
 )
 
-from airbyte_lib import exceptions as exc
+from airbyte import exceptions as exc
 
 
 if TYPE_CHECKING:

airbyte_lib/_util/__init__.py airbyte/_util/__init__.py

@@ -0,0 +1,19 @@
+"""Base module for all caches."""
+from __future__ import annotations
+
+from airbyte.caches.base import SQLCacheBase
+from airbyte.caches.duckdb import DuckDBCache, DuckDBCacheConfig
+from airbyte.caches.postgres import PostgresCache, PostgresCacheConfig
+from airbyte.caches.snowflake import SnowflakeCacheConfig, SnowflakeSQLCache
+
+
+# We export these classes for easy access: `airbyte.caches...`
+__all__ = [
+    "DuckDBCache",
+    "DuckDBCacheConfig",
+    "PostgresCache",
+    "PostgresCacheConfig",
+    "SQLCacheBase",
+    "SnowflakeCacheConfig",
+    "SnowflakeSQLCache",
+]

airbyte_lib/_util/pip_util.py airbyte/_util/pip_util.py

@@ -20,7 +20,7 @@
     SyncMode,
 )
 
-from airbyte_lib import exceptions as exc
+from airbyte import exceptions as exc
 
 
 if TYPE_CHECKING:

airbyte_lib/_util/protocol_util.py airbyte/_util/protocol_util.py

@@ -28,15 +28,15 @@
 from sqlalchemy.pool import StaticPool
 from sqlalchemy.sql.elements import TextClause
 
-from airbyte_lib import exceptions as exc
-from airbyte_lib._file_writers.base import FileWriterBase, FileWriterBatchHandle
-from airbyte_lib._processors import BatchHandle, RecordProcessor
-from airbyte_lib._util.text_util import lower_case_set
-from airbyte_lib.caches._catalog_manager import CatalogManager
-from airbyte_lib.config import CacheConfigBase
-from airbyte_lib.datasets._sql import CachedDataset
-from airbyte_lib.strategies import WriteStrategy
-from airbyte_lib.types import SQLTypeConverter
+from airbyte import exceptions as exc
+from airbyte._file_writers.base import FileWriterBase, FileWriterBatchHandle
+from airbyte._processors import BatchHandle, RecordProcessor
+from airbyte._util.text_util import lower_case_set
+from airbyte.caches._catalog_manager import CatalogManager
+from airbyte.config import CacheConfigBase
+from airbyte.datasets._sql import CachedDataset
+from airbyte.strategies import WriteStrategy
+from airbyte.types import SQLTypeConverter
 
 
 if TYPE_CHECKING:
@@ -53,8 +53,8 @@
         ConfiguredAirbyteCatalog,
     )
 
-    from airbyte_lib.datasets._base import DatasetBase
-    from airbyte_lib.telemetry import CacheTelemetryInfo
+    from airbyte.datasets._base import DatasetBase
+    from airbyte.telemetry import CacheTelemetryInfo
 
 
 DEBUG_MODE = False  # Set to True to enable additional debug logging.

airbyte_lib/_util/text_util.py airbyte/_util/text_util.py

@@ -11,9 +11,9 @@
 
 from overrides import overrides
 
-from airbyte_lib._file_writers import ParquetWriter, ParquetWriterConfig
-from airbyte_lib.caches.base import SQLCacheBase, SQLCacheConfigBase
-from airbyte_lib.telemetry import CacheTelemetryInfo
+from airbyte._file_writers import ParquetWriter, ParquetWriterConfig
+from airbyte.caches.base import SQLCacheBase, SQLCacheConfigBase
+from airbyte.telemetry import CacheTelemetryInfo
 
 
 # Suppress warnings from DuckDB about reflection on indices.

airbyte/caches/__init__.py

@@ -6,9 +6,9 @@
 
 from overrides import overrides
 
-from airbyte_lib._file_writers import ParquetWriter, ParquetWriterConfig
-from airbyte_lib.caches.base import SQLCacheBase, SQLCacheConfigBase
-from airbyte_lib.telemetry import CacheTelemetryInfo
+from airbyte._file_writers import ParquetWriter, ParquetWriterConfig
+from airbyte.caches.base import SQLCacheBase, SQLCacheConfigBase
+from airbyte.telemetry import CacheTelemetryInfo
 
 
 class PostgresCacheConfig(SQLCacheConfigBase, ParquetWriterConfig):

airbyte_lib/caches/_catalog_manager.py airbyte/caches/_catalog_manager.py

@@ -11,14 +11,14 @@
 from overrides import overrides
 from snowflake.sqlalchemy import URL, VARIANT
 
-from airbyte_lib._file_writers import ParquetWriter, ParquetWriterConfig
-from airbyte_lib.caches.base import (
+from airbyte._file_writers import ParquetWriter, ParquetWriterConfig
+from airbyte.caches.base import (
     RecordDedupeMode,
     SQLCacheBase,
     SQLCacheConfigBase,
 )
-from airbyte_lib.telemetry import CacheTelemetryInfo
-from airbyte_lib.types import SQLTypeConverter
+from airbyte.telemetry import CacheTelemetryInfo
+from airbyte.types import SQLTypeConverter
 
 
 if TYPE_CHECKING:

airbyte_lib/caches/base.py airbyte/caches/base.py

@@ -0,0 +1,15 @@
+from __future__ import annotations
+
+from airbyte.datasets._base import DatasetBase
+from airbyte.datasets._lazy import LazyDataset
+from airbyte.datasets._map import DatasetMap
+from airbyte.datasets._sql import CachedDataset, SQLDataset
+
+
+__all__ = [
+    "CachedDataset",
+    "DatasetBase",
+    "DatasetMap",
+    "LazyDataset",
+    "SQLDataset",
+]

airbyte_lib/caches/duckdb.py airbyte/caches/duckdb.py

@@ -5,7 +5,7 @@
 
 from overrides import overrides
 
-from airbyte_lib.datasets import DatasetBase
+from airbyte.datasets import DatasetBase
 
 
 if TYPE_CHECKING:

airbyte_lib/caches/postgres.py airbyte/caches/postgres.py

@@ -12,7 +12,7 @@
 
 
 if TYPE_CHECKING:
-    from airbyte_lib.datasets._base import DatasetBase
+    from airbyte.datasets._base import DatasetBase
 
 
 class DatasetMap(Mapping):

airbyte_lib/caches/snowflake.py airbyte/caches/snowflake.py

@@ -7,7 +7,7 @@
 from overrides import overrides
 from sqlalchemy import and_, func, select, text
 
-from airbyte_lib.datasets._base import DatasetBase
+from airbyte.datasets._base import DatasetBase
 
 
 if TYPE_CHECKING:
@@ -17,7 +17,7 @@
     from sqlalchemy import Selectable, Table
     from sqlalchemy.sql import ClauseElement
 
-    from airbyte_lib.caches import SQLCacheBase
+    from airbyte.caches import SQLCacheBase
 
 
 class SQLDataset(DatasetBase):

airbyte_lib/config.py airbyte/config.py

@@ -204,7 +204,7 @@ class AirbyteConnectorNotPyPiPublishedError(AirbyteConnectorRegistryError):
     """Connector found, but not published to PyPI."""
 
     connector_name: str | None = None
-    guidance = "This likely means that the connector is not ready for use with airbyte-lib."
+    guidance = "This likely means that the connector is not ready for use with PyAirbyte."
 
 
 # Connector Errors

airbyte/datasets/__init__.py

@@ -9,8 +9,8 @@
 
 import requests
 
-from airbyte_lib import exceptions as exc
-from airbyte_lib.version import get_version
+from airbyte import exceptions as exc
+from airbyte.version import get_version
 
 
 __cache: dict[str, ConnectorMetadata] | None = None

airbyte_lib/datasets/_base.py airbyte/datasets/_base.py

@@ -4,15 +4,15 @@
 from collections.abc import Mapping
 from typing import TYPE_CHECKING
 
-from airbyte_lib.datasets import CachedDataset
+from airbyte.datasets import CachedDataset
 
 
 if TYPE_CHECKING:
     from collections.abc import Iterator
 
     from sqlalchemy.engine import Engine
 
-    from airbyte_lib.caches import SQLCacheBase
+    from airbyte.caches import SQLCacheBase
 
 
 class ReadResult(Mapping[str, CachedDataset]):