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.0b1.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 4b608faf1d79ad688850688a0347ddf38927222e83f652d074afbc22ee659432 |
|
MD5 | 8abc3504e867c45aa2eef39b0e27e990 |
|
BLAKE2b-256 | 413403d2f4de080349bba0bc01afc4b071109521b4cf17665f0e18803126ca95 |
Hashes for watchtower_pipeline-1.0.0b1-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 1fba7f14db66aa4b602f64149fd1d7a954e3078e6d86184f7a6f05be20f533d9 |
|
MD5 | 2144a699d4e90e4fab8d6f6bdb482695 |
|
BLAKE2b-256 | 844833a02f7b016edb45265af2939f9c42ee07aadcfa0cf6b8b432229a9fdcee |