You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
AirbyteLib is a library that provides a set of utilities to use Airbyte connectors in Python. It is meant to be used in situations where setting up an Airbyte server or cloud account is not possible or desirable, for example in a Jupyter notebook or when iterating on early prototypes on a developer's workstation.
5
+
PyAirbyte is a library that provides a set of utilities to use Airbyte connectors in Python. It is meant to be used in situations where setting up an Airbyte server or cloud account is not possible or desirable, for example in a Jupyter notebook or when iterating on early prototypes on a developer's workstation.
6
6
7
7
## Installation
8
8
9
9
```bash
10
-
pip install airbyte-lib
10
+
pip install airbyte
11
11
```
12
12
13
13
Or during the beta, you may want to install the latest from from source with:
@@ -23,7 +23,7 @@ Data can be extracted from sources and loaded into caches:
23
23
<ahref="https://colab.research.google.com/github/airbytehq/quickstarts/blob/master/airbyte_lib_notebooks/AirbyteLib_Basic_Features_Demo.ipynb"target="_parent"><imgsrc="https://img.shields.io/badge/-Try%20with%20Colab-grey?logo=googlecolab"alt="Try with Colab"/></a>
24
24
25
25
```python
26
-
importairbyte_libas ab
26
+
importairbyteas ab
27
27
28
28
source = ab.get_source(
29
29
"source-faker",
@@ -38,17 +38,26 @@ for name, records in result.streams.items():
airbyte-lib is a python library that can be run in any context that supports Python >=3.9. It contains the following main components:
60
+
PyAirbyte is a python library that can be run in any context that supports Python >=3.9. It contains the following main components:
52
61
***Source**: A source object is using a Python connector and includes a configuration object. The configuration object is a dictionary that contains the configuration of the connector, like authentication or connection modalities. The source object is used to read data from the connector.
53
62
***Cache**: Data can be read directly from the source object. However, it is recommended to use a cache object to store the data. The cache object allows to temporarily store records from the source in a SQL database like a local DuckDB file or a Postgres or Snowflake instance.
54
63
***Result**: An object holding the records from a read operation on a source. It allows quick access to the records of each synced stream via the used cache object. Data can be accessed as a list of records, a Pandas DataFrame or via SQLAlchemy queries.
0 commit comments