From b461aa76694510f5ed21683a1b6b282fc48f71ad Mon Sep 17 00:00:00 2001 From: Aaron Steers Date: Fri, 16 Feb 2024 10:36:37 -0800 Subject: [PATCH] more renames --- CONTRIBUTING.md | 2 +- README.md | 6 +++--- 2 files changed, 4 insertions(+), 4 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 1222b322..e2894d1d 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -19,7 +19,7 @@ To generate the documentation, run: poetry run generate-docs ``` -The `generate-docs` CLI command is mapped to the `run()` function of `docs.py` in the root `airbyte-lib` directory. +The `generate-docs` CLI command is mapped to the `run()` function of `docs/generate.py`. Documentation pages will be generated in the `docs/generated` folder. The `test_docs.py` test in pytest will automatically update generated content. This updates must be manually committed before docs tests will pass. diff --git a/README.md b/README.md index 9073c9af..bf3a0ec4 100644 --- a/README.md +++ b/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 requiring connectivity to a hosted Airbyte instance. ## Secrets Management @@ -32,7 +32,7 @@ By default, PyAirbyte will prompt the user for any requested secrets that are no ## 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.