Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/hypothesis/slack-annotations
Post annotations to Slack.
https://github.com/hypothesis/slack-annotations
slack
Last synced: 1 day ago
JSON representation
Post annotations to Slack.
- Host: GitHub
- URL: https://github.com/hypothesis/slack-annotations
- Owner: hypothesis
- License: bsd-2-clause
- Created: 2024-11-06T14:08:01.000Z (2 days ago)
- Default Branch: main
- Last Pushed: 2024-11-06T15:28:57.000Z (1 day ago)
- Last Synced: 2024-11-06T15:29:24.273Z (1 day ago)
- Topics: slack
- Language: Python
- Homepage:
- Size: 18.6 KB
- Stars: 0
- Watchers: 3
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# 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](.github/workflows/notify.yml) that runs
periodically and posts new annotations into a Slack channel.
## Installing
We recommend using [pipx](https://pypa.github.io/pipx/) to install
slack-annotations.
First [install pipx](https://pypa.github.io/pipx/#install-pipx) then run:
```terminal
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:
```terminal
pipx upgrade slack-annotations
```
To see what version you have run:
```terminal
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](https://git-scm.com/).
On Ubuntu: `sudo apt install git`, on macOS: `brew install git`.
* [GNU Make](https://www.gnu.org/software/make/).
This is probably already installed, run `make --version` to check.
* [pyenv](https://github.com/pyenv/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](https://github.com/pyenv/pyenv#using-pyenv-without-shims).
Then to set up your development environment:
```terminal
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](.cookiecutter/cookiecutter.json) file. For example:
```json
"python_versions": "3.10.4, 3.9.12",
```
2. Re-run the cookiecutter template:
```terminal
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`](.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:
```terminal
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`](.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](https://tox.wiki/en/latest/config.html#factors-and-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:
```terminal
make template
```
3. Commit everything to git and send a pull request