moleg-api 0.1.1__tar.gz → 0.2.0__tar.gz

moleg_api-0.2.0/PKG-INFO

@@ -0,0 +1,97 @@
+Metadata-Version: 2.4
+Name: moleg-api
+Version: 0.2.0
+Summary: Task-level Python interface for loading Korean legal sources from law.go.kr
+Author: MOLEG-API maintainers
+License-Expression: MIT
+Project-URL: Homepage, https://github.com/tjdwls101010/MOLEG-API
+Project-URL: Documentation, https://github.com/tjdwls101010/MOLEG-API/tree/main/wiki
+Project-URL: Repository, https://github.com/tjdwls101010/MOLEG-API
+Project-URL: Issues, https://github.com/tjdwls101010/MOLEG-API/issues
+Keywords: korea,law,legislation,moleg,law.go.kr
+Classifier: Development Status :: 3 - Alpha
+Classifier: Intended Audience :: Developers
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Topic :: Software Development :: Libraries :: Python Modules
+Classifier: Typing :: Typed
+Requires-Python: >=3.10
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Provides-Extra: dev
+Requires-Dist: psycopg[binary]<4,>=3.2; extra == "dev"
+Requires-Dist: pytest<9,>=8; extra == "dev"
+Provides-Extra: test
+Requires-Dist: pytest<9,>=8; extra == "test"
+Dynamic: license-file
+
+# moleg-api
+
+`moleg-api` is a task-level Python interface for loading Korean legal sources from [law.go.kr](https://www.law.go.kr/). It normalizes the Ministry of Government Legislation (법제처) OpenAPI so applications and agents can retrieve legal context without memorizing individual `target` values, identifier rules (`ID`, `MST`, `LID`, `JO`), or per-endpoint response quirks.
+
+You pick an interface by the legal task you need — search a statute, load an article, trace an amendment, find a delegated rule, read a Constitutional Court decision — not by a raw endpoint name. It is not a complete wrapper around every law.go.kr endpoint; the public interface is intentionally small and deep. The recurring pattern is **search or plan first, then load** the selected source: search hits are candidates, not citable text.
+
+The PyPI package is `moleg-api`; import it as `moleg_api`.
+
+## Install
+
+```bash
+pip install moleg-api
+```
+
+Live calls use a law.go.kr OpenAPI credential (the "OC" — a free, non-secret account id). The package ships a shared default, so calls work out of the box with **no registration required**. To use your own OC (recommended for heavy use), register at law.go.kr and set `MOLEG_OC`, or pass `oc=` to `LawGoKrClient`. See [Installation](wiki/Installation.md).
+
+## Quickstart
+
+Python — search, then load the chosen candidate:
+
+```python
+from moleg_api import MolegApi
+
+api = MolegApi()
+hits = api.search_laws("주택임대차보호법")        # candidate identities
+article = api.get_article(hits[0].identity, "제3조")  # loaded source text
+print(article.text)
+```
+
+Shell — every method is also a `moleg` subcommand printing one JSON envelope:
+
+```bash
+python -m moleg_api catalog                          # self-documenting command list
+python -m moleg_api search-laws "주택임대차보호법"    # → candidates with law_id
+python -m moleg_api get-article --law 001248 제3조    # load the current article
+python -m moleg_api get-article --law 001248 --as-of 2021-01-01 제3조  # the version in force then
+```
+
+Public dataclasses serialize recursively with `to_dict()` / `to_json_string()` (raw payloads omitted unless `include_raw=True`).
+
+## What it covers
+
+- Current (`effective`) and promulgated (`promulgated`) statutes and articles, including moved/deleted status
+- Supplementary provisions (부칙), law history, and before/after text comparison
+- Historical versions — load the text in force on a past date with `as_of`
+- Delegated rules, legal hierarchy, and administrative rules (고시·훈령·예규)
+- Law and administrative-rule annex/form bodies (별표·서식)
+- MOLEG and ministry legal interpretations, Supreme Court cases, and Constitutional Court (헌재) decisions
+- Query expansion, comparable-mechanism discovery, and staged context bundles with executable follow-up lookups
+
+Out of scope: legal advice, National Assembly bill data (status, votes, minutes), and latest statistics/news.
+
+## Documentation
+
+Full documentation is in the [`wiki/`](wiki/Home.md) folder:
+
+- [Installation](wiki/Installation.md) · [Quickstart](wiki/Quickstart.md) · [Core Concepts](wiki/Core-Concepts.md)
+- [CLI Reference](wiki/CLI-Reference.md) · [API Reference](wiki/API-Reference.md)
+- [Historical Versions](wiki/Historical-Versions.md) · [Sources & Coverage](wiki/Sources-and-Coverage.md)
+- [Gotchas](wiki/Gotchas.md) · [Error Handling](wiki/Error-Handling.md)
+
+## Status
+
+Alpha (`0.2.x`). The interface is ready for use, but law.go.kr live behavior can vary by source, credential, and endpoint availability. Treat search results as candidates until a detail loader has retrieved source text. This package is a legal-source loader, not legal advice.
+
+## License
+
+MIT — see [LICENSE](LICENSE).

moleg_api-0.2.0/README.md

@@ -0,0 +1,68 @@
+# moleg-api
+
+`moleg-api` is a task-level Python interface for loading Korean legal sources from [law.go.kr](https://www.law.go.kr/). It normalizes the Ministry of Government Legislation (법제처) OpenAPI so applications and agents can retrieve legal context without memorizing individual `target` values, identifier rules (`ID`, `MST`, `LID`, `JO`), or per-endpoint response quirks.
+
+You pick an interface by the legal task you need — search a statute, load an article, trace an amendment, find a delegated rule, read a Constitutional Court decision — not by a raw endpoint name. It is not a complete wrapper around every law.go.kr endpoint; the public interface is intentionally small and deep. The recurring pattern is **search or plan first, then load** the selected source: search hits are candidates, not citable text.
+
+The PyPI package is `moleg-api`; import it as `moleg_api`.
+
+## Install
+
+```bash
+pip install moleg-api
+```
+
+Live calls use a law.go.kr OpenAPI credential (the "OC" — a free, non-secret account id). The package ships a shared default, so calls work out of the box with **no registration required**. To use your own OC (recommended for heavy use), register at law.go.kr and set `MOLEG_OC`, or pass `oc=` to `LawGoKrClient`. See [Installation](wiki/Installation.md).
+
+## Quickstart
+
+Python — search, then load the chosen candidate:
+
+```python
+from moleg_api import MolegApi
+
+api = MolegApi()
+hits = api.search_laws("주택임대차보호법")        # candidate identities
+article = api.get_article(hits[0].identity, "제3조")  # loaded source text
+print(article.text)
+```
+
+Shell — every method is also a `moleg` subcommand printing one JSON envelope:
+
+```bash
+python -m moleg_api catalog                          # self-documenting command list
+python -m moleg_api search-laws "주택임대차보호법"    # → candidates with law_id
+python -m moleg_api get-article --law 001248 제3조    # load the current article
+python -m moleg_api get-article --law 001248 --as-of 2021-01-01 제3조  # the version in force then
+```
+
+Public dataclasses serialize recursively with `to_dict()` / `to_json_string()` (raw payloads omitted unless `include_raw=True`).
+
+## What it covers
+
+- Current (`effective`) and promulgated (`promulgated`) statutes and articles, including moved/deleted status
+- Supplementary provisions (부칙), law history, and before/after text comparison
+- Historical versions — load the text in force on a past date with `as_of`
+- Delegated rules, legal hierarchy, and administrative rules (고시·훈령·예규)
+- Law and administrative-rule annex/form bodies (별표·서식)
+- MOLEG and ministry legal interpretations, Supreme Court cases, and Constitutional Court (헌재) decisions
+- Query expansion, comparable-mechanism discovery, and staged context bundles with executable follow-up lookups
+
+Out of scope: legal advice, National Assembly bill data (status, votes, minutes), and latest statistics/news.
+
+## Documentation
+
+Full documentation is in the [`wiki/`](wiki/Home.md) folder:
+
+- [Installation](wiki/Installation.md) · [Quickstart](wiki/Quickstart.md) · [Core Concepts](wiki/Core-Concepts.md)
+- [CLI Reference](wiki/CLI-Reference.md) · [API Reference](wiki/API-Reference.md)
+- [Historical Versions](wiki/Historical-Versions.md) · [Sources & Coverage](wiki/Sources-and-Coverage.md)
+- [Gotchas](wiki/Gotchas.md) · [Error Handling](wiki/Error-Handling.md)
+
+## Status
+
+Alpha (`0.2.x`). The interface is ready for use, but law.go.kr live behavior can vary by source, credential, and endpoint availability. Treat search results as candidates until a detail loader has retrieved source text. This package is a legal-source loader, not legal advice.
+
+## License
+
+MIT — see [LICENSE](LICENSE).

moleg_api-0.2.0/moleg_api/__main__.py

@@ -0,0 +1,8 @@
+"""Enable ``python -m moleg_api`` as the CLI entry point."""
+
+import sys
+
+from .cli import main
+
+if __name__ == "__main__":
+    sys.exit(main())