Skip to content

mirrulations/mirrulations-fetch

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

6 Commits
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

mirrulations-fetch

This is a command line tool that allows data scientists and researchers to efficiently download all data for a single docket from the public AWS Open Data S3 bucket mirrulations.

Features

  • Downloads all text and (optionally) binary data for a given docket.
  • Shows live progress and ETA.
  • Does not require AWS credentials (uses public/unsigned access).

Requirements

  • Python 3.9+

Install

The setup.py works with pip to create a command mirrulations-fetch. It is recommended that you create a virtual environment and install locally:

python3 -m venv .venv
source .venv/bin/activate
pip install .

Usage

mirrulations-fetch <docket_id> [OPTIONS]

Arguments

  • <docket_id>: The docket ID (e.g., DEA-2024-0059)

Options

  • --output-folder <target>: Target output folder (default: current directory)
  • --include-binary: Include binary data in the download (default: off)
  • --no-comments: Skip comments and derived-data (comment-related data only)

Examples

Download all data for docket DEA-2024-0059 from the DEA agency into the current directory:

mirrulations-fetch DEA-2024-0059

Download including binary data, into a custom folder named mydata:

mirrulations-fetch DEA-2024-0059 --include-binary --output-folder ./mydata

Download docket and documents only (no comments or derived-data):

mirrulations-fetch DEA-2024-0059 --no-comments

Output Structure

The downloaded data will be organized as follows:

<output-folder>/
  <docket_id>/
    raw-data/
      docket/
      documents/
      comments/
      binary-<docket_id>/   # (if --include-binary)
    derived-data/
      <all derived data folders and files>

License

This project is licensed under the MIT License.

About

No description, website, or topics provided.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors

Languages