jarno
/
hemppa
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Merge pull request #82 from tswfi/RelaxPipenvPythonVersion 

Relax Pipfile python requirement.
This commit is contained in:
Ville Ranki 2020-05-21 22:01:41 +03:00 committed by GitHub
parent d59ea52204 6795db57c4
commit 7b44722850
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
2 changed files with 6 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

3
Pipfile
View File

@ -27,8 +27,5 @@ black = "*"
ipython = "*"
isort = "*"
[requires]
python_version = "3.7"
[pipenv]
allow_prereleases = true

10
README.md
View File

@ -293,9 +293,9 @@ Command:
API Key:
The module uses a demo API Key which can be replaced by your own api key by setting the environment variable `APOD_API_KEY` or by setting the api key as a bot owner with command `!apod apikey [apikey]`.
The module uses a demo API Key which can be replaced by your own api key by setting the environment variable `APOD_API_KEY` or by setting the api key as a bot owner with command `!apod apikey [apikey]`.
You can create one at https://api.nasa.gov/#signUp
You can create one at https://api.nasa.gov/#signUp
### Wolfram Alpha
@ -368,6 +368,8 @@ MATRIX_USER="@user:matrix.org" MATRIX_ACCESS_TOKEN="MDAxOGxvYlotofcharacters53Cg
python3 bot.py
```
NOTE: The Pipfile does not define the python version as it is always strict and causes problems. See https://github.com/pypa/pipenv/issues/1050 . Python 3.7 and 3.8 should both work fine.
## Running with Docker
Create .env file and set variables:
@ -444,7 +446,7 @@ You only need to implement the ones you need. See existing bots for examples.
### Logging
Uses [python logging facility](https://docs.python.org/3/library/logging.html) to print information to the console. Customize it to your needs editing `config/logging.yml`.
See [logging.config documentation](https://docs.python.org/3/library/logging.config.html) for further information.
See [logging.config documentation](https://docs.python.org/3/library/logging.config.html) for further information.
Use `self.logger` in your module to print information to the console.
@ -452,7 +454,7 @@ Module settings are stored in Matrix account data.
### Ignoring text messages
If you want to send a m.text message that bot should always ignore, set "org.vranki.hemppa.ignore" property in the event. Bot will ignore events with this set.
If you want to send a m.text message that bot should always ignore, set "org.vranki.hemppa.ignore" property in the event. Bot will ignore events with this set.
Set the bot_ignore parameter to True in sender functions to acheive this.
If you write a module that installs a custom message handler, use bot.should_ignore_event(event) to check if event should be ignored.