Skip to content

Commit

Permalink
updating docs
Browse files Browse the repository at this point in the history
  • Loading branch information
mistercrunch committed Mar 13, 2024
1 parent 5811e07 commit 4ed3387
Show file tree
Hide file tree
Showing 3 changed files with 8 additions and 12 deletions.
3 changes: 0 additions & 3 deletions .github/workflows/superset-python-presto-hive.yml
Original file line number Diff line number Diff line change
Expand Up @@ -69,9 +69,6 @@ jobs:
- name: Setup Python
uses: ./.github/actions/setup-backend/
if: steps.check.outcome == 'failure'
- name: Setup Python
uses: ./.github/actions/setup-backend/
if: steps.check.outcome == 'failure'
- name: Run celery
if: steps.check.outcome == 'failure'
run: celery --app=superset.tasks.celery_app:app worker -Ofair -c 2 &
Expand Down
16 changes: 7 additions & 9 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -527,14 +527,12 @@ If you have made changes to the FAB-managed templates, which are not built the s
#### Dependencies

Python dependencies for Superset are managed in the `pyproject.toml` file along with resources
under the `requirements/` folder. `./requirements/pip-compile-superset.sh` acts a wrapper
under the `requirements/` folder. `./requirements/pip-compile-superset.py` acts a wrapper
for `pip-compile` - a neat utility that takes dependencies and pins them to create
deterministic set of dependency versions. `pip-compile-superset.sh` compiles two requirements
deterministic set of dependency versions. `pip-compile-superset.py` compiles two requirements
file: `requirements/base.txt` as the core, required dependencies for Superset, and
`requirements/development.txt` which contains the same set plus everything that's needed
for development, testing, docker and beyond. Note that passing arguments to
`pip-compile-superset.sh` passes them down to `pip-compile` allowing for the operations defined
bellow.
for development, testing, docker and beyond.

Note that we rely on [dependabot](https://github.com/dependabot)
to auto-submit PRs upgrading our libraries periodically. This enables us to bump and
Expand All @@ -551,17 +549,17 @@ pip install -r requirements/development.txt
# EDIT pyproject.toml, set the version range
# usually something like `newlib>={current}<{next_major}`, as in `flask>=3.2.1,<4.0.0`

# recompile/pin the dependencies
./requirements/pip-compile-superset.sh --no-upgrade
# recompile/pin the dependencies, telling pip-compile NOT to upgrade everything else
./requirements/pip-compile-superset.py compile-deps --pip-flags "--no-upgrade"

# AGAIN - make sure you're aligned with the pin deps
# AGAIN - let's make sure your environment is aligned with the pin deps
pip install -r requirements/development.txt
```

To upgrade the version of a single package:

```bash
$ ./requirements/pip-compile-superset.sh -P my-package
./requirements/pip-compile-superset.py compile-deps --pip-flags "-P some_package"
```

To bring all dependencies up to date as per the restrictions defined
Expand Down
1 change: 1 addition & 0 deletions requirements/pip-compile-superset.py
100644 → 100755
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
#!/usr/bin/env python
# Licensed to the Apache Software Foundation (ASF) under one
# or more contributor license agreements. See the NOTICE file
# distributed with this work for additional information
Expand Down

0 comments on commit 4ed3387

Please sign in to comment.