<commit_before>[![McGill Logo](./assets/img/shadow-logo-transparent-big.png)](https://horizon.mcgill.ca/pban1/twbkwbis.P_WWWLogin "Minerva Webpage")



Minerva Shadow
=======

A python interface to the aging minervashadow website.


## Usage

Usage:

	minervashadow login
	minervashadow register <class_crns>...
	minervashadow drop <class_crn>
	minervashadow transcript
	minervashadow check <class_crn>
	minervashadow search <class_name> | <class_crn>
	minervashadow list [all]
	minervashadow -h | --help
	minervashadow -v | --version

Examples:

	minervashadow register 6969
	minervashadow transcript
	minervashadow check 321
	minervashadow search ecse420

Options:

	-h, --help     Show this screen.
	-v, --version  Print the current version.


## Installation


### Simple (with pip)

The package has not been submitted to the Python Package Index (PyPi) yet, but you will be able to install it using:

	pip install minervashadow


### Manual

The simplest way to install the package is using the makefile provided in the repository. Provifing you already have git installed:

	git clone https://github.com/cadesalaberry/minervashadow.git
	cd minervashadow
	make

And you are good to go ! you can then use the command-line client by typing it's name anywhere in the terminal:

	minervashadow


### Uninstallation

To remove the package, just run:

	make uninstall


## SOCS Server bug

If you want to install minervashadow on your SOCS server, you might run into the same issues I did, providing we don't have root privileges. In order to solve it, I just had to modify my **~/.bashrc** file to look like this:

># .bashrc

># Source global definitions
if [ -f /usr/socs/Profile ]; then
        . /usr/socs/Profile
fi

># User specific aliases and functions
**export PYTHONPATH=$HOME/.local/lib/python2.7/site-packages:$PYTHONPATH**
**export PATH=$HOME/.local/bin:$PATH**


The two last lines are the most important.


[![Bitdeli Badge](https://d2weczhvl823v0.cloudfront.net/cadesalaberry/minervashadow/trend.png)](https://bitdeli.com/free "Bitdeli Badge")
<commit_msg>Fix: README SOCS part was weird.<commit_after>[![McGill Logo](./assets/img/shadow-logo-transparent-big.png)](https://horizon.mcgill.ca/pban1/twbkwbis.P_WWWLogin "Minerva Webpage")



Minerva Shadow
=======

A python interface to the aging minervashadow website.


## Usage

Usage:

	minervashadow login
	minervashadow register <class_crns>...
	minervashadow drop <class_crn>
	minervashadow transcript
	minervashadow check <class_crn>
	minervashadow search <class_name> | <class_crn>
	minervashadow list [all]
	minervashadow -h | --help
	minervashadow -v | --version

Examples:

	minervashadow register 6969
	minervashadow transcript
	minervashadow check 321
	minervashadow search ecse420

Options:

	-h, --help     Show this screen.
	-v, --version  Print the current version.


## Installation


### Simple (with pip)

The package has not been submitted to the Python Package Index (PyPi) yet, but you will be able to install it using:

	pip install minervashadow


### Manual

The simplest way to install the package is using the makefile provided in the repository. Provifing you already have git installed:

	git clone https://github.com/cadesalaberry/minervashadow.git
	cd minervashadow
	make

And you are good to go ! you can then use the command-line client by typing it's name anywhere in the terminal:

	minervashadow


### Uninstallation

To remove the package, just run:

	make uninstall


## SOCS Server bug

If you want to install minervashadow on your SOCS server, you might run into the same issues I did, providing we don't have root privileges. In order to solve it, I just had to modify my **~/.bashrc** file to look like this:

	# .bashrc

	# Source global definitions
	if [ -f /usr/socs/Profile ]; then
	        . /usr/socs/Profile
	fi

	# User specific aliases and functions
	export PYTHONPATH=$HOME/.local/lib/python2.7/site-packages:$PYTHONPATH
	export PATH=$HOME/.local/bin:$PATH


The two last lines are the most important.


[![Bitdeli Badge](https://d2weczhvl823v0.cloudfront.net/cadesalaberry/minervashadow/trend.png)](https://bitdeli.com/free "Bitdeli Badge")

{'fraction_non_alphanumeric': 0.09110576923076923, 'fraction_numerical': 0.008653846153846154, 'mean_word_length': 4.168944099378882, 'pattern_counts': {'":': 0, '<': 13, '<?xml version=': 0, '>': 16, 'https://': 8, 'lorem ipsum': 0, 'www.': 0, 'xml': 0}, 'pii_count': 0, 'substrings_counts': 0, 'word_list_counts': {'cursed_substrings.json': 0, 'profanity_word_list.json': 0, 'sexual_word_list.json': 0, 'zh_pornsignals.json': 0}}
{'dir': 'git-commits-cleaned', 'id': '546164', 'n_tokens_mistral': 1428, 'n_tokens_neox': 1333, 'n_words': 465}