bitbot-3.11-fork/README.md

# BitBot
Python3 event-driven modular IRC bot!

## Dependencies
* [BeautifulSoup4](https://pypi.python.org/pypi/beautifulsoup4)
* [Flask](https://pypi.org/project/Flask/)
* [requests](https://pypi.org/project/requests/)
* [scrypt](https://pypi.python.org/pypi/scrypt)
* [suds](https://pypi.python.org/pypi/suds-jurko)
* [twitter](https://pypi.python.org/pypi/twitter)

Use `pip3 install -r requirements.txt` to install them all at once.

## Configurating
To get BitBot off the ground, there's some API-keys and the like in bot.conf.example. move it to bot.conf, fill in the API keys you want (and remove the ones you don't want - this will automatically disable the modules that rely on them.)

## Github web hooks
I run BitBot as-a-serivce on most popular network and offer github-to-IRC web hook notifications for free to FOSS projects. Contact me for more info!

## Eagle
BitBot's National Rail module can optionally include output from Network Rail's SCHEDULE via [Eagle](https://github.com/EvelynSubarrow/Eagle). Configuration on BitBot's end is covered by the `eagle-` keys in bot.conf.example.

## Running
Just run `./start.py`

On first boot, he'll ask for a first server to connect to then exit. do `./start.py` again and he'll connect to that server and join #bitbot (to get him to join other channels, simply invite him to them.)

## Contact/Support
Come say hi at [##bitbot on freenode](https://webchat.freenode.net/?channels=##bitbot)
first commit. 2016-03-29 11:56:58 +00:00			`# BitBot`
			`Python3 event-driven modular IRC bot!`

			`## Dependencies`
added permissions.py which contains code for identifying/registering/logouting users. updated README.md to reflect the newly required scrypt module. 2016-04-04 17:42:37 +00:00			`* [BeautifulSoup4](https://pypi.python.org/pypi/beautifulsoup4)`
Flask is a dependency! 2018-11-30 20:32:31 +00:00			`* [Flask](https://pypi.org/project/Flask/)`
Add requests to README.md dependencies 2018-10-10 13:43:44 +00:00			`* [requests](https://pypi.org/project/requests/)`
added permissions.py which contains code for identifying/registering/logouting users. updated README.md to reflect the newly required scrypt module. 2016-04-04 17:42:37 +00:00			`* [scrypt](https://pypi.python.org/pypi/scrypt)`
corrected suds pypi link 2016-10-23 14:45:06 +00:00			`* [suds](https://pypi.python.org/pypi/suds-jurko)`
Add `pip3 install -r requirements.txt` to README.md 2018-09-24 14:37:35 +00:00			`* [twitter](https://pypi.python.org/pypi/twitter)`

			Use `pip3 install -r requirements.txt` to install them all at once.
first commit. 2016-03-29 11:56:58 +00:00
			`## Configurating`
switch to using configparser for config files 2018-07-15 23:36:52 +00:00			`To get BitBot off the ground, there's some API-keys and the like in bot.conf.example. move it to bot.conf, fill in the API keys you want (and remove the ones you don't want - this will automatically disable the modules that rely on them.)`
first commit. 2016-03-29 11:56:58 +00:00
Add section about github web hooks to README.md 2019-01-19 15:56:10 +00:00			`## Github web hooks`
			`I run BitBot as-a-serivce on most popular network and offer github-to-IRC web hook notifications for free to FOSS projects. Contact me for more info!`

Note Eagle in readme 2017-09-01 11:44:38 +00:00			`## Eagle`
switch to using configparser for config files 2018-07-15 23:36:52 +00:00			BitBot's National Rail module can optionally include output from Network Rail's SCHEDULE via [Eagle](https://github.com/EvelynSubarrow/Eagle). Configuration on BitBot's end is covered by the `eagle-` keys in bot.conf.example.
Note Eagle in readme 2017-09-01 11:44:38 +00:00
first commit. 2016-03-29 11:56:58 +00:00			`## Running`
			Just run `./start.py`

added a little more to README.md. 2016-03-29 13:40:56 +00:00			On first boot, he'll ask for a first server to connect to then exit. do `./start.py` again and he'll connect to that server and join #bitbot (to get him to join other channels, simply invite him to them.)
Add link to irc.freenode.net##bitbot to README.md 2018-10-26 10:38:46 +00:00
			`## Contact/Support`
Use a link to freenode's webchat in README.md 2018-11-12 12:25:14 +00:00			`Come say hi at [##bitbot on freenode](https://webchat.freenode.net/?channels=##bitbot)`