diff --git a/data-scripts/Pipfile b/data-scripts/Pipfile new file mode 100644 index 00000000..fdf5e358 --- /dev/null +++ b/data-scripts/Pipfile @@ -0,0 +1,16 @@ +[[source]] +url = "https://pypi.org/simple" +verify_ssl = true +name = "pypi" + +[packages] +contentful-management = "~=2.14" +click = "~=8.2" +petl = "~=1.7" +ratelimit = "~=2.2" +tqdm = "~=4.67" + +[dev-packages] + +[requires] +python_version = "3.10" diff --git a/data-scripts/README.md b/data-scripts/README.md index 6c56c531..51692cbe 100644 --- a/data-scripts/README.md +++ b/data-scripts/README.md @@ -2,6 +2,26 @@ Handy little python scripts to clean and merge voter turnout and registration data. Also a script to migrate content. +You should use the `pipenv` command to install the dependencies. +Install that with a package manager or `pip install pipenv`. + +After you have pipenv, change in to this data-scripts directory and +run `pipenv install` + +To run the commands, use a pipenv shell like: + +``` +pipenv shell +python cli.py +``` + +or the run command: +``` +pipenv run python cli.py +``` + +## Available commands + ``` Usage: cli.py [OPTIONS] COMMAND [ARGS]...