Skip to main content

Utilities to generate static data for Watchtower.

Project description

Watchtower

Follow these instructions to deploy Watchtower in your production pipeline.

Requirements

  • Python 3.9+
  • A working installation of Kitsu (optional)

In order to generate data for Watchtower, follow these steps:

  • Create a new folder, step into it and run:
  • python -m venv .venv
  • source .venv/bin/activate
  • pip install watchtower-pipeline

Setup 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

Setup with Kitsu-sourced data

If you have a working Kitsu (and Zou) install 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

Setup with custom-sourced data

If you use a different production/asset tracking service, some scripting will be required. The following steps are recommended:

  • Set up a new Python project (using virtualenv)
  • Run pip install watchtower-pipeline
  • Check docs/custom-sources.md for how to use the watchtower_pipeline module

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-0.1.7.tar.gz (260.8 kB view details)

Uploaded Source

Built Distribution

watchtower_pipeline-0.1.7-py3-none-any.whl (263.9 kB view details)

Uploaded Python 3

File details

Details for the file watchtower-pipeline-0.1.7.tar.gz.

File metadata

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

File hashes

Hashes for watchtower-pipeline-0.1.7.tar.gz
Algorithm Hash digest
SHA256 e540839be270902a82ce85ef64e480fdfa25ea1d60186ddac3e8063e439e6fec
MD5 06da86ee0bb3e70c36a809d5153379f6
BLAKE2b-256 9ff3c54b8c14b87ca18b6f57f79f039e185066159bb9e0d2626046ef6ad46ace

See more details on using hashes here.

File details

Details for the file watchtower_pipeline-0.1.7-py3-none-any.whl.

File metadata

File hashes

Hashes for watchtower_pipeline-0.1.7-py3-none-any.whl
Algorithm Hash digest
SHA256 07151eb6c86cbd60d82d10a3916588739b33aede87e29f35c7c01e8e931139b0
MD5 e02ca3829296f25a6b45e3cb1db876c5
BLAKE2b-256 dc01538874421adcf7574f75665494c2075471056f50ace9d25296f8206121df

See more details on using hashes here.

Supported by

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