bitbot-3.11-fork/README.md

33 lines
1.5 KiB
Markdown

# BitBot
Python3 event-driven modular IRC bot!
## Requirements
Python3.6+ and [BeautifulSoup4](https://pypi.python.org/pypi/beautifulsoup4), [netifaces](https://pypi.org/project/netifaces/), [requests](https://pypi.org/project/requests/), [scrypt](https://pypi.python.org/pypi/scrypt), [suds](https://pypi.python.org/pypi/suds-jurko) and [tweepy](https://pypi.org/project/tweepy/). Use `pip3 install -r requirements.txt` to install them all at once.
## Setup
See [docs/help/setup.md](docs/help/setup.md).
## Github web hooks
I run BitBot as-a-service on most popular networks and offer github-to-IRC web hook notifications for free to FOSS projects. Contact me for more information!
## Contact/Support
Come say hi at [#bitbot on freenode](https://webchat.freenode.net/?channels=#bitbot)
## License
```
Copyright (C) 2019 jesopo <contact@jesopo.uk> - https://github.com/jesopo/bitbot
This program is free software; you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation; either version 2 of the License, or
(at your option) any later version.
This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU General Public License for more details.
You should have received a copy of the GNU General Public License along
with this program; if not, write to the Free Software Foundation, Inc.,
51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
```