fjc-idb 0.0.2__tar.gz

fjc_idb-0.0.2/.editorconfig

@@ -0,0 +1,31 @@
+# Sets default formatting options for many editors and IDEs
+
+# https://editorconfig.org/
+
+root = true
+
+[*]
+charset = utf-8
+insert_final_newline = true
+indent_size = 4
+indent_style = space
+trim_trailing_whitespace = true
+
+# Docstrings and comments use max_line_length = 79
+[*.py]
+max_line_length = 80
+
+# The JSON files contain newlines inconsistently
+[*.json]
+indent_size = 2
+insert_final_newline = ignore
+
+# Makefiles always use tabs for indentation
+[Makefile]
+indent_style = tab
+
+[*.{yml, yaml, toml, html}]
+indent_size = 2
+
+[*.md]
+trim_trailing_whitespace = false

fjc_idb-0.0.2/.github/ISSUE_TEMPLATE/bug_report.md

@@ -0,0 +1,37 @@
+---
+name: Bug report
+about: Create a report to help us improve
+title: ''
+labels: unconfirmed
+assignees: ''
+
+---
+
+**Describe the bug**
+
+A clear and concise description of what the bug is.
+
+**To Reproduce**
+
+Steps to reproduce the behavior:
+1. Go to '...'
+2. Run command '...'
+3. Scroll down to '...'
+4. See error
+
+**Expected behavior**
+
+A clear and concise description of what you expected to happen.
+
+**Screenshots**
+
+If applicable, add screenshots to help explain your problem.
+
+**System (please complete the following information):**
+
+- `fjc idb` version: [e.g. 0.2.1]
+- Python version: [e.g. 3.9]
+- OS: [Windows/Linux/MacOS]
+
+**Additional context**
+Add any other context about the problem here.

fjc_idb-0.0.2/.github/ISSUE_TEMPLATE/feature_request.md

@@ -0,0 +1,24 @@
+---
+name: Feature request
+about: Suggest an idea for this project
+title: ''
+labels: feature
+assignees: ''
+
+---
+
+**Is your feature request related to a problem? Please describe.**
+
+A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
+
+**Describe the solution you'd like**
+
+A clear and concise description of what you want to happen.
+
+**Describe alternatives you've considered**
+
+A clear and concise description of any alternative solutions or features you've considered.
+
+**Additional context**
+
+Add any other context or screenshots about the feature request here.

fjc_idb-0.0.2/.github/dependabot.yml

@@ -0,0 +1,57 @@
+# Automatically updates dependency versions using dependabot.
+
+# version: 2
+# updates:
+
+# Maintains dependencies for Python via `pip`
+# - package-ecosystem: pip
+#   directory: "/"
+#   # Always updates to a newer version. If you want a less aggressive strategy,
+#   # change the value to "increase-if-necessary"
+#   versioning-strategy: increase
+#   schedule:
+#     interval: weekly
+#     time: "5:00"
+
+# # Maintains dependencies for GitHub Actions
+# - package-ecosystem: github-actions
+#   directory: "/"
+#   schedule:
+#     interval: "weekly"
+#     time: "6:00"
+
+version: 2
+updates:
+  - package-ecosystem: pip
+    directory: "/docs"
+    schedule:
+      interval: daily
+      time: "04:00"
+      timezone: "Europe/Berlin"
+    labels:
+      - "cookiecutter"
+      - "dependencies"
+      - "python"
+    open-pull-requests-limit: 99
+  - package-ecosystem: pip
+    directory: "/.github/workflows"
+    schedule:
+      interval: daily
+      time: "04:00"
+      timezone: "Europe/Berlin"
+    labels:
+      - "cookiecutter"
+      - "dependencies"
+      - "python"
+    open-pull-requests-limit: 99
+  - package-ecosystem: github-actions
+    directory: "/"
+    schedule:
+      interval: daily
+      time: "04:00"
+      timezone: "Europe/Berlin"
+    labels:
+      - "cookiecutter"
+      - "dependencies"
+      - "github_actions"
+    open-pull-requests-limit: 99

fjc_idb-0.0.2/.github/workflows/ci.yml

@@ -0,0 +1,119 @@
+# Automatically performs jobs upon a commit push or pull-request
+
+# This Action builds, tests, and lints the package. Then, it builds the
+# documentation and deploys it on GitHub Pages.
+
+# If the commit message matches a semantic version (e.g. "v0.1.2"), a GitHub
+# release will be created by the `create_github_release` job.
+
+name: continuous integration
+
+# Allows this Action to be called by a push or pull request
+on: [push, pull_request]
+
+permissions:
+  contents: write
+  pull-requests: write
+
+env:
+  DISABLE_MKDOCS_2_WARNING: "true"
+
+jobs:
+
+  build_and_test:
+    runs-on: ${{ matrix.os }}
+    strategy:
+      fail-fast: false
+      matrix:
+        python-version: ["3.11", "3.12", "3.13", "3.14"]
+        os: [ubuntu-latest, macos-latest, windows-latest]
+
+    steps:
+    - name: checkout repository
+      uses: actions/checkout@v7
+
+    - name: install python
+      uses: actions/setup-python@v7
+      with:
+        python-version: ${{ matrix.python-version }}
+
+    - name: install uv
+      uses: astral-sh/setup-uv@v10.2.0
+
+    - name: install dependencies
+      run: uv sync --python ${{ matrix.python-version }}
+
+    - name: run pre-commit
+      run: uv run pre-commit run -a --show-diff-on-failure
+
+    - name: run tests
+      run: uv run pytest tests
+
+  lint_and_format:
+    runs-on: ubuntu-latest
+
+    steps:
+    - name: checkout repository
+      uses: actions/checkout@v7
+
+    - name: install uv
+      uses: astral-sh/setup-uv@v10.2.0
+
+    - name: install dependencies
+      run: uv sync
+
+    - name: run ruff
+      run: uv run ruff check --no-fix --output-format=github
+
+    - name: run mypy
+      run: uv run mypy
+
+  document_and_deploy:
+    runs-on: ubuntu-latest
+
+    steps:
+    - name: checkout repository
+      uses: actions/checkout@v7
+
+    - name: install uv
+      uses: astral-sh/setup-uv@v10.2.0
+
+    - name: install dependencies
+      run: uv sync
+
+    - name: build documentation with mkdocs
+      run: uv run mkdocs build
+
+    - name: deploy documentation to github pages
+      if: github.event_name == 'push' && github.ref == 'refs/heads/main'
+      run: uv run mkdocs gh-deploy --force --clean --verbose
+
+  # Only creates a release if a line of the commit message is a semantic version
+  # (e.g. "v0.1.2"), which can be followed by other lines, such as a
+  # "Co-Authored-By:" trailer. The release notes are generated by GitHub.
+  create_github_release:
+    name: create github release
+    if: github.event_name == 'push'
+    runs-on: ubuntu-latest
+
+    steps:
+    - name: initiate github release
+      env:
+        GH_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+        COMMIT_MESSAGE: ${{ github.event.head_commit.message }}
+      run: |
+        semver='[0-9]+\.[0-9]+\.[0-9]+(-[0-9A-Za-z.-]+)?(\+[0-9A-Za-z.-]+)?'
+        version=$(printf '%s\n' "$COMMIT_MESSAGE" | tr -d '\r' \
+          | grep -E -m 1 "^v${semver}$" || true)
+        if [ -z "$version" ]; then
+          echo "The commit message has no version, so no release was created."
+          exit 0
+        fi
+        # A version with a pre-release identifier (e.g. "v1.0.0-beta.1") is
+        # marked as a pre-release.
+        prerelease=$(case "${version%%+*}" in *-*) echo --prerelease;; esac)
+        gh release create "$version" \
+          --repo "$GITHUB_REPOSITORY" \
+          --target "$GITHUB_SHA" \
+          --title "Release: $version" \
+          --generate-notes $prerelease

fjc_idb-0.0.2/.github/workflows/publish.yml

@@ -0,0 +1,34 @@
+# Securely publishes the repository on PyPI
+
+
+# To make this action work, you need to configure PyPI properly, using this
+# guide: https://docs.pypi.org/trusted-publishers/adding-a-publisher/
+
+name: publish
+
+# Allows this Action to be called by other Actions or through GitHub
+on: [workflow_call, workflow_dispatch]
+
+jobs:
+
+  pypi_publish:
+    name: publish to pypi
+    runs-on: ubuntu-latest
+    permissions:
+      # This permission is needed for private repositories.
+      contents: read
+      # IMPORTANT: this permission is mandatory for trusted publishing
+      id-token: write
+
+    steps:
+    - name: get repository
+      uses: actions/checkout@v7
+
+    - name: install uv
+      uses: astral-sh/setup-uv@v10.2.0
+
+    - name: build package
+      run: uv build
+
+    - name: push to pypi
+      run: uv publish

fjc_idb-0.0.2/.gitignore

@@ -0,0 +1,141 @@
+# Byte-compiled
+__pycache__/
+*.py[cod]
+*$py.class
+
+# C extensions
+*.so
+
+# Distribution
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+pip-wheel-metadata/
+share/python-wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+MANIFEST
+
+# PyInstaller
+*.manifest
+*.spec
+
+# Installer Logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit Testing
+htmlcov/
+.tox/
+.nox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*.cover
+*.py,cover
+.hypothesis/
+.pytest_cache/
+
+# Translations
+*.mo
+*.pot
+
+# Django
+*.log
+local_settings.py
+db.sqlite3
+db.sqlite3-journal
+
+# Flask
+instance/
+.webassets-cache
+
+# Scrapy
+.scrapy
+
+# Sphinx
+docs/_build/
+
+# PyBuilder
+target/
+
+# Jupyter
+.ipynb_checkpoints
+
+# IPython
+profile_default/
+ipython_config.py
+
+# pyenv (.python-version is kept in the repository to pin Python 3.11)
+
+# pipenv
+Pipfile.lock
+
+# Celery
+celerybeat-schedule
+celerybeat.pid
+
+# SageMath
+*.sage.py
+
+# Environments
+.env
+.venv
+env/
+venv/
+ENV/
+env.bak/
+venv.bak/
+
+# Spyder
+.spyderproject
+.spyproject
+
+# Rope
+.ropeproject
+
+# MkDocs
+/site
+
+# mypy
+.mypy_cache/
+.dmypy.json
+dmypy.json
+
+# Pyre
+.pyre/
+
+# VS Code
+.vscode/
+
+# VS Code counter
+.VSCodeCounter/
+
+# PyCharm
+.idea/
+
+# PDM
+.copier-answers.yml
+.idea/
+.pdm-plugins/
+.pdm-python
+__pypackages__/
+
+# Cython
+cython_debug/
+
+# Ruff
+/.ruff_cache/

fjc_idb-0.0.2/.pre-commit-config.yaml

@@ -0,0 +1,32 @@
+repos:
+
+- repo: https://github.com/pre-commit/pre-commit-hooks
+  rev: "v6.0.0"
+  hooks:
+  - id: check-added-large-files
+  - id: check-ast
+  - id: check-json
+  - id: check-toml
+  - id: detect-private-key
+  - id: end-of-file-fixer
+  - id: trailing-whitespace
+
+- repo: https://github.com/astral-sh/ruff-pre-commit
+  # Ruff version.
+  rev: v0.16.9
+  hooks:
+    # Run the linter.
+    - id: ruff
+      args: [ --fix ]
+
+- repo: https://github.com/astral-sh/uv-pre-commit
+  # uv version.
+  rev: 0.12.20
+  hooks:
+    - id: uv-lock
+
+- repo: https://github.com/jsh9/pydoclint
+  rev: 0.10.1
+  hooks:
+    - id: pydoclint
+      args: [--style=google, --check-return-types=False, --arg-type-hints-in-docstring=False]

fjc_idb-0.0.2/.python-version

@@ -0,0 +1 @@
+3.11

fjc_idb-0.0.2/CHANGELOG.md

@@ -0,0 +1,43 @@
+# Changelog
+
+All notable changes to this project will be documented in this file.
+
+<!-- insertion marker -->
+
+## 0.0.2
+
+### Added
+
+- Parsing for three types of FJC Integrated Database (IDB) files: courts of
+  appeals, civil cases in the district courts, and criminal defendants in the
+  district courts. The parsing follows the current FJC codebooks and has been
+  tested on the files from 2008 through 2026.
+- `run` exports a range of years to a CSV file, one yearly file at a time to
+  keep memory use low. `import_data`, `parse_data`, and `export_data` work on
+  the data in memory.
+- `download` and `list_files` get the yearly SAS files and codebooks from the
+  FJC website.
+- The `fjc-idb` command (also `python -m fjc_idb`) with `--start-year`,
+  `--stop-year`, `--data-folder`, `--rename-columns`, `--fix-city-spellings`,
+  `--download`, `--download-only`, and `--overwrite`.
+- Descriptive column names, labels in place of codes (circuits, districts,
+  courthouses, agencies, dispositions, and more), and correct handling of the
+  IDB's missing-value codes.
+- Pending cases are kept only from the latest yearly file, so combining years
+  does not count a case more than once.
+- Added columns: indicators for appeal types and for groups of criminal
+  offenses and natures of suit, the days between key dates, counts of
+  concurrences and dissents, whether a decision was published, whether any
+  party was pro se, and a standard appellate docket number.
+- Documentation: a tutorial, an advanced user guide, recipes, an API
+  reference, and codebooks for the appellate, criminal, and civil CSV files.
+
+### Fixed
+
+- Continuous integration: removed Python 3.10 from the test matrix (pandas 3
+  requires Python 3.11 or later), fixed ruff and mypy errors, removed the
+  ruff-format pre-commit hook, and replaced the outdated release action.
+
+## 0.0.1
+
+    Initial Commit

fjc_idb-0.0.2/CODE_OF_CONDUCT.md

@@ -0,0 +1,79 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to make participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, sex characteristics, gender identity and expression,
+level of experience, education, socio-economic status, nationality, personal
+appearance, race, religion, or sexual identity and orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+  advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies within all project spaces, and it also applies when
+an individual is representing the project or its community in public spaces.
+Examples of representing a project or community include using an official
+project e-mail address, posting via an official social media account, or acting
+as an appointed representative at an online or offline event. Representation of
+a project may be further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting any of the following people:
+
+* Corey Rayburn Yung (coreyrayburnyung@gmail.com)
+
+All complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at https://www.contributor-covenant.org/version/1/4/code-of-conduct.html
+
+[homepage]: https://www.contributor-covenant.org
+
+For answers to common questions about this code of conduct, see
+https://www.contributor-covenant.org/faq

fjc_idb-0.0.2/CONTRIBUTING.md

@@ -0,0 +1,54 @@
+# Contributing
+
+Contributions are welcome and greatly appreciated!
+Every little bit helps, and credit will always be given.
+Environment Setup
+
+## Development
+
+Follow this basic process:
+
+1. Fork and clone the repositor.
+2. Create a new branch: `git checkout -b feature-or-bugfix-name`.
+3. Edit the code.
+4. If you added functionality or features, update the documentation accordingly.
+
+If you are unsure about how to fix or ignore a warning, just let the continuous
+integration fail, and we will help you during review.
+
+Don't bother updating the changelog, we will take care of this.
+
+## Pull requests guidelines
+
+Link to any related issue in the Pull Request message.
+
+During the review, we recommend using fixups:
+
+```bash
+# SHA is the SHA of the commit you want to fix
+git commit --fixup=SHA
+```
+
+Once all the changes are approved, you can squash your commits:
+
+```bash
+git rebase -i --autosquash main
+```
+
+And force-push:
+
+```bash
+git push -f
+```
+
+If this seems all too complicated, you can push or force-push each new commit,
+and we will squash them ourselves if needed, before merging.
+
+## Style Guidelines
+
+This package follows the [Google
+Python Style Guide](https://google.github.io/styleguide/pyguide.html) with two
+notable exceptions:
+
+1. It always adds spaces around "=". This not only violates the Google guide, it violates [PEP8](https://peps.python.org/pep-0008/), the foundational Python style guide from which all other resources are derived. I defy this strong, long-standign norm because I find it more readable. My brain and eyes have trouble seeing two separate objects when an equal sign is in the middle. I imagine that I am not alone in this accessibility issue. Further, as PEP8 itself notes, required spaces around equal signs are becoming increasing common with type annotations becoming part of best practices (and, as a result, signatures to classes, functions, and methods regularly include spaces around the equal signs). I realize that this will seem alien to many coders, but it is far easier on my eyes.
+2. I use some so-called "power features", primarily dunder methods, to make my interfaces easier to access and use. This is disfavored in the Google Python Style Guide because such code is often more difficult for others to read. To address that concern, I try to document and comment as to what the code is doing whenever I used any of the "power features" of Python.

fjc_idb-0.0.2/LICENSE

@@ -0,0 +1,15 @@
+Apache Software License 2.0
+
+Copyright (c) 2026, Corey Rayburn Yung
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.