Discord bot that helps you keep tabs on tropical cyclones.
Project description
CycloMonitor
Discord bot that automatically updates active TC information based on data from the ATCF.
Dependencies:
- py-cord
- aiohttp (provided by py-cord)
- tendo (Optional, for single-instance checking)
Disclaimer
No party involved with CycloMonitor should make any claim that this bot is intended to replace tropical cyclone advisories/warnings issued by your local RSMC or TCWC. If you need more detailed information than what is provided by the bot, see your local RSMC or TCWC website for forecasts, potential land impacts, or other relevant information.
Running the bot
Install the package:
pip install cyclomonitor
If you cloned the GitHub repository, you might want to install the package in dev mode:
cd cyclomonitor
pip install -e .
Optional: Install tendo
for single instance checking: pip install tendo
or pip install cyclomonitor[single-instance]
Some Linux distributions may require you to set up a virtual environment.
Until I get the project to use absolute paths, you'll probably want to create a separate directory to store its data:
mkdir cyclomonitor_temp
cd cyclomonitor_temp
To run the bot:
python3 -m cyclomonitor -b -t your.token.here
If you don't want to specify -t
every time, paste your bot's token into a file called TOKEN
in your working directory.
For full argument list: python3 -m cyclomonitor -h
or run the module with no arguments.
Windows users: You might want to replace python3
with python
.
If you're using a virtual environment, ensure it is active before running the bot.
CycloMonitor logs to stdout by default. To log to a file, specify the parameter -l LOGFILE
, where LOGFILE
is the path to the log file.
Configuring the bot
See CONFIGURATION.md for details.
CLI
Coming soon
Supports Python 3.8+, but Python 3.11+ is recommended.
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for cyclomonitor-2024.4.19-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | bb6ad9eaf6d689f5259980d01f01b5c5eb7d99901eb73e24943a9ad20528a835 |
|
MD5 | 3efea0e6de3e5f5c1e319b0f9cd2f376 |
|
BLAKE2b-256 | e6d6e06ed1771334a987cb418352f8300b7b9b1e0ff9facfff678d91d612d85d |