Skip to content

Commit 2d0aa85

Browse files
bindipankhudibindipankhudi
authored andcommitted
Cleaned up PyAibyte docs (PR # 35603) (airbytehq#35603)
Co-authored-by: bindipankhudi <[email protected]>
1 parent f0df0b1 commit 2d0aa85

File tree

5 files changed

+20
-23
lines changed

5 files changed

+20
-23
lines changed

docs/assets/docs/airbyte-lib-high-level-architecture.svg

Lines changed: 1 addition & 1 deletion
Loading

docs/using-airbyte/airbyte-lib/getting-started.mdx

Lines changed: 16 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,19 +1,19 @@
11
import AirbyteLibConnectors from '@site/src/components/AirbyteLibConnectors';
22

3-
# Getting Started with AirbyteLib (Beta)
3+
# Getting Started with PyAirbyte (Beta)
44

5-
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.
66

77
## Installation
88

99
```bash
10-
pip install airbyte-lib
10+
pip install airbyte
1111
```
1212

1313
Or during the beta, you may want to install the latest from from source with:
1414

1515
```bash
16-
pip install 'git+https://www.github.com/airbytehq/airbyte.git@master#egg=airbyte-lib&subdirectory=airbyte-lib'
16+
pip install 'git+https://github.com/airbytehq/PyAirbyte.git'
1717
```
1818

1919
## Usage
@@ -23,7 +23,7 @@ Data can be extracted from sources and loaded into caches:
2323
<a href="https://colab.research.google.com/github/airbytehq/quickstarts/blob/master/airbyte_lib_notebooks/AirbyteLib_Basic_Features_Demo.ipynb" target="_parent"><img src="https://img.shields.io/badge/-Try%20with%20Colab-grey?logo=googlecolab" alt="Try with Colab"/></a>
2424

2525
```python
26-
import airbyte_lib as ab
26+
import airbyte as ab
2727

2828
source = ab.get_source(
2929
"source-faker",
@@ -38,17 +38,26 @@ for name, records in result.streams.items():
3838
print(f"Stream {name}: {len(list(records))} records")
3939
```
4040

41+
## Quickstarts
42+
43+
* [CoinAPI](https://github.com/airbytehq/quickstarts/blob/main/airbyte_lib_notebooks/AirbyteLib_CoinAPI_Demo.ipynb)
44+
* [GA4](https://github.com/airbytehq/quickstarts/blob/main/airbyte_lib_notebooks/AirbyteLib_GA4_Demo.ipynb)
45+
* [Shopify](https://github.com/airbytehq/quickstarts/blob/main/airbyte_lib_notebooks/PyAirbyte_Shopify_Demo.ipynb)
46+
* [GitHub](https://github.com/airbytehq/quickstarts/blob/main/airbyte_lib_notebooks/AirbyteLib_Github_Incremental_Demo.ipynb)
47+
* [Postgres (cache)](https://github.com/airbytehq/quickstarts/blob/main/airbyte_lib_notebooks/PyAirbyte_Postgres_Custom_Cache_Demo.ipynb)
48+
49+
4150
## API Reference
4251

43-
For details on specific classes and methods, please refer to our [AirbyteLib API Reference](./reference).
52+
For details on specific classes and methods, please refer to our [PyAirbyte API Reference](https://airbytehq.github.io/PyAirbyte/index.html).
4453

4554
## Architecture
4655

4756
[comment]: <> (Edit under https://docs.google.com/drawings/d/1M7ti2D4ha6cEtPnk04RLp1SSh3au4dRJsLupnGPigHQ/edit?usp=sharing)
4857

4958
![Architecture](../../assets/docs/airbyte-lib-high-level-architecture.svg)
5059

51-
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:
5261
* **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.
5362
* **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.
5463
* **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.

docs/using-airbyte/airbyte-lib/reference.mdx

Lines changed: 0 additions & 15 deletions
This file was deleted.

docusaurus/redirects.yml

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -93,3 +93,6 @@
9393
- /enterprise-setup/self-managed/sso
9494
- /enterprise-setup/sso
9595
to: /access-management/sso
96+
- from:
97+
- /pyairbyte
98+
to: /using-airbyte/airbyte-lib/getting-started
7.87 KB
Loading

0 commit comments

Comments
 (0)