From a1e5b1f784638904d4682b6e40b1b84e31fa2597 Mon Sep 17 00:00:00 2001
From: KevinMidboe <kevin.midboe@gmail.com>
Date: Fri, 4 May 2018 00:19:34 +0200
Subject: [PATCH] Added README

---
 README.md | 119 ++++++++++++++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 119 insertions(+)
 create mode 100644 README.md

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..f85c4e6
--- /dev/null
+++ b/README.md
@@ -0,0 +1,119 @@
+# Deluge Client
+
+## Idea
+Create a deluge python client for interfacing with deluge for common tasks like listing, adding, removing and setting download directory for torrents. 
+
+<a name='setup_a_virtual_enviroment'></a>
+## Setup a Virtual Environment
+Virtual environment allows us to create a local environment for the requirements needed. Because pip does not download packages already downloaded to your system, we can use virtualenv to save our packages in the project folder.
+
+<a name='env_installation'></a>
+### Installation
+To install virtualenv, simply run:  
+
+```
+ $ pip install virutalenv
+```
+
+<a name='env_usage'></a>
+### Usage
+After you have downloaded this project go to it in your terminal by going to the folder you downloaded and typing the following:
+
+
+```
+ $ cd delugeClient/
+```
+
+The to setup a virtual environment enter this:
+
+```
+ $ virtualenv -p python3.6 env
+```
+
+ > If you get an error now it might be because you don't have python3.6, please make sure you have python version 3.6 if else you can download it from [here](https://www.python.org/downloads/)
+
+
+First we navigate to the folder we downloaded.
+
+Then we use the ```virtualenv``` command to create a ```env``` subdirectory in our project. This is where pip will download everything to and where we can add other specific python versions. Then we need to *activate* our virtual environment by doing:
+
+```
+ $ source env/bin/activate
+```
+
+You should now see a ```(env)``` appear at the beginning of your terminal prompt indicating that you are working from within the virtual environment. Now when you install something: 
+
+```
+ $ pip install <package>
+```
+
+It will get installed in the env folder, and not globaly on our machine. 
+
+The leave our virtual environment run: 
+
+```
+ $ deactivate
+```
+
+<a name='configure_config_file'></a>
+## Configure the Config File
+
+The following is where we need to do some manual editing of our config file. Open to ```config.ini``` in your favorite text editor. 
+
+``` 
+ $ (vi) config.ini
+```
+
+Then you need to change the HOST and PORT to reflect the address for your deluged client. The username and password needed to connect can be found under:  
+
+(Only tested on ubuntu)
+```
+ $ cat /home/USER/.config/deluge/auth
+```
+
+<a name='install_requirements'></a>
+## Install Required Dependencies
+Now that we have our virutalenv set up and activated we want to install all the necessary packages listed in `requirements.txt`. To install it's dependencies do the following:
+
+```
+ $ pip install -r requirements.txt
+```
+
+Now we have our neccessary packages installed!
+
+
+<a name='usage'></a>
+## Usage
+
+```
+Custom delugeRPC client
+Usage:
+   deluge_cli add MAGNET [DIR] [--debug | --warning | --error]
+   deluge_cli get TORRENT
+   deluge_cli ls [--downloading | --seeding | --paused]
+   deluge_cli toggle TORRENT
+   deluge_cli rm TORRENT [--debug | --warning | --error]
+   deluge_cli (-h | --help)
+   deluge_cli --version
+
+Arguments:
+   MAGNET        Magnet link to add
+   DIR           Directory to save to
+   TORRENT       A selected torrent
+
+Options:
+   -h --help     Show this screen
+   --version     Show version
+   --debug       Print all debug log
+   --warning     Print only logged warnings
+   --error       Print error messages (Error/Warning)
+```
+
+<a name='usage_running'></a>
+### Running
+To interface with deluged :
+
+```
+ $ ./deluge_cli.py ls
+```
+