courtpy 0.1.0__tar.gz

courtpy-0.1.0/.gitignore

@@ -0,0 +1,155 @@
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[cod]
+*$py.class
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.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
+#  Usually these files are written by a python script from a template
+#  before PyInstaller builds the exe, so as to inject date/other infos into it.
+*.manifest
+*.spec
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.nox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*.cover
+*.py,cover
+.hypothesis/
+.pytest_cache/
+
+# Translations
+*.mo
+*.pot
+
+# Django stuff:
+*.log
+local_settings.py
+db.sqlite3
+db.sqlite3-journal
+
+# Flask stuff:
+instance/
+.webassets-cache
+
+# Scrapy stuff:
+.scrapy
+
+# Sphinx documentation
+docs/_build/
+
+# PyBuilder
+target/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# IPython
+profile_default/
+ipython_config.py
+
+# pyenv
+.python-version
+
+# pipenv
+#   According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
+#   However, in case of collaboration, if having platform-specific dependencies or dependencies
+#   having no cross-platform support, pipenv may install dependencies that don't work, or not
+#   install all needed dependencies.
+#Pipfile.lock
+
+# PEP 582; used by e.g. github.com/David-OConnor/pyflow
+__pypackages__/
+
+# Celery stuff
+celerybeat-schedule
+celerybeat.pid
+
+# SageMath parsed files
+*.sage.py
+
+# Environments
+.env
+.venv
+env/
+venv/
+ENV/
+env.bak/
+venv.bak/
+
+# Spyder project settings
+.spyderproject
+.spyproject
+
+# Rope project settings
+.ropeproject
+
+# mkdocs documentation
+/site
+
+# mypy
+.mypy_cache/
+.dmypy.json
+dmypy.json
+
+# Pyre type checker
+.pyre/
+
+# VS Code settings
+.vscode/settings.json
+.vscode/*.*
+.vscode/
+
+# VS Code counter
+.VSCodeCounter/*.*
+.VSCodeCounter/**
+
+# Ruff
+.ruff_cache/
+
+# Secrets: never commit an API key (courtpy keeps it outside the project)
+.env
+.env.*
+secrets.toml
+
+# Court opinions, bulk data, and results made by courtpy
+data/
+court_listener/
+lexis_nexis/
+results/
+.courtpy/
+*.csv.bz2
+*.part

courtpy-0.1.0/CHANGELOG.md

@@ -0,0 +1,99 @@
+# Changelog
+
+All notable changes to this project will be documented in this file.
+
+<!-- insertion marker -->
+
+## 0.1.0
+
+The first release, and the first on PyPI. It is a complete rewrite of the
+earlier, unreleased CourtPy, which was built on siMpLify. The analysis is now
+done with [amos](https://github.com/WithPrecedent/amos) (and its workflows
+with [chrisjen](https://github.com/WithPrecedent/chrisjen)). The changes below
+are from that earlier code.
+
+### Added
+
+* Downloads from CourtListener, now the main source of opinions:
+  * `BulkData` extracts cases from CourtListener's quarterly bulk data, which
+    needs no API key and has no limits. It downloads the files (resuming an
+    interrupted download) or streams them.
+  * `CourtListener` downloads cases with the REST API (version 4). It spaces
+    its requests, waits when CourtListener asks it to, and saves its place so
+    that a download stopped by an account's limit resumes where it stopped.
+  * Both save each case as a JSON file, which `courtlistener.read_case` reads.
+    CourtListener's header information comes from its data, so no rules are
+    needed to find it.
+* `courtpy.secrets` keeps the CourtListener API key outside of any project:
+  in the system keyring, in a private file in the user's configuration folder,
+  in the `COURTLISTENER_API_KEY` environment variable, or in a `.env` file.
+* A single rule engine (`Rule` and `Rulebook`) for every CSV file of rules,
+  with one set of columns (`target`, `variable`, `kind`, `pattern`, `value`,
+  `ignorecase`, `dotall`, and `note`) and nine kinds of rules. See
+  `src/courtpy/instructions/README.md`.
+* The coders `code_parties`, `code_case_type`, `code_outcome`, and `drop_text`,
+  which are `amos` techniques and can be named in any `amos` settings.
+* `courtpy.Project`, an `amos.Project` whose "cases" section collects, parses,
+  and codes the cases before the analysis.
+* The `courtpy` command (`key`, `download`, `split`, `parse`, `rules`, and
+  `run`).
+* Tests, and an example study (`examples/federal_appeals.ini`).
+* The parts of the [snickerdoodle](https://github.com/WithPrecedent/snickerdoodle)
+  template: GitHub Actions (tests on Linux, macOS, and Windows with Python
+  3.11 to 3.14, linting, type checking, documentation deployed to GitHub
+  Pages, releases, publishing to PyPI, and validating the Codecov settings),
+  dependabot, issue templates, pre-commit hooks, an editor configuration, a
+  code of conduct, a contribution guide, and documentation built with MkDocs
+  (a tutorial, an advanced user guide, a guide to writing rules, recipes, and
+  the API reference).
+
+### Changed
+
+* The package uses a `src` layout and is built with hatchling and uv.
+* The old instruction files were converted to the new columns:
+  `organizer_lexis_nexis.csv` and `separate_opinions.csv` became
+  `lexis_nexis.csv`, `keywords_federal.csv` became `federal/header.csv`, and
+  `parser_opinions_federal.csv` became `federal/opinion.csv` (and is now
+  saved in UTF-8). Some variables were renamed to be easier to read, such as
+  `party_appnt1` to `party1_appellant`, `counsel_us_atty` to
+  `counsel_us_attorney`, `notice_unpub_rule` to `notice_unpublished`, and
+  `disposition_op_reversed` to `opinion_reverse`.
+* A decision is coded as a reversal from its stated disposition when it has
+  one, and only otherwise from the opinion's words. (Before, either one was
+  enough, so "we will not reverse" in an affirmed case counted as a
+  reversal.)
+* Which party won an appeal is now coded from the party's role: an appellant
+  wins a reversal, and an appellee wins an affirmance. (The old code had the
+  two reversed.) Outcomes that cannot be known are missing values rather than
+  false.
+* Judges' names are split at whole words only, so names such as "Kirby" and
+  "Holland" are no longer cut at "BY" and "AND".
+
+### Fixed in the rules
+
+* `Fed_App_P`, `Fed_Civ_P`, `Fed_Crim_P`, and `Fed_Evid` required a "§" sign,
+  which is not used when federal rules are cited, so they never matched. The
+  evidence rule's pattern was also malformed.
+* `references_case` now includes the Federal Reporter, Fourth Series (F.4th).
+* `amend8` searched for the Seventh Amendment's numeral ("VII").
+* `titlevii` required the text "Title VII.," followed by a space.
+* `alcohol` searched for "ddistilled".
+* The opinion's dispositions (`opinion_reverse`, `opinion_vacate`,
+  `opinion_remand`, and `opinion_dismiss`) only matched "We willreverse" (with
+  no space) or a capitalized "Dismiss".
+* The variables `criminal_manslaugther` and `general_aritcleiv` are now
+  `criminal_manslaughter` and `general_articleiv`.
+* Non-breaking spaces in patterns now match any space.
+* Lexis-Nexis header sections that end the header (such as a "JUDGES:"
+  paragraph just before "OPINION") are now found.
+* Agencies are matched from the longest name down, so "Postal Service Board of
+  Contract Appeals" is no longer labeled "Postal Service".
+
+### Removed
+
+* The siMpLify-based modules (`almanac`, `cookbook`, `entities`, `implements`,
+  `cases.py`, and `controller.py`) and the settings files that went with them.
+* The `federal_archive` instruction files, which the combined files had
+  replaced.
+* The external data used to add judges' biographies and political context is
+  kept in `reference/`, but is not yet used by the new version.

courtpy-0.1.0/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   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.