From 77f1f56ee5da4f3b99a33429764452d4a441f6d3 Mon Sep 17 00:00:00 2001 From: LHurst-UoB <44084717+LHurst-UoB@users.noreply.github.com> Date: Wed, 12 Jun 2019 08:06:52 +0100 Subject: [PATCH 1/4] Update README.md --- README.md | 16 ++++++++-------- 1 file changed, 8 insertions(+), 8 deletions(-) diff --git a/README.md b/README.md index 93b43b2..6671597 100755 --- a/README.md +++ b/README.md @@ -3,7 +3,7 @@ CAS_CodeRepoAnalyzer Ingests and analyzes code repositories -##Installation +## Installation 1. Clone this repository in to an empty directory 2. Copy the `./config.example.json` to `./config.json` and change the the configurations. All fields are required. @@ -14,7 +14,7 @@ gmail: gmail account to be used to send cas notifications repoUpdates: how often repositories should be updated for new commits system: how many worker threads the cas system can use to analyze and ingest repos. -###Dependencies +### Dependencies Additional Instructions are available in SETUP.md * Python >= 3.3 * Pip for Python Version > 3.3 @@ -29,7 +29,7 @@ Additional Instructions are available in SETUP.md * GNU grep * MonthDelta -###Setting up python3.3 virtual env on Ubuntu +### Setting up python3.3 virtual env on Ubuntu * Assumes you are working on Ubuntu 12.04 Install python3.3 using the deadsnakes PPA: @@ -85,7 +85,7 @@ source /path/to/new/virtual/environemnt/bin/activate Type `deactiviate` to exit the virtual env -###Installing rpy2 +### Installing rpy2 * Assumes you are working on Ubuntu 12.04 and python 3.3 Getting rpy2 to work can be a bit tricky. First, make sure R is installed. To do this, first @@ -111,7 +111,7 @@ Now we are ready to install rpy2. Make sure python version 3 or greater is in us pip install rpy2 ``` -###Additional Pip Packages +### Additional Pip Packages Install the following packages by doing `pip install ` and then the package name. Make sure you are using python3, such as using a virtualenv if using Ubuntu. @@ -120,10 +120,10 @@ name. Make sure you are using python3, such as using a virtualenv if using Ubunt * requests (requests) * python-dateutil (python-dateutil) -To install the MonthDelta package, simply do: `pip install http://pypi.python.org/packages/source/M/MonthDelta/MonthDelta-1.0b.tar.bz2` +To install the MonthDelta package, simply do: `pip install http://pypi.python.org/packages/source/M/MonthDelta/MonthDelta-1.0b.tar.bz2` or `pip install MonthDelta==1.0b` -###First-Time Database Setup +### First-Time Database Setup Set up the database for the first time by running `python script.py initDb` -##Usage +## Usage In a terminal, type `nohup python script.py & ' to start the code repo analyzer and run it in the background. From 6261fb637c28689460012c7ed130a484f67d5f00 Mon Sep 17 00:00:00 2001 From: LHurst-UoB <44084717+LHurst-UoB@users.noreply.github.com> Date: Wed, 12 Jun 2019 08:08:52 +0100 Subject: [PATCH 2/4] Create requirements.txt --- requirements.txt | 6 ++++++ 1 file changed, 6 insertions(+) create mode 100644 requirements.txt diff --git a/requirements.txt b/requirements.txt new file mode 100644 index 0000000..9711ee4 --- /dev/null +++ b/requirements.txt @@ -0,0 +1,6 @@ +rpy2 +sqlalchemy +py-postgresql +requests +python-dateutil +MonthDelta==1.0b From 6ea74340269c1a5537302860b20416e26b2b1fb1 Mon Sep 17 00:00:00 2001 From: LHurst-UoB <44084717+LHurst-UoB@users.noreply.github.com> Date: Wed, 12 Jun 2019 08:09:32 +0100 Subject: [PATCH 3/4] Removed reference to SETUP.md The file does not exist in the repository. --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 6671597..705af32 100755 --- a/README.md +++ b/README.md @@ -15,7 +15,7 @@ repoUpdates: how often repositories should be updated for new commits system: how many worker threads the cas system can use to analyze and ingest repos. ### Dependencies -Additional Instructions are available in SETUP.md + * Python >= 3.3 * Pip for Python Version > 3.3 * Git > 1.7 From 945b51de6272eb3bddf0fcb1cc80e81fc0389a35 Mon Sep 17 00:00:00 2001 From: LHurst-UoB <44084717+LHurst-UoB@users.noreply.github.com> Date: Wed, 12 Jun 2019 08:12:03 +0100 Subject: [PATCH 4/4] Added note how to use requirements.txt Reworded existing 'do a manual pip install ' text to be an alternative install method. --- README.md | 8 ++++++-- 1 file changed, 6 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 705af32..320b207 100755 --- a/README.md +++ b/README.md @@ -112,8 +112,12 @@ pip install rpy2 ``` ### Additional Pip Packages -Install the following packages by doing `pip install ` and then the package -name. Make sure you are using python3, such as using a virtualenv if using Ubuntu. +Install the following packages by doing `pip install -r requirements.txt`. + +Alternatively you can install them individually with `pip install ` and then the package +name. + +Make sure you are using python3, such as using a virtualenv if using Ubuntu. * SQL Alchemy (sqlalchemy) * Py-PostgreSQL (py-postgresql)