h-periodic

Celery beat processes for Hypothesis apps.

Setting up Your h-periodic Development Environment

First you'll need to install:

• Git. On Ubuntu: sudo apt install git, on macOS: brew install git.
• GNU Make. This is probably already installed, run make --version to check.
• pyenv. Follow the instructions in pyenv's README to install it. The Homebrew method works best on macOS. The Basic GitHub Checkout method works best on Ubuntu. You don't need to set up pyenv's shell integration ("shims"), you can use pyenv without shims.

Then to set up your development environment:

git clone https://github.com/hypothesis/h-periodic.git
cd h-periodic
make help

Changing the Project's Python Version

To change what version of Python the project uses:

1. Change the Python version in the cookiecutter.json file. For example:

   "python_version": "3.10.4",

2. Re-run the cookiecutter template:

   make template
   

3. Re-compile the requirements/*.txt files. This is necessary because the same requirements/*.in file can compile to different requirements/*.txt files in different versions of Python:

   make requirements
   

4. Commit everything to git and send a pull request

Changing the Project's Python Dependencies

To Add a New Dependency

Add the package to the appropriate requirements/*.in file(s) and then run:

make requirements

To Remove a Dependency

Remove the package from the appropriate requirements/*.in file(s) and then run:

make requirements

To Upgrade or Downgrade a Dependency

We rely on Dependabot to keep all our dependencies up to date by sending automated pull requests to all our repos. But if you need to upgrade or downgrade a package manually you can do that locally.

To upgrade a package to the latest version in all requirements/*.txt files:

make requirements --always-make args='--upgrade-package <FOO>'

To upgrade or downgrade a package to a specific version:

make requirements --always-make args='--upgrade-package <FOO>==<X.Y.Z>'

To upgrade all packages to their latest versions:

make requirements --always-make args=--upgrade

Configuration

Environment variable	Usage	Example
H_BROKER_URL	The h AMPQ broker	amqp://user:[email protected]:5672//
CHECKMATE_BROKER_URL	The checkmate AMPQ broker	amqp://user:[email protected]:5673//
LMS_BROKER_URL	The LMS AMPQ broker	amqp://user:[email protected]:5674//
DISABLE_H_BEAT	Whether to disable the h_beat process	true to disable the h_beat process, false to leave it enabled. Defaults to false (leave it enabled)
DISABLE_CHECKMATE_BEAT	Whether to disable the checkmate_beat process	true to disable the checkmate_beat process, false to leave it enabled. Defaults to false (leave it enabled)
DISABLE_LMS_BEAT	Whether to disable the lms_beat process	true to disable, false to leave it enabled. Defaults to false (leave it enabled)