Skip to content

Commit

Permalink
renames "PyAirbyte"
Browse files Browse the repository at this point in the history
  • Loading branch information
aaronsteers committed Feb 16, 2024
1 parent 67b0bdc commit 6d2e5b9
Show file tree
Hide file tree
Showing 8 changed files with 17 additions and 17 deletions.
6 changes: 3 additions & 3 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Contributing to AirbyteLib
# Contributing to PyAirbyte

Learn how you can become a contributor to AirbyteLib.
Learn how you can become a contributor to PyAirbyte.

## Development

Expand Down Expand Up @@ -28,7 +28,7 @@ Documentation pages will be generated in the `docs/generated` folder. The `test_
- In your PR:
- Bump the version in `pyproject.toml`
- Add a changelog entry to the table below
- Once the PR is merged, go to Github and trigger the `Publish AirbyteLib Manually` workflow. This will publish the new version to PyPI.
- Once the PR is merged, go to Github and trigger the `Publish PyAirbyte Manually` workflow. This will publish the new version to PyPI.

## Versioning

Expand Down
8 changes: 4 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ airbyte-lib is a library that allows to run Airbyte syncs embedded into any Pyth

## Secrets Management

AirbyteLib can auto-import secrets from the following sources:
PyAirbyte can auto-import secrets from the following sources:

1. Environment variables.
2. Variables defined in a local `.env` ("Dotenv") file.
Expand All @@ -26,9 +26,9 @@ source.set_config(
)
```

The `get_secret()` function accepts an optional `source` argument of enum type `SecretSource`. If omitted or set to `SecretSource.ANY`, AirbyteLib will search all available secrets sources. If `source` is set to a specific source, then only that source will be checked. If a list of `SecretSource` entries is passed, then the sources will be checked using the provided ordering.
The `get_secret()` function accepts an optional `source` argument of enum type `SecretSource`. If omitted or set to `SecretSource.ANY`, PyAirbyte will search all available secrets sources. If `source` is set to a specific source, then only that source will be checked. If a list of `SecretSource` entries is passed, then the sources will be checked using the provided ordering.

By default, AirbyteLib will prompt the user for any requested secrets that are not provided via other secret managers. You can disable this prompt by passing `prompt=False` to `get_secret()`.
By default, PyAirbyte will prompt the user for any requested secrets that are not provided via other secret managers. You can disable this prompt by passing `prompt=False` to `get_secret()`.

## Connector compatibility

Expand Down Expand Up @@ -80,7 +80,7 @@ For a more lightweight check, the `--validate-install-only` flag can be used. Th

## Contributing

To learn how you can contribute to AirbyteLib, please see our [AirbyteLib Contributors Guide](./CONTRIBUTING.md).
To learn how you can contribute to PyAirbyte, please see our [PyAirbyte Contributors Guide](./CONTRIBUTING.md).

## Changelog

Expand Down
8 changes: 4 additions & 4 deletions airbyte/exceptions.py
Original file line number Diff line number Diff line change
Expand Up @@ -106,7 +106,7 @@ def __repr__(self) -> str:
return f"{class_name}({properties_str})"


# AirbyteLib Internal Errors (these are probably bugs)
# PyAirbyte Internal Errors (these are probably bugs)


@dataclass
Expand All @@ -117,12 +117,12 @@ class AirbyteLibInternalError(AirbyteError):
help_url = NEW_ISSUE_URL


# AirbyteLib Input Errors (replaces ValueError for user input)
# PyAirbyte Input Errors (replaces ValueError for user input)


@dataclass
class AirbyteLibInputError(AirbyteError, ValueError):
"""The input provided to AirbyteLib did not match expected validation rules.
"""The input provided to PyAirbyte did not match expected validation rules.
This inherits from ValueError so that it can be used as a drop-in replacement for
ValueError in the Airbyte Lib API.
Expand All @@ -146,7 +146,7 @@ class AirbyteLibNoStreamsSelectedError(AirbyteLibInputError):
available_streams: list[str] | None = None


# AirbyteLib Cache Errors
# PyAirbyte Cache Errors


class AirbyteLibCacheError(AirbyteError):
Expand Down
2 changes: 1 addition & 1 deletion airbyte/secrets.py
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
# Copyright (c) 2023 Airbyte, Inc., all rights reserved.
"""Secrets management for AirbyteLib."""
"""Secrets management for PyAirbyte."""
from __future__ import annotations

import contextlib
Expand Down
4 changes: 2 additions & 2 deletions airbyte/strategies.py
Original file line number Diff line number Diff line change
@@ -1,13 +1,13 @@
# Copyright (c) 2023 Airbyte, Inc., all rights reserved.

"""Read and write strategies for AirbyteLib."""
"""Read and write strategies for PyAirbyte."""
from __future__ import annotations

from enum import Enum


class WriteStrategy(str, Enum):
"""Read strategies for AirbyteLib."""
"""Read strategies for PyAirbyte."""

MERGE = "merge"
"""Merge new records with existing records.
Expand Down
2 changes: 1 addition & 1 deletion examples/run_faker.py
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
# Copyright (c) 2023 Airbyte, Inc., all rights reserved.
"""A simple test of AirbyteLib, using the Faker source connector.
"""A simple test of PyAirbyte, using the Faker source connector.
Usage (from PyAirbyte root directory):
> poetry run python ./examples/run_faker.py
Expand Down
2 changes: 1 addition & 1 deletion examples/run_github.py
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
# Copyright (c) 2023 Airbyte, Inc., all rights reserved.
"""A simple test of AirbyteLib, using the Faker source connector.
"""A simple test of PyAirbyte, using the Faker source connector.
Usage (from PyAirbyte root directory):
> poetry run python ./examples/run_github.py
Expand Down
2 changes: 1 addition & 1 deletion examples/run_pokeapi.py
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
# Copyright (c) 2023 Airbyte, Inc., all rights reserved.
"""A simple test of AirbyteLib, using the PokeAPI source connector.
"""A simple test of PyAirbyte, using the PokeAPI source connector.
Usage (from PyAirbyte root directory):
> poetry run python ./examples/run_pokeapi.py
Expand Down

0 comments on commit 6d2e5b9

Please sign in to comment.