Skip to content

Commit

Permalink
more renames
Browse files Browse the repository at this point in the history
  • Loading branch information
aaronsteers committed Feb 16, 2024
1 parent 6d2e5b9 commit b461aa7
Show file tree
Hide file tree
Showing 2 changed files with 4 additions and 4 deletions.
2 changes: 1 addition & 1 deletion CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.

Expand Down
6 changes: 3 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
@@ -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

Expand Down Expand Up @@ -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.
Expand Down

0 comments on commit b461aa7

Please sign in to comment.