Skip to content

Improvements to README.me and install process. #29

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 4 commits into
base: master
Choose a base branch
from
Open

Improvements to README.me and install process. #29

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
77f1f56
Update README.md
LHurst-UoB Jun 12, 2019
6261fb6
Create requirements.txt
LHurst-UoB Jun 12, 2019
6ea7434
Removed reference to SETUP.md
LHurst-UoB Jun 12, 2019
945b51d
Added note how to use requirements.txt
LHurst-UoB Jun 12, 2019
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
26 changes: 15 additions & 11 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand All @@ -14,8 +14,8 @@ 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
Additional Instructions are available in SETUP.md
### Dependencies

* Python >= 3.3
* Pip for Python Version > 3.3
* Git > 1.7
Expand All @@ -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:
Expand Down Expand Up @@ -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
Expand All @@ -111,19 +111,23 @@ Now we are ready to install rpy2. Make sure python version 3 or greater is in us
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.
### Additional Pip Packages
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)
* 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.
6 changes: 6 additions & 0 deletions requirements.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
rpy2
sqlalchemy
py-postgresql
requests
python-dateutil
MonthDelta==1.0b