coasti-superset-io 0.1.0

Add your description here

Superset Import/Export

Convenience-wrapper around superset's REST API to download and upload snapshots of all assets.

Getting Started

1. Install uv
2. Install Superset IO as tool

# macOS, Linux
curl -LsSf https://astral.sh/uv/install.sh | sh

# Windows
powershell -ExecutionPolicy ByPass -c "irm https://astral.sh/uv/install.ps1 | iex"


# uv tool provides global cli, creates an isolated environment
uv tool install git+https://github.com/linkFISH-Consulting/coasti_superset_io

Contribution

1. Install the required dependencies (including dev, test dependencies and all optional dependencies)

uv sync --all-groups --all-extras

2. Make your changes in a new branch.

git checkout -b my-feature-branch

• Write code
• Add or update tests as needed
• Update documentation if your changes affect the public API

3. Ensure code meets quality standards.

# Activate the virtual environment first
source ./.venv/bin/activate

# Check code style and formatting
ruff check . --fix
ruff format .

# Run type checking
mypy .

If this looks tedious you may alternatively install the pre-commit hooks to automatically enforce code quality standards before each commit (this runs the commands above automatically).

# Install the git hooks
pre-commit install

Once installed, every git commit will trigger automatic formatting with ruff, type checking with mypy, and linting. If you need to skip these checks (e.g., for a work-in-progress commit), use git commit --no-verify.

4. Make sure all tests run successfully

pytest

Optionally you can make sure the integrations tests also running successfully. This needs docker compose to be installed on the system.

# Either let pytest stop start the container
pytest --integration
# Or do it manually
cd ./tests/integration
docker compose up
pytest --integration

5. Commit your changes with clear messages.

git add .
git commit -m "Add feature X"