Generated from aind-library-template
Project description
aind-alert-utils
Usage
To send an alert to MS Teams. You'll need to create a channel on Teams with an alert hook url.
import requests
from aind_alert_utils.teams import create_body_contents
teams_channel_url = "paste your url here"
message_text = "I am a bold font message"
message_extra_text = "I am an optional text message. I can be None."
# Create the json request
post_request_contents = create_body_contents(
message=message_text, extra_text=message_extra_text
)
response = requests.post(teams_channel_url, json=post_request_contents)
# Check the response status code or raise an error if desired
print(response.status_code)
# response.raise_for_status()
Installation
To use the software, in the root directory, run
pip install -e .
To develop the code, run
pip install -e .[dev]
Contributing
Linters and testing
There are several libraries used to run linters, check documentation, and run tests.
- Please test your changes using the coverage library, which will run the tests and log a coverage report:
coverage run -m unittest discover && coverage report
- Use interrogate to check that modules, methods, etc. have been documented thoroughly:
interrogate .
- Use flake8 to check that code is up to standards (no unused imports, etc.):
flake8 .
- Use black to automatically format the code into PEP standards:
black .
- Use isort to automatically sort import statements:
isort .
Pull requests
For internal members, please create a branch. For external members, please fork the repository and open a pull request from the fork. We'll primarily use Angular style for commit messages. Roughly, they should follow the pattern:
<type>(<scope>): <short summary>
where scope (optional) describes the packages affected by the code changes and type (mandatory) is one of:
- build: Changes that affect build tools or external dependencies (example scopes: pyproject.toml, setup.py)
- ci: Changes to our CI configuration files and scripts (examples: .github/workflows/ci.yml)
- docs: Documentation only changes
- feat: A new feature
- fix: A bugfix
- perf: A code change that improves performance
- refactor: A code change that neither fixes a bug nor adds a feature
- test: Adding missing tests or correcting existing tests
Semantic Release
The table below, from semantic release, shows which commit message gets you which release type when semantic-release
runs (using the default configuration):
Commit message | Release type |
---|---|
fix(pencil): stop graphite breaking when too much pressure applied |
|
feat(pencil): add 'graphiteWidth' option |
|
perf(pencil): remove graphiteWidth option BREAKING CHANGE: The graphiteWidth option has been removed. The default graphite width of 10mm is always used for performance reasons. |
(Note that the BREAKING CHANGE: token must be in the footer of the commit) |
Documentation
To generate the rst files source files for documentation, run
sphinx-apidoc -o docs/source/ src
Then to create the documentation HTML files, run
sphinx-build -b html docs/source/ docs/build/html
More info on sphinx installation can be found here.
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for aind_alert_utils-0.1.2-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | f8a8ed75b84522b599b0843532f0881051c29f3ba91d73a99e5354e152be3a57 |
|
MD5 | 0374c912624ef6c3221a56c251c6fa40 |
|
BLAKE2b-256 | 65af3bf2677794176c2f98543bb0784a3f155ea116026a76293fe073c3727caa |