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.0b3.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | da6cafdeebbe9a4b06e1075a3ad86cbc4a16ace16f2378a2f0130f6d6dbd0b2a |
|
MD5 | 1efd469ba67efc44eba8bdc990b44d8b |
|
BLAKE2b-256 | dffa619dcc330374483fe5a252c66c8d9180fc23012aa33ad0a98d2a6afddc88 |
Hashes for watchtower_pipeline-1.0.0b3-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 83838d94799d1d6603ec55a9ecbcf7562267b12e6530706bd69e9c55b2dacd1f |
|
MD5 | aa4973b3edd5ba06e389e0a53220e9a2 |
|
BLAKE2b-256 | f089ab98744fc92fd4b640e687854cf81991cdcfa90400a332c6af25abfff907 |