getredash / redash-toolbelt

API client and utilities to manage a Redash instance
BSD 2-Clause "Simplified" License
140 stars 74 forks source link

Unclear how to run the examples #34

Open frankiesimon opened 4 years ago

frankiesimon commented 4 years ago

I think the README.md can be more helpful on how to actually make use of the toolbelt.

I cloned the repo, installed poetry, ran poetry install but this failed because the lock file is probably out of date.

Creating virtualenv redash-toolbelt-KQO_4Cgq-py3.7 in /Users/frankie/Library/Caches/pypoetry/virtualenvs
Installing dependencies from lock file
Warning: The lock file is not up to date with the latest changes in pyproject.toml. You may be getting outdated dependencies. Run update to update them.

[SolverProblemError]
Because redash-toolbelt depends on click (^7.0) which doesn't match any versions, version solving failed.

I ran poetry update and poetry install worked but it took me a while longer to figure out I need to run with poetry run python redash_toolbelt/examples/gdpr_scrub.py.

If this is the right path I think the lock file and the readme should be updated.