Coder Social home page Coder Social logo

aioaria2-mirror-bot's Introduction

aioaria2-mirror-bot

A Bot for Telegram made with Python using Pyrogram library. It needs Python 3.9 or newer to run.

Compatibility

Bot should work with all Linux-based operating systems. This program is tested partially on Windows and not officially tested on macOS, but there shouldn't be any problem if you install the correct dependencies.

Installation

This bot uses MongoDB Atlas for it database, you can get it free at https://www.mongodb.com/ and save the uri for use on config or env variable.

Obviously you need git, and it should be already installed on major operating systems linux based.

Local

First, clone this Git repository locally: git clone https://github.com/adekmaulana/aioaria2-mirror-bot

After that, you can run python3 -m pip install . to install the bot along with the depencies.

Once it's installed, you can choose to invoke it using the bot command, or run the bot in-place (which is described later in the Usage section). Running it in-place is recommended.

Error: Directory '.' is not installable. File 'setup.py' not found.

This common error is caused by an outdated version of pip. We use the Poetry package manager to make things easier to maintain, which works with pip through PEP-517. This is a relatively new standard, so a newer version of pip is necessary to make it work.

Upgrade to pip 19 to fix this issue: pip3 install -U pip

Using Heroku

  • Create a heroku account at http://signup.heroku.com/ (skip if you already have)
  • Then go to your dashboard
  • Create an empty application, remember your app name
  • Go to Account Settings
  • Find API Key and click Reveal, copy
  • Fork this repo and then go to Settings Tabs on your forked repo
  • Go to Secrets > New Repository Secret
  • Create 2 of repository secret with this name:
    • HEROKU_APP: Your created app name that upper step told
    • HEROKU_API_KEY: Your API Key heroku that upper step told
  • Then go to Actions Tab, Click Container
  • Run workflow
  • It should be finished around 5-6 minutes and then go to your heroku dashboard again, and choose the app you've created
  • Go to Settings > Reveal Config Vars and fill the coresponding Name and Value based on config.env_sample
  • After all Variables are met then you can run your dyno

Configuration

Copy config.env_sample to config.env and edit the settings as desired. Each and every setting is documented by the comments above it.

Obtain the API ID and API HASH from Telegram's website. TREAT THESE SECRETS LIKE A PASSWORD!

Obtain the BOT TOKEN from @BotFather. TREAT THESE SECRETS LIKE A PASSWORD!

Obtain the DB URI from MongoDB. TREAT THESE SECRETS LIKE A PASSWORD!

Obtain the G DRIVE SECRET from Google Console. TREAT THESE SECRETS LIKE A PASSWORD!

Configuration must be complete before starting the bot for the first time for it to work properly.

Usage

To start the bot, type python3 -m bot if you are running it in-place or use command corresponding to your chosen installation method above.

Support

You may also open an issue on GitHub for bugs, suggestions, or anything else relevant to the project.

aioaria2-mirror-bot's People

Contributors

adekmaulana avatar dependabot[bot] avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.