.. highlight:: console ============ Installation ============ Stable release -------------- To install telegram-upload, run these commands in your terminal: .. code-block:: console $ sudo pip3 install -U telegram-upload This is the preferred method to install telegram-upload, as it will always install the most recent stable release. If you don't have `pip`_ installed, this `Python installation guide`_ can guide you through the process. .. _pip: https://pip.pypa.io .. _Python installation guide: http://docs.python-guide.org/en/latest/starting/installation/ Other releases -------------- You can install other versions from Pypi using:: $ pip install telegram-upload== For versions that are not in Pypi (it is a development version):: $ pip install git+https://github.com/Nekmo/telegram-upload.git@#egg=telegram_upload If you do not have git installed:: $ pip install https://github.com/Nekmo/telegram-upload/archive/.zip Docker ====== Run telegram-upload without installing it on your system using Docker. Instead of ``telegram-upload`` and ``telegram-download`` you should use ``upload`` and ``download``. Usage:: docker run -v :/files/ -v :/config/ -it nekmo/telegram-upload:master * ````: Upload or download directory. * ````: Directory that will be created to store the telegram-upload configuration. It is created automatically. * ````: ``upload`` and ``download``. * ````: ``telegram-upload`` and ``telegram-download`` arguments. For example:: docker run -v /media/data/:/files/ -v $PWD/config:/config/ -it nekmo/telegram-upload:master upload file_to_upload.txt