https://github.com/hitalom/gojira
A bot for Telegram that provides anime and manga information through AniList
https://github.com/hitalom/gojira
aiogram python telegram telegram-bot
Last synced: 10 months ago
JSON representation
A bot for Telegram that provides anime and manga information through AniList
- Host: GitHub
- URL: https://github.com/hitalom/gojira
- Owner: HitaloM
- License: bsd-3-clause
- Created: 2023-04-21T02:54:34.000Z (about 3 years ago)
- Default Branch: main
- Last Pushed: 2024-10-31T13:55:47.000Z (over 1 year ago)
- Last Synced: 2025-04-14T17:29:38.298Z (about 1 year ago)
- Topics: aiogram, python, telegram, telegram-bot
- Language: Python
- Homepage: https://t.me/PyGodzillaBot
- Size: 520 KB
- Stars: 16
- Watchers: 1
- Forks: 6
- Open Issues: 0
-
Metadata Files:
- Readme: README.rst
- Funding: .github/FUNDING.yml
- License: LICENSE
Awesome Lists containing this project
README
#####################
Gojira - Telegram Bot
#####################
.. image:: https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/charliermarsh/ruff/main/assets/badge/v2.json
:target: https://github.com/charliermarsh/ruff
:alt: Ruff
.. image:: https://badges.crowdin.net/gojira/localized.svg
:target: https://crowdin.com/project/gojira/
:alt: crowdin status
.. image:: https://results.pre-commit.ci/badge/github/HitaloM/Gojira/main.svg
:target: https://results.pre-commit.ci/latest/github/HitaloM/Gojira/main
:alt: pre-commit.ci status
This bot can get information from AniList through its API with GraphQL, supporting all AniList media.
How to contribute
=================
Every open source project lives from the generous help by contributors that sacrifices their time and Gojira is no different.
Translations
------------
Translations should be done in our `Crowdin Project `_,
as Crowdin checks for grammatical issues, provides improved context about the string to be translated and so on,
thus possibly providing better quality translations. But you can also submit a pull request if you prefer to translate that way.
Bot setup
---------
Below you can learn how to set up the Gojira project.
Requirements
~~~~~~~~~~~~
- Python 3.11.X.
- An Unix-like operating system (Windows isn't supported).
- Redis
Instructions
~~~~~~~~~~~~
1. Create a virtualenv (This step is optional, but **highly** recommended to avoid dependency conflicts)
- ``python3 -m venv .venv`` (You don't need to run it again)
- ``. .venv/bin/activate`` (You must run this every time you open the project in a new shell)
2. Install dependencies from the pyproject.toml with ``python3 -m pip install . -U``.
3. Go to https://my.telegram.org/apps and create a new app.
4. Compile the desired locales (languages) as instructed `here `_.
5. Start the Redis service:
- ``systemctl start redis``
6. Create a new ``config.env`` in ``data/``, there is a ``config.example.env`` file for you to use as a template.
7. After completing the ``config.env`` file, run ``python3 -m gojira`` to start the bot.
Tools
~~~~~
- Use `ruff `_ to lint and format your code.
- We recommend using `pre-commit `_ to automate the above tools.
- We use VSCode and recommend it with the Python, Pylance and Intellicode extensions.