https://github.com/local-connectivity-lab/netbot
community NETwork discord BOT, for integrating network management functions
https://github.com/local-connectivity-lab/netbot
Last synced: 10 months ago
JSON representation
community NETwork discord BOT, for integrating network management functions
- Host: GitHub
- URL: https://github.com/local-connectivity-lab/netbot
- Owner: Local-Connectivity-Lab
- License: mit
- Created: 2023-08-23T17:04:29.000Z (almost 3 years ago)
- Default Branch: main
- Last Pushed: 2025-07-31T19:50:43.000Z (11 months ago)
- Last Synced: 2025-07-31T22:43:48.116Z (11 months ago)
- Language: Python
- Size: 3.1 MB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# netbot
## community **NET**work discord **BOT**, for integrating network management functions
[](https://github.com/philion/netbot/actions/workflows/python-app.yml)
A collection of Seattle Community Network ([SCN](https://seattlecommunitynetwork.org/)) tools, including:
* **`threader`**: SCN's email threading service to collect and categorize SCN messages.
* **`netbot`**: SCN's Discord bot to manage Redmine tickets from Discord.
* **`redmine`**: A Redmine client written in Python, designed for SCN use cases.
This code base currently supports several different services due to the reliance on the Redmine client code. (In the future, this should be split into several projects, and redmine.py cleaned up and submitted to PyPI.)
## threader
The email threader functionality is implemented in `threader.py`, is designed to run periodically as a cron job.
For design and implementation details, see [Design](docs/design.md).
For deployment and operational details, see [Threader Operation](docs/threader.md).
## netbot
The netbot functionality is implemented in `netbot.py` (and supporting `cog_*.py` implementations), is designed to run in as a container using a standard `compose.yaml` file.
For design and implementation details, see [Design](docs/design.md).
For deployment and operational details, see [Netbot Operation](docs/netbot.md).
## Development
A `Makefile` is provided with the following targets:
- `venv` : build a Python virtual environment ("venv")
- `run` : run netbot
- `test` : run the unit test suite
- `coverage` : run the unit tests and generate a minimal coverage report
- `htmlcov` : run the unit tests and generate a full report in htmlcov/
Testing and coverage requires standing up a local testbed. For details, see [Design](docs/design.md).