Mewbot Developers Tools (https://github.com/mewbotorg)
Project description
mewbot-dev-tools
Tools to aid with mewbot development.
Purpose
While developing mewbot we built a number of tools to assist with development. This mostly consist of tool chains for
- running the linters
- building dev venvs (still forthcoming)
- building the docs (still forthcoming)
- gather and run the tests
The aim of these tools is that, if you run them on a code base, you should end up with something which conforms to mewbot's guidelines.
Usage
The dev tools uses path based auto-discovery to locate the relevant code.
Python modules will be discovered in ./src
and ./plugins/*/src
.
Test cases will be discovered in ./tests
and ./plugins/*/tests
.
If your project is in that src-dir
layout, you can install the dev tools
and then run any of the toolchains.
pip install mewbot-dev-tools
mewbot-install-deps # Install dependencies from discovered requirements.txt
mewbot-preflight # Run all of the toolchains below
mewbot-lint # Code style and type linting, using black/flake/ruff/mypy/pylint
mewbot-reuse # Licensing information check, using reuse
mewbot-test # Run discovered test suites, using pytest
mewbot-security-analysis # Discover potential security bugs using badnit
mewbot-annotate # Convert output data into GitHub annotations
We also recommend that you setup mewbot-prefilght
as a
pre-commit or pre-push hook.
Future Work
- Ability to opt-out for some linters in pyproject.toml
- Work to discover locations based on pyproject.toml
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 mewbot_dev_tools-0.0.15.dev5.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | fd2a927a9433a3987ffcef25e5e0118affc9c720b8b3039b71f0e0f7454b5d12 |
|
MD5 | 314a01c6ad14110aefe16e37402179ef |
|
BLAKE2b-256 | 545d35bc9bdf8a10f891d645b3962882e93141968ee6c85793777726e031b4b1 |
Hashes for mewbot_dev_tools-0.0.15.dev5-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 4c8660af4467558bf8176dd9ec2e4e39be22c85174f3eebad140276326a4b923 |
|
MD5 | eb094bd9b85c092ff9f857b92387ba26 |
|
BLAKE2b-256 | 50677b4162b6794cd44600c41cdef52a07a893c0829a739f031a59b4c1e85643 |