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.0b0.tar.gz (306.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.0b0-py3-none-any.whl (310.8 kB view details)

Uploaded Python 3

File details

Details for the file watchtower-pipeline-1.0.0b0.tar.gz.

File metadata

  • Download URL: watchtower-pipeline-1.0.0b0.tar.gz
  • Upload date:
  • Size: 306.3 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.1.12 CPython/3.9.9 Darwin/22.5.0

File hashes

Hashes for watchtower-pipeline-1.0.0b0.tar.gz
Algorithm Hash digest
SHA256 63e40caf6e3766e569b3e4d92b0d0b579898065c03e90a6b39a7745a23a1c46d
MD5 87dbc040386a2fb38d64c1bfbb2672f4
BLAKE2b-256 83f555f3e65f73cdd71dbd52300a6abadc893ecf908c93daa22ff2ce4a170ed9

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for watchtower_pipeline-1.0.0b0-py3-none-any.whl
Algorithm Hash digest
SHA256 1710b920bb0da6a84016cebcb08c1cee53c80ae9ac7ffbad11dc08ffb6c8989b
MD5 d9838bb7cdca4a29a56601a1fe55c201
BLAKE2b-256 99a1ce1b861df1543980a895f33a01acda7ae93b853a35c2038623facc324286

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