slack-annotations

This repo contains a Python script (slack-annotations) that fetches annotations from the Hypothesis API and prints them out in a Slack-compatible format, and a GitHub Actions workflow that runs periodically and posts new annotations into a Slack channel.

Installing

We recommend using pipx to install slack-annotations. First install pipx then run:

pipx install git+https://github.com/hypothesis/slack-annotations.git

You now have slack-annotations installed! For some help run:

slack-annotations --help

Upgrading

To upgrade to the latest version run:

pipx upgrade slack-annotations

To see what version you have run:

slack-annotations --version

Uninstalling

To uninstall run:

pipx uninstall slack-annotations

Setting up Your slack-annotations 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/slack-annotations.git
cd slack-annotations
make help

Changing the Project's Python Versions

To change what versions of Python the project uses:

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

   "python_versions": "3.10.4, 3.9.12",

2. Re-run the cookiecutter template:

   make template
   

3. Commit everything to git and send a pull request

Changing the Project's Python Dependencies

To change the production dependencies in the setup.cfg file:

1. Change the dependencies in the .cookiecutter/includes/setuptools/install_requires file. If this file doesn't exist yet create it and add some dependencies to it. For example:

   pyramid
   sqlalchemy
   celery
   

2. Re-run the cookiecutter template:

   make template
   

3. Commit everything to git and send a pull request

To change the project's formatting, linting and test dependencies:

1. Change the dependencies in the .cookiecutter/includes/tox/deps file. If this file doesn't exist yet create it and add some dependencies to it. Use tox's factor-conditional settings to limit which environment(s) each dependency is used in. For example:

   lint: flake8,
   format: autopep8,
   lint,tests: pytest-faker,
   

2. Re-run the cookiecutter template:

   make template
   

3. Commit everything to git and send a pull request