From c14b158326edeb6024d7994e5ddbdd2165e4f317 Mon Sep 17 00:00:00 2001 From: Andrew Morgan Date: Thu, 6 Aug 2020 17:16:46 -0700 Subject: [PATCH] Update README to match module style --- README.md | 29 +++++++++++++++++++++-------- 1 file changed, 21 insertions(+), 8 deletions(-) diff --git a/README.md b/README.md index 0396150..5241a64 100644 --- a/README.md +++ b/README.md @@ -18,12 +18,32 @@ post historical, weekly art challenges from reddit to a room extended by plugins * [gracchus163/hopeless](https://github.com/gracchus163/hopeless) - COREbot for the Hope2020 conference Matrix server - Want your project listed here? [Edit this doc!](https://github.com/anoadragon453/nio-template/edit/master/README.md) ## 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` 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 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? Any questions? Ask in