README.md

CVE Bot: Telegram bot that notifies about package update linked with CVE

Try it out!

Key Features

• Frequent DB update
• Get actual info based on CVE number or Package name
• Subscribe to update at any number of CVEs

Technical Requirements/Installation

Pre-requirements

Install Python 3.10, and pip package management tool.

Development Status

CVE Bot is in active development and accepts contributions. See our Contributing section below for more details.

We report new releases information here.

How to contribute

Fork, clone, setup development environment. No third-party build or test tools need to be installed at your system.

python3 -m venv .venv
. ./.venv/bin/activate
pip install setuptools wheel
pip install -e '.[dev]'

After that you'll have cve_bot and all development tools installed into virtualenv. Refer to config to set proper env vars for development. Actually the minimum required is CVE_BOT_TOKEN with your token Hack, then make PR. Don't forget to write unit tests, and check your code:

flake8 cve_bot
isort -c cve_bot
black --check cve_bot
pytest --cov

Or you can just install git-hooks

Git hooks

ln -s -r -t ./.git/hooks/ ./hooks/*

License

MIT, see LICENSE.