Skip to content
master
Go to file
Code

Latest commit

 

Git stats

Files

Permalink
Failed to load latest commit information.
Type
Name
Latest commit message
Commit time
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

README.md

CAP examples

A repository of examples of what can be done with Caselaw Access Project data.

Table of Contents

Examples

Interested in contributing your own examples?

  1. Fork this repository
  2. Add your work
  3. Make sure to add any requirements your project needs to requirements.in
  4. Run pip-compile --output-file requirements.txt requirements.in
  5. Add a link in the Examples section
  6. Create a pull request
  7. Receive gratitude (thank you so much!!)

Downloading bulk data

Helper methods to download whitelisted bulk data

Download the Illinois dataset

(capexamples) $ fab get_cases_from_bulk:Illinois

Or, download the Arkansas dataset

(capexamples) $ fab get_cases_from_bulk:Arkansas

Download a dataset with casebody format as xml

(capexamples) $ fab get_cases_from_bulk:Illinois,data_format=xml

Using the API

Read our API documentation.

In order to download non-whitelisted cases, you must register for an API key.

Once you have your API key, copy and paste it into your secret keys file settings.py.

Install

3.5.4 is the python version we're currently using on CAP, so to keep things simple, we'll be using the same version for these examples.

We recommend installing pyenv — follow instructions to install here.

Install your python version using pyenv and activate your virtual environment:

$ pyenv install 3.5.4
$ pyenv virtualenv 3.5.4 capexamples
$ pyenv activate capexamples
(capexamples) $

Set up!

(capexamples) $ pip install -r requirements.txt
(capexamples) $ fab setup

To run jupyter notebook examples (i.e. any file ending in .ipynb):

(capexamples) $ jupyter notebook

About

Examples for getting started using https://case.law

Topics

Resources

License

Releases

No releases published

Packages

No packages published