Awesome /mu/zak bot for ICQ/myTeam music-related chats.
Does each and every one of your chat members prefer different streaming platforms? Do you feel missing out on some awesome music your friends share in the chat just because you don't have an account on the next big platform all the cool kids use? /mu/zakbot to the rescue! It does one thing and does it (hopefully) well - whenever there's a link to a song or album in the chat, it gets all the links to the same media on different platforms from odesli.co and post them to the chat. With buttons for instant access! Charming, right? Of course, you can configure it to react only to some platforms - or to post links only to some platforms. Or to react only when it's mentioned or passed a specific command. (NB: For now, configuration is possible only through a config file).
pip install -U muzakbotor install with Poetry
poetry add muzakbotThen you can run
MUZAKBOT_TOKEN=$token muzakbot -c $config_pathor if installed with Poetry:
MUZAKBOT_TOKEN=$token poetry run muzakbot -c $config_pathMakefile contains many functions for fast assembling and convenient work.
1. Download Poetry
make download-poetry2. Install all dependencies and pre-commit hooks
make installIf you do not want to install pre-commit hooks, run the command with the NO_PRE_COMMIT flag:
make install NO_PRE_COMMIT=13. Check the security of your code
make check-safetyThis command launches a Poetry and Pip integrity check as well as identifies security issues with Safety and Bandit. By default, the build will not crash if any of the items fail. But you can set STRICT=1 for the entire build, or you can configure strictness for each item separately.
make check-safety STRICT=1or only for safety:
make check-safety SAFETY_STRICT=1multiple
make check-safety PIP_STRICT=1 SAFETY_STRICT=1List of flags for
check-safety(can be set to1or0):STRICT,POETRY_STRICT,PIP_STRICT,SAFETY_STRICT,BANDIT_STRICT.
4. Check the codestyle
The command is similar to check-safety but to check the code style, obviously. It uses Black, Darglint, Isort, and Mypy inside.
make check-styleIt may also contain the STRICT flag.
make check-style STRICT=1List of flags for
check-style(can be set to1or0):STRICT,BLACK_STRICT,DARGLINT_STRICT,ISORT_STRICT,MYPY_STRICT.
5. Run all the codestyle formaters
Codestyle uses pre-commit hooks, so ensure you've run make install before.
make codestyle6. Run tests
make test7. Run all the linters
make lintthe same as:
make test && make check-safety && make check-styleList of flags for
lint(can be set to1or0):STRICT,POETRY_STRICT,PIP_STRICT,SAFETY_STRICT,BANDIT_STRICT,BLACK_STRICT,DARGLINT_STRICT,ISORT_STRICT,MYPY_STRICT.
8. Build docker
make dockerwhich is equivalent to:
make docker VERSION=latestMore information here.
You can see the list of available releases on the GitHub Releases page.
We follow Semantic Versions specification.
We use Release Drafter. As pull requests are merged, a draft release is kept up-to-date listing the changes, ready to publish when you’re ready. With the categories option, you can categorize pull requests in release notes using labels.
For Pull Request this labels are configured, by default:
| Label | Title in Releases |
|---|---|
enhancement, feature |
🚀 Features |
bug, refactoring, bugfix, fix |
🔧 Fixes & Refactoring |
build, ci, testing |
📦 Build System & CI/CD |
breaking |
💥 Breaking Changes |
documentation |
📝 Documentation |
dependencies |
⬆️ Dependencies updates |
You can update it in release-drafter.yml.
GitHub creates the bug, enhancement, and documentation labels for you. Dependabot creates the dependencies label. Create the remaining labels on the Issues tab of your GitHub repository, when you need them.
This project is licensed under the terms of the MIT license. See LICENSE for more details.
@misc{muzakbot,
author = {brannt},
title = {Awesome /mu/zak bot},
year = {2021},
publisher = {GitHub},
journal = {GitHub repository},
howpublished = {\url{https://github.com/brannt/muzakbot}}
}
This project was generated with python-package-template.