Skip to main content

Oklahoma State Courts Network case parsing utilities

Project description

OSCN utilities

A python library for scraping case information from the Oklahoma State Courts Network.

Contents

oscn > Python package source to provide an api for retrieving and parsing case records.

scripts > Python scripts showing use of the oscn package

  • example.py: demonstrates use of the request Case and Caselist
  • retrieve-counts.py: saves a list of all counts for a list of counties and years
  • find-counts.py: saves a list of counts passing a test for a list of counties and years
  • soup_test.py: a stub for testing parsing attempts using BeautifulSoup
  • parse_test.py: a stub for developing using saved examples

OSCN package

oscn

  • counties: Returns a list of counties.
  • courts: Same as counties but more a accurate description.
  • judges: Returns a list of objects formated as {'name': 'Bond, James', 'number': '007'}
  • types: returns a dict of case type codes and descriptons
  • type: function to return case type description. Usage:
    >>> oscn.type("AO")
    'CIVIL ADMINISTRATIVE'
    

oscn.request

  • Case: Returns a single case. Case can be saved as files using Case.save() and retrieved using Case.open().

  • CaseList: Returns an iterator for retrieving cases for a county and year. CaseLists can be filtered using .find(). See scripts/example.py for details

  • Party: Returns information on parties available on OSCN.

  • Docket: Returns docket of cases for specific judges and date

oscn.parse

Parsers accept the html of an OSCN page and return python objects.

Case Page Parsers

  • filed: returns a string of the filing date (e.g. 12/25/2017)
  • closed: returns a string of the date the case was closed. Return None if not closed.
  • counts: returns of list of count dicts found in a case. Keys include 'description' of the count. If available 'violation' and 'disposed' are added.
  • judge: returns a string of the judge's name
  • parties: returns a list of dicts with these keys: id, name, type
  • docket: returns a list of rows in a docket
  • events: returns a list of dicts with these keys: event, party, docket, reporter, date, description. The keys date and description are cleaner versions of the event text. The event key will be deprecated some day so use date and description if you are starting a project.
  • attorneys: returns a list of dicts with these keys: name, address, and representing
  • issues: returns a list of dicts with issue information. Each issues includes a list of dicts for each party

Party Page Parsers

  • name: returns 'Requested Party'
  • alias: returns 'Alias or Alternate Names'
  • profile: returns dict of values in 'Personal Profile'
  • birth_month: returns string of 'Birth Month and Year'
  • addresses: returns a list of dicts for each address

Docket Page Parsers

  • cases: returns a list of case indexes
  • tables: returns the html table for each case in the docket

oscn.find

  • CaseIndexes: returns an iterator of case indexes (e.g. tulsa-CF-2019-12).

Usage

Create a CaseIndexes list using these key word arguments:

  • county: defaults to all,
  • last_name: use this for company or organization names
  • first_name: optional
  • middle_name: optional
  • filed_after: More readable than FiledDateL
  • filed_before: More readable than FiledDateH
  • closed_after: More readable than ClosedDateL
  • closed_before: More readable than ClosedDateH

Notes

  • The % wild card is added to all words in name, first and middle
  • Date arguments use MM/DD/YYY strings.

OSCN search parameters

If you are familar with the OSCN search parameters you can initialize CaseIndexes using these as key word arguments: db, number, lname, fname, mname, DoBMin, DoBMax, partytype, apct, dcct, FiledDate, FiledDateH, ClosedDateL, ClosedDateH, iLC, iLCType, iYear, iNumber, and citation

Using this will override init keyword values such as first or filed_after.

Development Install

  1. python3 -m venv ~/your_path/oscn
  2. source ~/your_path/oscn/bin/activate
  3. git clone git@github.com:codefortulsa/oscn.git
  4. cd oscn
  5. pip install -e .

Usage

Install with pip install oscn

Script example:

import oscn

Request a single case:

oscn.request.Case(county='tulsa', year='2018', number=84)

or use case index notation:

oscn.request.Case('love-CF-2019-25')

To request a list of cases to iterate:

oscn.request.CaseList(county='adair', year='2016')

Run test scripts

  • pytest tests/

or with ipdb:

- `pytest -s tests/`

specify a test:

  • pytest -s tests/test_parse.py -k 'test_events'

Deployment steps

  1. Edit setup.py
  2. python3 setup.py sdist bdist_wheel
  3. twine upload dist/*

User Agent

In some cases a custom user agent is required in the header of requests. Setting an environmental varialbe called OSCN_USER_AGENT will override the default.

Project details


Release history Release notifications | RSS feed

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

oscn-0.0.0.89.tar.gz (43.1 kB view details)

Uploaded Source

Built Distribution

oscn-0.0.0.89-py3-none-any.whl (50.3 kB view details)

Uploaded Python 3

File details

Details for the file oscn-0.0.0.89.tar.gz.

File metadata

  • Download URL: oscn-0.0.0.89.tar.gz
  • Upload date:
  • Size: 43.1 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.1.1 CPython/3.12.7

File hashes

Hashes for oscn-0.0.0.89.tar.gz
Algorithm Hash digest
SHA256 3701b436e58c9b5af95294c7f791135fb1527eaa7df616ab2cb8cbc68bf88fc8
MD5 a5e2f1fce8754c715182b3fdff870d62
BLAKE2b-256 520ce710873c07e7e47f921efc72ea60fab6ef1fb7ceb97bfd0487190e272d96

See more details on using hashes here.

File details

Details for the file oscn-0.0.0.89-py3-none-any.whl.

File metadata

  • Download URL: oscn-0.0.0.89-py3-none-any.whl
  • Upload date:
  • Size: 50.3 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.1.1 CPython/3.12.7

File hashes

Hashes for oscn-0.0.0.89-py3-none-any.whl
Algorithm Hash digest
SHA256 c13163924fed6d6ec0194be6096e6fe9b21c561f9b3837f4e21b3ab6f6b0c559
MD5 e7f787c7a898048ee92e3e43f2b006b7
BLAKE2b-256 f2fbebd172411dca1a4fe0474904780fbc9d39b44ec6081f5268f5aa5fa1cb7b

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page