refkit 0.0.0__tar.gz → 0.0.1__tar.gz

refkit-0.0.1/.gitignore

@@ -0,0 +1,18 @@
+# Python-generated files
+__pycache__/
+*.py[oc]
+build/
+dist/
+dist*
+wheels/
+*.egg-info
+target/
+*.so
+.coverage
+.pytest_cache/
+.ruff_cache/
+packages/refkit-bench/results/*
+!packages/refkit-bench/results/.gitkeep
+
+# Virtual environments
+.venv

refkit-0.0.1/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 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. Do not 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.

refkit-0.0.1/NOTICE

@@ -0,0 +1,10 @@
+refkit
+
+refkit uses citation and bibliography components from the Typst project ecosystem:
+
+- Hayagriva: bibliography data modeling and CSL citation rendering. License: MIT OR Apache-2.0. Source: https://github.com/typst/hayagriva
+- biblatex: BibTeX and BibLaTeX parsing. License: MIT OR Apache-2.0. Source: https://github.com/typst/biblatex
+- citationberg: CSL style and locale parsing used through Hayagriva. License: MIT OR Apache-2.0. Source: https://github.com/typst/citationberg
+
+Hayagriva and citationberg also acknowledge Citation Style Language style or
+locale resources under CC-BY-SA 3.0 in their upstream NOTICE files.

refkit-0.0.1/PKG-INFO

@@ -0,0 +1,249 @@
+Metadata-Version: 2.4
+Name: refkit
+Version: 0.0.1
+Summary: Fast Python citation parsing, rendering, and BibTeX editing backed by Rust
+Author-email: Péter Ferenc Gyarmati <dev.petergy@gmail.com>
+License-Expression: Apache-2.0
+License-File: LICENSE
+License-File: NOTICE
+Classifier: Development Status :: 3 - Alpha
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: Apache Software License
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Programming Language :: Python :: 3.14
+Classifier: Programming Language :: Rust
+Classifier: Typing :: Typed
+Requires-Python: <3.15,>=3.11
+Requires-Dist: refkit-core==0.0.1
+Description-Content-Type: text/markdown
+
+# refkit
+
+`refkit` reads BibTeX, BibLaTeX, and Hayagriva YAML, renders CSL citations, and edits raw BibTeX documents from Python.
+
+## Install
+
+```bash
+pip install refkit
+```
+
+`refkit` is pure Python and depends on the exact matching `refkit-core` release.
+`refkit-core` contains the Rust/PyO3 extension as `refkit_core._refkit_core`, including PyEmscripten wheels for the Python 3.14 Pyodide runtime.
+
+`refkit` supports CPython 3.11 through 3.14. Native wheels from `refkit-core` use the Python 3.11 stable ABI.
+
+## Render A Citation
+
+```python
+import refkit as rk
+
+library = rk.Library.parse_bibtex(
+    """
+@article{doe2024,
+  author = {Doe, Jane},
+  title = {Fast Citations},
+  journal = {Journal of Citation Tests},
+  year = {2024}
+}
+@book{roe2022,
+  author = {Roe, Richard},
+  title = {Batch References},
+  publisher = {Example Press},
+  year = {2022}
+}
+"""
+)
+style = rk.Style.load("apa")
+doc = rk.Document(library, style, locale="en-US")
+
+rendered = doc.render(
+    [
+        rk.Citation("intro", "doe2024"),
+        rk.Citation(
+            "detail",
+            rk.CitationGroup([rk.Cite("doe2024", locator="12", label="page"), "roe2022"]),
+        ),
+    ]
+)
+
+print(rendered["intro"].text)
+print(rendered["detail"].text)
+print(rendered.bibliography.text)
+```
+
+Expected output:
+
+```text
+(Doe, 2024)
+(Doe, 2024, p. 12; Roe, 2022)
+Doe, J. (2024). Fast Citations. Journal of Citation Tests.
+Roe, R. (2022). Batch References. Example Press.
+```
+
+`Document.render` renders the whole citation document at once. It returns `RenderedDocument`, where `rendered["intro"]` and `rendered["detail"]` are named citation outputs and `rendered.bibliography` is the cited bibliography for those citations.
+`Cite` names one citation item. `CitationGroup` renders several items as one citation. `Citation(id, group)` gives that rendered citation a stable lookup name. Citation ids must be unique inside one `Document.render` call.
+
+For one-off scripts, pass a bibliography path directly:
+
+```python
+rk.cite("refs.bib", "doe2024", style="ieee").text
+rk.full_bibliography("refs.bib", style="chicago-author-date").html
+```
+
+Use `Library.parse_bibtex`, `Library.parse_yaml`, and `Document` when the bibliography source is already in memory or when several citations share the same library and style.
+
+## Capabilities
+
+| Capability | Python surface |
+| --- | --- |
+| Read normalized bibliography data | `Library.read`, `Library.parse_bibtex`, `Library.parse_yaml` |
+| Render citations | `Document.render`, `Citation`, `Cite`, `CitationGroup`, `cite` |
+| Render bibliographies | `Document.cited_bibliography`, `Document.full_bibliography`, `full_bibliography` |
+| Load styles and locales | `Style.load`, `Style.from_path`, `Style.from_xml`, `Locale.load` |
+| Inspect entries | mapping access, `keys`, `get`, `get_many`, `select`, `project`, `to_dicts` |
+| Edit raw BibTeX | `BibDocument.read`, `BibDocument.parse`, field assignment, `write` |
+| Inspect rendered output | `Rendered.text`, `Rendered.html`, `Rendered.tree` |
+
+## Input Formats
+
+| API | Input | Result |
+| --- | --- | --- |
+| `Library.read(path)` | `.bib` | Normalized citation library from BibTeX or BibLaTeX. |
+| `Library.read(path)` | `.yaml`, `.yml` | Normalized citation library from Hayagriva YAML. |
+| `Library.parse_bibtex(source)` | BibTeX or BibLaTeX string | Normalized citation library. |
+| `Library.parse_yaml(source)` | Hayagriva YAML string | Normalized citation library. |
+| `BibDocument.read(path)` | `.bib` | Raw document model with comments, preambles, strings, failed blocks, order, spans, and editable fields. |
+| `Style.load(name)` | Bundled style name such as `apa` | CSL style for rendering. |
+| `Style.from_path(path)` | Independent CSL XML file | CSL style for rendering. |
+| `Style.from_xml(xml)` | Independent CSL XML string | CSL style for rendering. |
+| `Locale.load(code)` | Bundled locale code such as `en-US` | Locale object for rendering. |
+
+Hayagriva YAML is a mapping from citation keys to entry mappings:
+
+```yaml
+doe2024:
+  type: Article
+  author: Doe, Jane
+  title: Refkit for Bibliographies
+  date: 2024
+  parent:
+    type: Periodical
+    title: Journal of Citation Systems
+    volume: 12
+```
+
+```python
+library = rk.Library.parse_yaml(
+    """
+doe2024:
+  type: Article
+  title: Refkit for Bibliographies
+  date: 2024
+"""
+)
+```
+
+## Inspect A Library
+
+`Library` is the normalized citation database. Use it for rendering, selectors, mapping access, and bulk export.
+
+```python
+library = rk.Library.read("refs.bib")
+
+print(library.keys())
+print(library.project(["key", "title", "doi", "volume"]))
+print(library.to_dicts())
+```
+
+`Library.select` accepts Hayagriva selector strings:
+
+```python
+for entry in library.select("article > periodical[volume]"):
+    print(entry.key, entry.title, entry.parents[0].title)
+```
+
+## Edit Raw BibTeX
+
+`BibDocument` preserves the raw `.bib` structure that normalized rendering does not need: comments, preambles, string definitions, failed blocks, order, and source spans.
+
+```python
+raw = rk.BibDocument.read("refs.bib")
+raw.entries["doe2024"].fields["title"].value = "Corrected title"
+raw.write("refs.bib")
+```
+
+Direct map lookup requires one matching entry key and one matching field name. `unique_keys()` returns one key per name. `occurrence_keys()` returns keys in source order, including duplicates. When a file contains duplicates, choose the source-order occurrence explicitly:
+
+```python
+raw = rk.BibDocument.read("refs.bib")
+
+second_entry = raw.entries.get_all("doe2024")[1]
+second_entry.fields.get_all("title")[0].value = "Corrected title"
+raw.write("refs.bib")
+```
+
+## Inspect Rendered Output
+
+`Document.render`, `Document.cited_bibliography`, `Document.full_bibliography`, `cite`, and `full_bibliography` return rendered values.
+
+```python
+rendered = doc.render([rk.Citation("intro", "doe2024")])
+citation = rendered["intro"]
+
+print(citation.text)
+print(citation.html)
+print(citation.tree)
+```
+
+`Rendered.tree` returns structured nodes for text, links, element metadata, transparent citation fragments, and bibliography entries.
+
+## Use With Polars
+
+Install `polars-refkit` when BibTeX source lives in a dataframe and the result should stay in a Polars query plan.
+
+```python
+import polars as pl
+import polars_refkit as prk
+
+df = pl.DataFrame(
+    {
+        "bibtex": ["@article{doe2024, title={Fast Citations}, year={2024}}"],
+        "key": ["doe2024"],
+        "keys": [["doe2024"]],
+    }
+)
+
+out = df.select(
+    citation=pl.col("bibtex").refkit.cite(pl.col("key")),
+    each_citation=pl.col("bibtex").refkit.cite_each(pl.col("keys")),
+    grouped_citation=pl.col("bibtex").refkit.cite_group(pl.col("keys")),
+    count=pl.col("bibtex").refkit.entry_count(),
+    keys=pl.col("bibtex").refkit.keys(),
+    entries=pl.col("bibtex").refkit.entries(),
+)
+```
+
+## Development
+
+```bash
+uv sync --all-packages --group dev
+(cd packages/refkit-core-py && uv run maturin develop)
+uv run pytest packages/refkit/tests --no-cov
+```
+
+The workspace also provides:
+
+```bash
+make lint
+make typecheck
+make test
+make rust
+make build
+```
+
+## License
+
+`refkit` is licensed under the Apache License, Version 2.0, available in [LICENSE](LICENSE). See [NOTICE](NOTICE) for upstream citation and bibliography component acknowledgements.