tobast/matrix-alertbot
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Update README to match module style

Browse source
This commit is contained in:
Andrew Morgan 2020-08-06 17:16:46 -07:00 committed by Andrew Morgan
parent 8af9655620
commit c14b158326
1 changed files with 21 additions and 8 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

29
README.md
View file

@ -18,12 +18,32 @@ post historical, weekly art challenges from reddit to a room
extended by plugins extended by plugins
* [gracchus163/hopeless](https://github.com/gracchus163/hopeless) - COREbot for the Hope2020 conference Matrix server * [gracchus163/hopeless](https://github.com/gracchus163/hopeless) - COREbot for the Hope2020 conference Matrix server
Want your project listed here? [Edit this Want your project listed here? [Edit this
doc!](https://github.com/anoadragon453/nio-template/edit/master/README.md) doc!](https://github.com/anoadragon453/nio-template/edit/master/README.md)
## Project structure ## Project structure
The majority of the code is kept inside of the `my_project_name` folder, which
is in itself a [python package](https://docs.python.org/3/tutorial/modules.html),
the `__init__.py` file inside declaring it as such.
To run the bot, the `my-project-name` script in the root of the codebase is
available. It will import the `main` function from `main.py` file in the
package and run it. To properly install this script into your python environment,
run `pip install -e .` in the project's root directory.
`setup.py` contains package information (for publishing your code to
[PyPI](https://pypi.org)) and `setup.cfg` just contains some configuration
options for linting tools.
`sample.config.yaml` is a sample configuration file. People running your bot
should be advised to copy this file to `config.yaml`, then edit it according to
their needs. Be sure never to check the edited `config.yaml` into source control
since it'll likely contain sensitive details such as passwords!
Below is a detailed description of each of the source code files contained within
the `my_project_name` directory:
### `main.py` ### `main.py`
Initialises the config file, the bot store, and nio's AsyncClient (which is Initialises the config file, the bot store, and nio's AsyncClient (which is
@ -110,13 +130,6 @@ method for sending formatted messages to a room.
Custom error types for the bot. Currently there's only one special type that's Custom error types for the bot. Currently there's only one special type that's
defined for when a error is found while the config file is being processed. defined for when a error is found while the config file is being processed.
### `sample.config.yaml`
The sample configuration file. People running your bot should be advised to
copy this file to `config.yaml`, then edit it according to their needs. Be sure
never to check the edited `config.yaml` into source control since it'll likely
contain sensitive details like passwords!
## Questions? ## Questions?
Any questions? Ask in Any questions? Ask in