Merge pull request #743 from blacklanternsecurity/pre-commit

Use Pre-commit

docs/contribution.md

@@ -13,13 +13,16 @@ We welcome contributions! If you have an idea for a new module, or are a Python
 
 ```bash
 # clone your forked repo and cd into it
-git clone [email protected]/<username>/bbot.git && cd bbot
+git clone [email protected]/<username>/bbot.git
+cd bbot
 
 # install poetry
 curl -sSL https://install.python-poetry.org | python3 -
 
 # install pip dependencies
 poetry install
+# install pre-commit hooks, etc.
+poetry run pre-commit install
 
 # enter virtual environment
 poetry shell
@@ -28,12 +31,7 @@ bbot --help
 ```
 
 - Now, any changes you make in the code will be reflected in the `bbot` command.
-- Run the tests locally to ensure they pass.
-- Finally, commit and push your changes, and create a pull request to the `dev` branch of the main BBOT repo.
-
-## Running Tests
-
-BBOT makes use of pytest for its unit testing. You can run the tests simply by executing the bash script at `bbot/test/run_tests.sh`:
+- After making your changes, run the tests locally to ensure they pass.
 
 ```bash
 # auto-format code indentation, etc.
@@ -43,6 +41,9 @@ black .
 ./bbot/test/run_tests.sh
 ```
 
+- Finally, commit and push your changes, and create a pull request to the `dev` branch of the main BBOT repo.
+
+
 ## Creating a Module
 
 Writing a module is easy and requires only a basic understanding of Python. It consists of a few steps:

pyproject.toml

@@ -62,6 +62,7 @@ pytest-env = "^0.8.2"
 pytest-httpx = "^0.22.0"
 pytest-timeout = "^2.1.0"
 pytest = "^7.4.0"
+pre-commit = "^3.4.0"
 
 [tool.pytest.ini_options]
 env = [