Skip to main content

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 run python -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 called public/data, which can then be synced to where the watchtower 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


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

watchtower_pipeline-1.0.0b1.tar.gz (394.3 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

watchtower_pipeline-1.0.0b1-py3-none-any.whl (398.8 kB view details)

Uploaded Python 3

File details

Details for the file watchtower_pipeline-1.0.0b1.tar.gz.

File metadata

  • Download URL: watchtower_pipeline-1.0.0b1.tar.gz
  • Upload date:
  • Size: 394.3 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.7.1 CPython/3.11.2 Darwin/23.4.0

File hashes

Hashes for watchtower_pipeline-1.0.0b1.tar.gz
Algorithm Hash digest
SHA256 4b608faf1d79ad688850688a0347ddf38927222e83f652d074afbc22ee659432
MD5 8abc3504e867c45aa2eef39b0e27e990
BLAKE2b-256 413403d2f4de080349bba0bc01afc4b071109521b4cf17665f0e18803126ca95

See more details on using hashes here.

File details

Details for the file watchtower_pipeline-1.0.0b1-py3-none-any.whl.

File metadata

File hashes

Hashes for watchtower_pipeline-1.0.0b1-py3-none-any.whl
Algorithm Hash digest
SHA256 1fba7f14db66aa4b602f64149fd1d7a954e3078e6d86184f7a6f05be20f533d9
MD5 2144a699d4e90e4fab8d6f6bdb482695
BLAKE2b-256 844833a02f7b016edb45265af2939f9c42ee07aadcfa0cf6b8b432229a9fdcee

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page