From 2b53d7ed67a3c326950471d8d656a4c6a3109db2 Mon Sep 17 00:00:00 2001 From: miststudent2011 Date: Sat, 17 Feb 2018 16:10:49 +0530 Subject: [PATCH 1/5] Update README.md --- README.md | 54 +++++++++++++++++++++++++++++++++++++++++++++++++++++- 1 file changed, 53 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index f45b7c3..3ae3018 100644 --- a/README.md +++ b/README.md @@ -1,2 +1,54 @@ # opendirectories-bot -Description coming soon +Installation Instructions: +Python 3 is required to run the script. +To install Python 3 follow the steps below in Ubuntu (Other Distros too have same procedure). +Check installed Python version + +$ python3 --version + +To update installed Python to Python 3 run the following command + +$ sudo apt-get update + +If you are using Ubuntu 16.10 or newer, then you can easily install Python 3.6 with the following commands: + +$ sudo apt-get update +$ sudo apt-get install python3.6 + +If you’re using another version of Ubuntu (e.g. the latest LTS release), we recommend using the deadsnakes PPA to install Python 3.6: + +$ sudo apt-get install software-properties-common +$ sudo add-apt-repository ppa:deadsnakes/ppa +$ sudo apt-get update +$ sudo apt-get install python3.6 + +Python 2.7.9 and later (on the python2 series), and Python 3.4 and later include pip by default. + +To see if pip is installed, open a command prompt and run + +$ command -v pip + +Note that on some Linux distributions including Ubuntu and Fedora the pip command is meant for Python 2, while the pip3 command is meant for Python 3. + +$ command -v pip3 + +To install pip, securely download get-pip.py. [1]: + +$ curl https://bootstrap.pypa.io/get-pip.py -o get-pip.py + +Inspect get-pip.py for any malevolence. Then run the following: + +$ sudo python get-pip.py + +Using the Script: + +$ git clone https://github.com/simon987/opendirectories-bot.git +$ cd opendirectories-bot/ +$ mkdir static/reports +$ pip3 install -r requirements.txt +$ python3 manual.py mkreport "{{URL}}" "{{6 character id}}" + + +Example Usage: +python3 manual.py mkreport "http://example.com/library/ePub/" "list.json" + From e366dcb1fe657858dd0214865a4600931b835c7f Mon Sep 17 00:00:00 2001 From: miststudent2011 Date: Sat, 17 Feb 2018 16:13:04 +0530 Subject: [PATCH 2/5] Update README.md --- README.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/README.md b/README.md index 3ae3018..1937dfe 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,6 @@ # opendirectories-bot Installation Instructions: + Python 3 is required to run the script. To install Python 3 follow the steps below in Ubuntu (Other Distros too have same procedure). Check installed Python version @@ -50,5 +51,6 @@ $ python3 manual.py mkreport "{{URL}}" "{{6 character id}}" Example Usage: + python3 manual.py mkreport "http://example.com/library/ePub/" "list.json" From b56b9ab7d30851d01ae1d0f1e9ee8d96044babed Mon Sep 17 00:00:00 2001 From: miststudent2011 Date: Sat, 17 Feb 2018 16:14:20 +0530 Subject: [PATCH 3/5] Update README.md --- README.md | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/README.md b/README.md index 1937dfe..7ed6133 100644 --- a/README.md +++ b/README.md @@ -44,9 +44,13 @@ $ sudo python get-pip.py Using the Script: $ git clone https://github.com/simon987/opendirectories-bot.git + $ cd opendirectories-bot/ + $ mkdir static/reports + $ pip3 install -r requirements.txt + $ python3 manual.py mkreport "{{URL}}" "{{6 character id}}" From a0da5049142df7b2d261e03f7992cd52f216739c Mon Sep 17 00:00:00 2001 From: miststudent2011 Date: Sat, 17 Feb 2018 16:15:05 +0530 Subject: [PATCH 4/5] Update README.md --- README.md | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/README.md b/README.md index 7ed6133..b1b6778 100644 --- a/README.md +++ b/README.md @@ -14,13 +14,17 @@ $ sudo apt-get update If you are using Ubuntu 16.10 or newer, then you can easily install Python 3.6 with the following commands: $ sudo apt-get update + $ sudo apt-get install python3.6 If you’re using another version of Ubuntu (e.g. the latest LTS release), we recommend using the deadsnakes PPA to install Python 3.6: $ sudo apt-get install software-properties-common + $ sudo add-apt-repository ppa:deadsnakes/ppa + $ sudo apt-get update + $ sudo apt-get install python3.6 Python 2.7.9 and later (on the python2 series), and Python 3.4 and later include pip by default. From 83eaa05f1c65b39d395763fb70e3f38f9404b517 Mon Sep 17 00:00:00 2001 From: miststudent2011 Date: Sat, 17 Feb 2018 16:16:38 +0530 Subject: [PATCH 5/5] Update README.md --- README.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/README.md b/README.md index b1b6778..1e40ff6 100644 --- a/README.md +++ b/README.md @@ -2,7 +2,9 @@ Installation Instructions: Python 3 is required to run the script. + To install Python 3 follow the steps below in Ubuntu (Other Distros too have same procedure). + Check installed Python version $ python3 --version