Lightweight command line interface for T411
Project description
T411 CLI
===================
**t411cli** is a lightweight command line interface / API for T411 written in Python.
----------
Installation
-------------
----------
Quick Start
-------------
At first run, the soft will ask for your T411 credentials, simply type them once and they will be stored under ``` /home/$USER/.config/t411cli.conf ``` ( See [Configuration](#Configuration) section for more details.
**t411cli** is composed of three main commands:
> **search**
> Command used to browse available torrents.
> **details**
> Get details for a specific torrent
> **download**
> Download selected torrent to filesystem
#### Search for a torrent
You can browse T411 by by simply typing :
```sh
t411 search 'torrent name'
```
The 10 best matches (ordered by number of seeders) will be shown, if you want to change this number, you can just set the ``` --limit | -l ``` argument like so:
```sh
t411 -l 50 search 'torrent name' # OR
t411 --limit 50 search 'torrent name' # Both command will give the same results
```
This command will yield a list of torrents, To use the other commands, please be sure to note the torrent ID displayed by **search**.
#### Download a torrent
In order to download a torrent, you must have his ID;
```sh
t411 download TORRENT_ID
```
You can specify a command to launch on download completion, for example:
```sh
t411 download TORRENT_ID --cmd 'qbittorrent %torrent'
```
Will open the corresponding torrent in qbittorrent.
> **Note**
> The special keyword **%torrent** can be used in **--cmd** option to refer to the completed torrent file.
By default, your torrent file will be stored under ```/home/$USER/Downloads``` directory, see [Configuration](#Configuration) section to change this behaviour.
----------
Configuration
-------------
By default, your configuration will be loaded or stored from:
``` /home/$USER/.config/t411cli.conf ```
You can also put a global configuration in the ```/etc/t411cli.conf``` file
The tool configuration is split in two parts:
**Account**
> Section containing account information : username and password
**Config**
> Section for software configuration
* limit
> Maximum number of torrent that can be fetched in a single request
* torrent_folder
> The tool will download torrent files in this folder
----------
Troubleshooting
-------------
Getting a ```ServiceError``` on program startup:
> This error is usually used when T411 is unreachable or encounter an unknown problem, check for [API status](http://www.websitedown.info/api.t411.in)
> If this service is up, please contact a project developer
----------
Developers
-------------
Hi, wanna join us ? Glad to hear that !
You can start browse the code, we are trying to comment a lot, especially for TODO's.
Or you can try to improve one of theses :
- Test coverage
- Command line utilities
- Windows compatibility
- Fancy colors and stuff
===================
**t411cli** is a lightweight command line interface / API for T411 written in Python.
----------
Installation
-------------
----------
Quick Start
-------------
At first run, the soft will ask for your T411 credentials, simply type them once and they will be stored under ``` /home/$USER/.config/t411cli.conf ``` ( See [Configuration](#Configuration) section for more details.
**t411cli** is composed of three main commands:
> **search**
> Command used to browse available torrents.
> **details**
> Get details for a specific torrent
> **download**
> Download selected torrent to filesystem
#### Search for a torrent
You can browse T411 by by simply typing :
```sh
t411 search 'torrent name'
```
The 10 best matches (ordered by number of seeders) will be shown, if you want to change this number, you can just set the ``` --limit | -l ``` argument like so:
```sh
t411 -l 50 search 'torrent name' # OR
t411 --limit 50 search 'torrent name' # Both command will give the same results
```
This command will yield a list of torrents, To use the other commands, please be sure to note the torrent ID displayed by **search**.
#### Download a torrent
In order to download a torrent, you must have his ID;
```sh
t411 download TORRENT_ID
```
You can specify a command to launch on download completion, for example:
```sh
t411 download TORRENT_ID --cmd 'qbittorrent %torrent'
```
Will open the corresponding torrent in qbittorrent.
> **Note**
> The special keyword **%torrent** can be used in **--cmd** option to refer to the completed torrent file.
By default, your torrent file will be stored under ```/home/$USER/Downloads``` directory, see [Configuration](#Configuration) section to change this behaviour.
----------
Configuration
-------------
By default, your configuration will be loaded or stored from:
``` /home/$USER/.config/t411cli.conf ```
You can also put a global configuration in the ```/etc/t411cli.conf``` file
The tool configuration is split in two parts:
**Account**
> Section containing account information : username and password
**Config**
> Section for software configuration
* limit
> Maximum number of torrent that can be fetched in a single request
* torrent_folder
> The tool will download torrent files in this folder
----------
Troubleshooting
-------------
Getting a ```ServiceError``` on program startup:
> This error is usually used when T411 is unreachable or encounter an unknown problem, check for [API status](http://www.websitedown.info/api.t411.in)
> If this service is up, please contact a project developer
----------
Developers
-------------
Hi, wanna join us ? Glad to hear that !
You can start browse the code, we are trying to comment a lot, especially for TODO's.
Or you can try to improve one of theses :
- Test coverage
- Command line utilities
- Windows compatibility
- Fancy colors and stuff
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
t411cli-0.1.tar.gz
(5.2 kB
view hashes)