Utilities to generate static data for Watchtower.
Project description
Watchtower Pipeline
A Python package to generate data to be displayed in Watchtower.
Follow these instructions to deploy Watchtower in your production pipeline.
Requirements
- Python 3.9+
- A source of production data (shots, assets, tasks, etc.)
Setup
- Create a new folder, step into it and run:
python -m venv .venv
source .venv/bin/activate
pip install watchtower-pipeline
... with example data
To create an example project that will give you an idea of how the pipeline works:
- Run
python -m watchtower_pipeline.example -b
- Navigate to the
watchtower
folder and runpython -m http.server
... with Kitsu-sourced data
If you have a working Kitsu (and Zou) installation and want to extract and visualize data from it:
-
Create a
.env.local
file as follows:KITSU_DATA_SOURCE_URL=https://<your-kitsu-instance>/api KITSU_DATA_SOURCE_USER_EMAIL=user@example.org KITSU_DATA_SOURCE_USER_PASSWORD=password
-
Run
python -m watchtower_pipeline.kitsu -b
-
Copy the content of the
watchtower
folder into your webserver -
Running the command without the
-b
flag will only fetch the data, and place it in a directory calledpublic/data
, which can then be synced to where thewatchtower
folder has been placed.
... with custom-sourced data
If you use a different production/asset tracking service, some scripting will be required.
Check docs/integration.md
and docs/develop-pipeline.md
.
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for watchtower_pipeline-1.0.0b2.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | f63429b9843625d0cdf47600c211891d869f1df6f22fd1470d603336c6495c72 |
|
MD5 | 6ab2951fe331d3b791c320b5a05aa021 |
|
BLAKE2b-256 | 722c3c7b4943bf2b5dd18bef1565c29fc898b8db563a306ec73d792c3e21a0be |
Hashes for watchtower_pipeline-1.0.0b2-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 0274648657f67c540ed3ec316ce2ae60afc2e070ed2793260e3fbf5ba8dc1e7f |
|
MD5 | 9eae618daaeab076d32a35105efbb8ca |
|
BLAKE2b-256 | dab1fbbd5885a8a48ccf29244c37e036f8099235efe50d493c973e2d154c3743 |