{"id":13617925,"url":"https://github.com/Nekmo/telegram-upload","last_synced_at":"2025-04-14T06:36:19.458Z","repository":{"id":38345535,"uuid":"126849789","full_name":"Nekmo/telegram-upload","owner":"Nekmo","description":"Upload and download files from Telegram up to 4 GiB using your account","archived":false,"fork":false,"pushed_at":"2024-06-18T01:08:06.000Z","size":2592,"stargazers_count":1186,"open_issues_count":67,"forks_count":248,"subscribers_count":11,"default_branch":"master","last_synced_at":"2025-04-11T10:17:04.247Z","etag":null,"topics":["download","downloader","file-upload","files","telegram","telegram-client","upload"],"latest_commit_sha":null,"homepage":"","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/Nekmo.png","metadata":{"files":{"readme":"README.rst","changelog":"HISTORY.rst","contributing":"CONTRIBUTING.rst","funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":"docs/supported_file_types.py","governance":null,"roadmap":null,"authors":"AUTHORS.rst","dei":null,"publiccode":null,"codemeta":null}},"created_at":"2018-03-26T15:28:18.000Z","updated_at":"2025-04-07T16:25:33.000Z","dependencies_parsed_at":"2024-01-14T15:23:12.336Z","dependency_job_id":"a3a3d7b9-4659-4545-8ac9-05aa853a5e88","html_url":"https://github.com/Nekmo/telegram-upload","commit_stats":{"total_commits":213,"total_committers":5,"mean_commits":42.6,"dds":0.06572769953051638,"last_synced_commit":"c4f60cd85bf75d11795c3633bf4c6ae610c4adc8"},"previous_names":[],"tags_count":20,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Nekmo%2Ftelegram-upload","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Nekmo%2Ftelegram-upload/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Nekmo%2Ftelegram-upload/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Nekmo%2Ftelegram-upload/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/Nekmo","download_url":"https://codeload.github.com/Nekmo/telegram-upload/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248836247,"owners_count":21169369,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["download","downloader","file-upload","files","telegram","telegram-client","upload"],"created_at":"2024-08-01T20:01:50.759Z","updated_at":"2025-04-14T06:36:18.719Z","avatar_url":"https://github.com/Nekmo.png","language":"Python","funding_links":[],"categories":["Python"],"sub_categories":[],"readme":"\n.. image:: https://raw.githubusercontent.com/Nekmo/telegram-upload/master/logo.png\n    :width: 100%\n\n|\n\n.. image:: https://raw.githubusercontent.com/Nekmo/telegram-upload/pip-rating-badge/pip-rating-badge.svg\n  :target: https://github.com/Nekmo/telegram-upload/actions/workflows/pip-rating.yml\n  :alt: pip-rating badge\n\n.. image:: https://img.shields.io/github/actions/workflow/status/Nekmo/telegram-upload/test.yml?style=flat-square\u0026maxAge=2592000\u0026branch=master\n  :target: https://github.com/Nekmo/telegram-upload/actions?query=workflow%3ATests\n  :alt: Latest Tests CI build status\n\n.. image:: https://img.shields.io/pypi/v/telegram-upload.svg?style=flat-square\n  :target: https://pypi.org/project/telegram-upload/\n  :alt: Latest PyPI version\n\n.. image:: https://img.shields.io/pypi/pyversions/telegram-upload.svg?style=flat-square\n  :target: https://pypi.org/project/telegram-upload/\n  :alt: Python versions\n\n.. image:: https://img.shields.io/codeclimate/maintainability/Nekmo/telegram-upload.svg?style=flat-square\n  :target: https://codeclimate.com/github/Nekmo/telegram-upload\n  :alt: Code Climate\n\n.. image:: https://img.shields.io/codecov/c/github/Nekmo/telegram-upload/master.svg?style=flat-square\n  :target: https://codecov.io/github/Nekmo/telegram-upload\n  :alt: Test coverage\n\n.. image:: https://img.shields.io/github/stars/Nekmo/telegram-upload?style=flat-square\n     :target: https://github.com/Nekmo/telegram-upload\n     :alt: Github stars\n\n\n###############\ntelegram-upload\n###############\nTelegram-upload uses your **personal Telegram account** to **upload** and **download** files up to **4 GiB** (2 GiB for\nfree users). Turn Telegram into your personal ☁ cloud!\n\nTo **install 🔧 telegram-upload**, run this command in your terminal:\n\n.. code-block:: console\n\n    $ sudo pip3 install -U telegram-upload\n\nThis is the preferred method to install telegram-upload, as it will always install the most recent stable release.\n🐍 **Python 3.7-3.11** are tested and supported. There are other installation ways available like `Docker \u003c#-docker\u003e`_.\nMore info in the `📕 documentation \u003chttps://docs.nekmo.org/telegram-upload/installation.html\u003e`_\n\n.. image:: https://raw.githubusercontent.com/Nekmo/telegram-upload/master/telegram-upload-demo.gif\n  :target: https://asciinema.org/a/592098\n  :width: 100%\n\n❓ Usage\n========\nTo use this program you need an Telegram account and your **App api_id \u0026 api_hash** (get it in\n`my.telegram.org \u003chttps://my.telegram.org/\u003e`_). The first time you use telegram-upload it requests your\n📱 **telephone**, **api_id** and **api_hash**. Bot tokens can not be used with this program (bot uploads are limited to\n50MB).\n\nTo **send ⬆️ files** (by default it is uploaded to saved messages):\n\n.. code-block:: console\n\n    $ telegram-upload file1.mp4 file2.mkv\n\nYou can **download ⤵️ the files** again from your saved messages (by default) or from a channel. All files will be\ndownloaded until the last text message.\n\n.. code-block:: console\n\n    $ telegram-download\n\n`Read the documentation \u003chttps://docs.nekmo.org/telegram-upload/usage.html#telegram-download\u003e`_ for more info about the\noptions availables.\n\nInteractive mode\n----------------\nThe **interactive option** (``--interactive``) allows you to choose the dialog and the files to download or upload with\na **terminal 🪄 wizard**. It even **supports mouse**!\n\n.. code-block:: console\n\n    $ telegram-upload --interactive    # Interactive upload\n    $ telegram-download --interactive  # Interactive download\n\n`More info in the documentation \u003chttps://docs.nekmo.org/telegram-upload/usage.html#interactive-mode\u003e`_\n\nSet group or chat\n-----------------\nBy default when using telegram-upload without specifying the recipient or sender, telegram-upload will use your personal\nchat. However you can define the 👨 destination. For file upload the argument is ``--to \u003centity\u003e``. For example:\n\n.. code-block::\n\n    $ telegram-upload --to telegram.me/joinchat/AAAAAEkk2WdoDrB4-Q8-gg video.mkv\n\nYou can download files from a specific chat using the --from \u003centity\u003e parameter. For example:\n\n.. code-block::\n\n    $ telegram-download --from username\n\nYou can see all `the possible values for the entity in the documentation \u003chttps://docs.nekmo.org/telegram-upload/usage.html#set-recipient-or-sender\u003e`_.\n\nSplit \u0026 join files\n------------------\nIf you try to upload a file that **exceeds the maximum supported** by Telegram by default, an error will occur. But you\ncan enable ✂ **split mode** to upload multiple files:\n\n.. code-block:: console\n\n    $ telegram-upload --large-files split large-video.mkv\n\nFiles split using split can be rejoined on download using:\n\n.. code-block:: console\n\n    $ telegram-download --split-files join\n\nFind more help in `the telegram-upload documentation \u003chttps://docs.nekmo.org/telegram-upload/usage.html#split-files\u003e`_.\n\nDelete on success\n-----------------\nThe ``--delete-on-success`` option allows you to ❌ **delete the Telegram message** after downloading the file. This is\nuseful to send files to download to your saved messages and avoid downloading them again. You can use this option to\ndownload files on your computer away from home.\n\nConfiguration\n-------------\nCredentials are saved in ``~/.config/telegram-upload.json`` and ``~/.config/telegram-upload.session``. You must make\nsure that these files are secured. You can copy these 📁 files to authenticate ``telegram-upload`` on more machines, but\nit is advisable to create a session file for each machine.\n\nMore options\n------------\nTelegram-upload has more options available, like customizing the files thumbnail, set a caption message (including\nvariables) or configuring a proxy.\n`Read the documentation \u003chttps://docs.nekmo.org/telegram-upload/usage.html#telegram-download\u003e`_ for more info.\n\n💡 Features\n===========\n\n* **Upload** and **download** multiples files  (up to 4 GiB per file for premium users).\n* **Interactive** mode.\n* Add video **thumbs**.\n* **Split** and **join** large files.\n* **Delete** local or remote file on success.\n* Use **variables** in the **caption** message.\n* ... And **more**.\n\n🐋 Docker\n=========\nRun telegram-upload without installing it on your system using Docker. Instead of ``telegram-upload``\nand ``telegram-download`` you should use ``upload`` and ``download``. Usage::\n\n\n    $ docker run -v \u003cfiles_dir\u003e:/files/\n                 -v \u003cconfig_dir\u003e:/config\n                 -it nekmo/telegram-upload:master\n                 \u003ccommand\u003e \u003cargs\u003e\n\n* ``\u003cfiles_dir\u003e``: upload or download directory.\n* ``\u003cconfig_dir\u003e``: Directory that will be created to store the telegram-upload configuration.\n  It is created automatically.\n* ``\u003ccommand\u003e``: ``upload`` and ``download``.\n* ``\u003cargs\u003e``: ``telegram-upload`` and ``telegram-download`` arguments.\n\nFor example::\n\n    $ docker run -v /media/data/:/files/\n                 -v $PWD/config:/config\n                 -it nekmo/telegram-upload:master\n                 upload file_to_upload.txt\n\n❤️ Thanks\n=========\nThis project developed by `Nekmo \u003chttps://github.com/Nekmo\u003e`_ \u0026 `collaborators \u003chttps://github.com/Nekmo/telegram-upload/graphs/contributors\u003e`_ would not be possible without\n`Telethon \u003chttps://github.com/LonamiWebs/Telethon\u003e`_, the library used as a Telegram client.\n\nTelegram-upload is licensed under the `MIT license \u003chttps://github.com/Nekmo/telegram-upload/blob/master/LICENSE\u003e`_.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2FNekmo%2Ftelegram-upload","html_url":"https://awesome.ecosyste.ms/projects/github.com%2FNekmo%2Ftelegram-upload","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2FNekmo%2Ftelegram-upload/lists"}