Skip to content

Commit

Permalink
docs(ingest): update metadata-ingestion dev guide (#12779)
Browse files Browse the repository at this point in the history
  • Loading branch information
hsheth2 authored Mar 7, 2025
1 parent a51713a commit 8ff905f
Showing 1 changed file with 5 additions and 8 deletions.
13 changes: 5 additions & 8 deletions metadata-ingestion/developing.md
Original file line number Diff line number Diff line change
Expand Up @@ -155,8 +155,8 @@ Instead, we recommend using UI-based ingestion or isolating the ingestion pipeli
The syntax for installing plugins is slightly different in development. For example:

```diff
- pip install 'acryl-datahub[bigquery,datahub-rest]'
+ pip install -e '.[bigquery,datahub-rest]'
- uv pip install 'acryl-datahub[bigquery,datahub-rest]'
+ uv pip install -e '.[bigquery,datahub-rest]'
```

## Architecture
Expand All @@ -180,7 +180,7 @@ The architecture of this metadata ingestion framework is heavily inspired by [Ap
We use ruff, and mypy to ensure consistent code style and quality.

```shell
# Assumes: pip install -e '.[dev]' and venv is activated
# Assumes: ../gradlew :metadata-ingestion:installDev and venv is activated
ruff check src/ tests/
mypy src/ tests/
```
Expand Down Expand Up @@ -247,11 +247,8 @@ In order to ensure that the configs are consistent and easy to use, we have a fe
```shell
# Follow standard install from source procedure - see above.

# Install, including all dev requirements.
pip install -e '.[dev]'

# For running integration tests, you can use
pip install -e '.[integration-tests]'
# Install all dev and test requirements.
../gradlew :metadata-ingestion:installDevTest

# Run the full testing suite
pytest -vv
Expand Down

0 comments on commit 8ff905f

Please sign in to comment.