All the details you need before participating with us.
OperationCode PyBot is a Python Slack Bot extending Pyslacker's sir-bot-a-lot framework.
Bug reports and pull requests are welcome on Github. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the Contributor Covenant code of conduct. If you wish to assist, join the #oc-python-projects rewrite to learn how to contribute.
Recommended versions of tools used within the repo:
python@3.7
or greater (in some environments, you may need to specify version of python i.e.python test.py
vspython3 test.py
))git@2.17.1
or greaterpoetry@0.12.11
or greater- Poetry is a packaging and dependency manager, similar to pip or pipenv
- Poetry provides a custom installer that can be ran via
curl -sSL https://raw.githubusercontent.com/sdispater/poetry/master/get-poetry.py | python
- Alternatively, poetry can be installed via pip/pip3 with
pip install --user poetry
orpip3 install --user poetry
- See https://poetry.eustace.io/docs/
# Install dependencies (ensure poetry is already installed)
poetry install
# Run local development
poetry run python -m pybot
# Run testing suite
poetry run pytest
# Run formatting and linting
poetry run black .
# the next line shouldn't output anything to the terminal if it passes
poetry run flake8
poetry run isort -rc .
This package is available as open source under the terms of the MIT License.