Out of the box, this application depends on a mysql backend, and the instructions below cater to that dependency. You can easily use another database backend, see the Django documentation for instructions.

First you will need to create a new utf-8 encoded mysql database for the project, and assign a user to that database with the pertinent permissions. Assuming we want to call the database scotusdatabase, the user scotususer, and the password scotuspassword, we can do the following. Keep in mind, you should use your own unique strings for the database name, user, and password:

mysql -u root -p
CREATE DATABASE scotusdatabase DEFAULT CHARACTER SET utf8 DEFAULT COLLATE utf8_general_ci;
CREATE USER 'scotususer'@'localhost' IDENTIFIED BY 'scotuspassword';
GRANT ALL PRIVILEGES ON scotusdatabase.* TO 'scotususer'@'localhost';

Now you will need to clone this repository, download the dependencies (via pip), and initialize the application settings file. The last step below will open the settings file in the standard vi text editor:

git clone git@github.com:orangeoval/scotus.git
cd scotus
chmod 755 manage.py
pip install requirements.txt
cp scotus/settings.py.dist scotus/settings.py
vi scotus/settings.py

You will need to find the following database variables in the file and change them to reflect the mysql database, user, and password that you created above:

MYSQL_DATABASE
MYSQL_USER
MYSQL_PASSWORD

You will also want to change CONTACT_EMAIL to reflect your valid email address. You can type ':wq!' (without the quotation marks) to save your changes and exit the vi editor. You will also need to set up a django user for the application to verify the citations (you can look at the django documentation for instructions, but I intend to add specific instructions soon. To run the opinion discovery and web citation process, you can manually run the following from within the scotus/ directory:

./manage.py discover

However, it is more practical to have this process run automatically in your server's crontab. If you installed this application in your home directory on a unix OS, and your user name is 'abc', you could simply add the following to your crontab: /home/abc/scotus/manage.py discover. If you are using virtualenv/virtualenvwrapper, you can use the run the following from the scotus/ directory:

cp scripts/discover.sh.dist scripts/discover.sh
chmod 755 scripts/discover.sh

See the discover.sh file that you created for further instructions on using the script. For tips on setting up a unix cronjob, see this documentation.

Finally, you have the option to set up on-demand capturing via either webcitation.org, perma.cc, or both! What this means is that, once a user validates a citation, if that citation is a non-404, the application will utilize the webcitations.org/perma.cc APIs to grab an immediate capture of the citation. The links for these captures will be stored in your datbase and presented in the applications /citations/ view. To utlize the webcitation.org API, all you will need is a valid email address to get notifications. To utilize the perma.cc API, you will need to set up a perma.cc account. Once that is set up, you will need to log in, click your name in the upper right hand corner, click tools, then click "Generate API key". You can activate the webcitations.org and/or perma.cc on-demand archiving by again editing the settings.py file. From within the scotus/ directory, run vi scotus/settings.py and find the following block:

WEBCITE = {
    'enabled': False,
    'api_query': 'http://www.webcitation.org/archive?returnxml=true&url=%s&email=%s',
}
PERMA = {
    'enabled': False,
    'archive_base': 'https://perma.cc',
    'api_key': 'PERMA_CC_API_KEY',
    'api_query': 'https://api.perma.cc/v1/archives/?api_key=%s'
}

Simply change False to True for the services that you want to enable. If you'd like to enable perma.cc, you will need to put the API key that you generated in place of PERMA_CC_API_KEY. Lastly, all discovered opinion PDFs will be saved to your local scotus/docs/pdfs directory for safe keeping. That's it! If you encounter any bugs or experience issues setting up the application, feel free to open a ticket on this repository for further assistance.