paperstack-cli 0.1.0__tar.gz → 0.3.1__tar.gz

paperstack_cli-0.3.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/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.

paperstack_cli-0.3.1/PKG-INFO

@@ -0,0 +1,141 @@
+Metadata-Version: 2.5
+Name: paperstack-cli
+Version: 0.3.1
+Summary: Review, inspect, and retrieve research sources from one CLI
+Project-URL: Repository, https://github.com/MilkClouds/paperstack
+Project-URL: Issues, https://github.com/MilkClouds/paperstack/issues
+License-File: LICENSE
+Requires-Python: >=3.11.4
+Requires-Dist: polars>=1.43
+Requires-Dist: python-dotenv>=1.2.2
+Requires-Dist: pyyaml>=6
+Provides-Extra: pdf
+Requires-Dist: pymupdf4llm>=0.0.17; extra == 'pdf'
+Description-Content-Type: text/markdown
+
+# Paperstack
+
+Paperstack is an open-source CLI for maintaining, querying, and publishing an independently authored research corpus.
+The software and corpus are separate: Paperstack can be public while each corpus and its editorial judgments remain
+under its maintainer's control.
+
+It can search typed reviews, initialize and validate entries, inspect external paper metadata, read arXiv sources,
+manage a selected-venue DBLP index, and build a static viewer. A synthetic corpus lives in
+[`examples/corpus`](examples/corpus/README.md); no assessment of real work is bundled with the package.
+
+## Install
+
+```bash
+uv tool install paperstack-cli
+```
+
+PDF conversion is optional:
+
+```bash
+uv tool install 'paperstack-cli[pdf]'
+```
+
+## Choose a corpus
+
+Register either a local working tree or a GitHub repository. The first registered corpus becomes active.
+
+```bash
+paperstack corpus add work --path ~/research/reviews
+paperstack corpus add private --repo OWNER/private-reviews
+paperstack corpus list
+paperstack corpus use private
+paperstack corpus remove work
+```
+
+Private GitHub repositories use the existing `gh` login without storing its token:
+
+```bash
+gh auth login
+paperstack review sync
+```
+
+`PAPERSTACK_DIR` and `PAPERSTACK_REPO` remain available for automation. Explicit environment variables take priority,
+then a surrounding corpus working tree, then the active profile. Profiles are stored in
+`${XDG_CONFIG_HOME:-~/.config}/paperstack/config.json`.
+
+## Review corpus
+
+```bash
+paperstack review show example2026paperstack --brief
+paperstack review show arxiv:2410.24164 --json
+paperstack review list --quality good --tag vla
+paperstack review search "flow matching"
+paperstack review init <key> --id arxiv:NNNN.NNNNN --title "Verbatim title" --editor <name>
+paperstack review check --style
+paperstack review audit
+paperstack review citations --fetch
+```
+
+Paper entries, talks, and posts use separate contracts under `entries/{papers,talks,posts}/`. The complete schemas,
+writing guide, and source-reading workflow are in [Entry authoring](docs/ENTRIES.md).
+
+## Inspect papers
+
+These commands use external source records and do not select a citation or make an editorial judgment:
+
+```bash
+paperstack paper search "Attention Is All You Need" --source dblp
+paperstack paper metadata arxiv:2106.09685
+paperstack paper metadata doi:10.1109/CVPR.2016.90 --source crossref
+paperstack paper read arxiv:2604.23073 --outline
+paperstack paper read arxiv:2604.23073 --section 6
+paperstack paper pdf arxiv:2602.09017
+```
+
+`metadata` accepts `arxiv:`, `doi:`, `dblp:`, and `openreview:` references. `read` and `pdf` require an `arxiv:`
+reference. Structured commands expose scoped `--json` flags; networked commands expose scoped `--offline` flags.
+
+## Build a viewer
+
+```bash
+paperstack viewer build
+paperstack viewer serve --port 8000
+```
+
+The viewer is generated from the selected corpus. Source Markdown remains available alongside the rendered pages.
+
+## DBLP index
+
+The optional selected-venue index accelerates DBLP search and is required by `review audit`:
+
+```bash
+paperstack index dblp status
+paperstack index dblp install
+paperstack index dblp update
+```
+
+Installed snapshots are content-addressed and verified by SHA-256, schema, and embedded metadata before an atomic
+pointer switch. See [DBLP snapshot releases](docs/DBLP_RELEASES.md) for release maintenance.
+
+## Configuration
+
+| Variable | Purpose |
+|---|---|
+| `PAPERSTACK_DIR` | Explicit local corpus working tree |
+| `PAPERSTACK_REPO` | Explicit GitHub corpus in `OWNER/REPO` form |
+| `PAPERSTACK_TTL` | Remote corpus cache refresh interval; default `3600` seconds |
+| `PAPERSTACK_PAPERS_DIR` | arXiv source and PDF cache |
+| `SEMANTIC_SCHOLAR_API_KEY` | Optional higher-rate Semantic Scholar access |
+| `OPENREVIEW_ACCESS_TOKEN` | Optional OpenReview access cookie value |
+| `XDG_CONFIG_HOME` | Corpus profile configuration root |
+| `XDG_CACHE_HOME` | Remote corpus and paper cache root |
+| `XDG_DATA_HOME` | DBLP index root |
+
+The console entry point also loads the nearest `.env` without overriding exported variables. Review exit codes are
+`0` for hits, `1` for no match, `2` for ambiguity, and `3` for unavailable data or invalid configuration.
+
+## Development
+
+```bash
+uv run --group lint ruff check .
+uv run --group lint ruff format --check .
+uv run --group test pytest -q
+PAPERSTACK_DIR=examples/corpus uv run paperstack viewer build --output /tmp/paperstack-site
+```
+
+Paperstack is licensed under Apache-2.0. Corpora are separate works and may use their own terms.

paperstack_cli-0.3.1/README.md

@@ -0,0 +1,126 @@
+# Paperstack
+
+Paperstack is an open-source CLI for maintaining, querying, and publishing an independently authored research corpus.
+The software and corpus are separate: Paperstack can be public while each corpus and its editorial judgments remain
+under its maintainer's control.
+
+It can search typed reviews, initialize and validate entries, inspect external paper metadata, read arXiv sources,
+manage a selected-venue DBLP index, and build a static viewer. A synthetic corpus lives in
+[`examples/corpus`](examples/corpus/README.md); no assessment of real work is bundled with the package.
+
+## Install
+
+```bash
+uv tool install paperstack-cli
+```
+
+PDF conversion is optional:
+
+```bash
+uv tool install 'paperstack-cli[pdf]'
+```
+
+## Choose a corpus
+
+Register either a local working tree or a GitHub repository. The first registered corpus becomes active.
+
+```bash
+paperstack corpus add work --path ~/research/reviews
+paperstack corpus add private --repo OWNER/private-reviews
+paperstack corpus list
+paperstack corpus use private
+paperstack corpus remove work
+```
+
+Private GitHub repositories use the existing `gh` login without storing its token:
+
+```bash
+gh auth login
+paperstack review sync
+```
+
+`PAPERSTACK_DIR` and `PAPERSTACK_REPO` remain available for automation. Explicit environment variables take priority,
+then a surrounding corpus working tree, then the active profile. Profiles are stored in
+`${XDG_CONFIG_HOME:-~/.config}/paperstack/config.json`.
+
+## Review corpus
+
+```bash
+paperstack review show example2026paperstack --brief
+paperstack review show arxiv:2410.24164 --json
+paperstack review list --quality good --tag vla
+paperstack review search "flow matching"
+paperstack review init <key> --id arxiv:NNNN.NNNNN --title "Verbatim title" --editor <name>
+paperstack review check --style
+paperstack review audit
+paperstack review citations --fetch
+```
+
+Paper entries, talks, and posts use separate contracts under `entries/{papers,talks,posts}/`. The complete schemas,
+writing guide, and source-reading workflow are in [Entry authoring](docs/ENTRIES.md).
+
+## Inspect papers
+
+These commands use external source records and do not select a citation or make an editorial judgment:
+
+```bash
+paperstack paper search "Attention Is All You Need" --source dblp
+paperstack paper metadata arxiv:2106.09685
+paperstack paper metadata doi:10.1109/CVPR.2016.90 --source crossref
+paperstack paper read arxiv:2604.23073 --outline
+paperstack paper read arxiv:2604.23073 --section 6
+paperstack paper pdf arxiv:2602.09017
+```
+
+`metadata` accepts `arxiv:`, `doi:`, `dblp:`, and `openreview:` references. `read` and `pdf` require an `arxiv:`
+reference. Structured commands expose scoped `--json` flags; networked commands expose scoped `--offline` flags.
+
+## Build a viewer
+
+```bash
+paperstack viewer build
+paperstack viewer serve --port 8000
+```
+
+The viewer is generated from the selected corpus. Source Markdown remains available alongside the rendered pages.
+
+## DBLP index
+
+The optional selected-venue index accelerates DBLP search and is required by `review audit`:
+
+```bash
+paperstack index dblp status
+paperstack index dblp install
+paperstack index dblp update
+```
+
+Installed snapshots are content-addressed and verified by SHA-256, schema, and embedded metadata before an atomic
+pointer switch. See [DBLP snapshot releases](docs/DBLP_RELEASES.md) for release maintenance.
+
+## Configuration
+
+| Variable | Purpose |
+|---|---|
+| `PAPERSTACK_DIR` | Explicit local corpus working tree |
+| `PAPERSTACK_REPO` | Explicit GitHub corpus in `OWNER/REPO` form |
+| `PAPERSTACK_TTL` | Remote corpus cache refresh interval; default `3600` seconds |
+| `PAPERSTACK_PAPERS_DIR` | arXiv source and PDF cache |
+| `SEMANTIC_SCHOLAR_API_KEY` | Optional higher-rate Semantic Scholar access |
+| `OPENREVIEW_ACCESS_TOKEN` | Optional OpenReview access cookie value |
+| `XDG_CONFIG_HOME` | Corpus profile configuration root |
+| `XDG_CACHE_HOME` | Remote corpus and paper cache root |
+| `XDG_DATA_HOME` | DBLP index root |
+
+The console entry point also loads the nearest `.env` without overriding exported variables. Review exit codes are
+`0` for hits, `1` for no match, `2` for ambiguity, and `3` for unavailable data or invalid configuration.
+
+## Development
+
+```bash
+uv run --group lint ruff check .
+uv run --group lint ruff format --check .
+uv run --group test pytest -q
+PAPERSTACK_DIR=examples/corpus uv run paperstack viewer build --output /tmp/paperstack-site
+```
+
+Paperstack is licensed under Apache-2.0. Corpora are separate works and may use their own terms.

{paperstack_cli-0.1.0 → paperstack_cli-0.3.1}/pyproject.toml

@@ -1,7 +1,7 @@
 [project]
 name = "paperstack-cli"
-version = "0.1.0"
-description = "Review, inspect, and retrieve research papers from one CLI"
+version = "0.3.1"
+description = "Review, inspect, and retrieve research sources from one CLI"
 readme = "README.md"
 requires-python = ">=3.11.4" # First 3.11 release with tarfile.extractall(filter=).
 dependencies = [
@@ -22,7 +22,8 @@ dev = [
 ]
 
 [project.urls]
-Repository = "https://github.com/MilkClouds/my-paperstack"
+Repository = "https://github.com/MilkClouds/paperstack"
+Issues = "https://github.com/MilkClouds/paperstack/issues"
 
 [project.scripts]
 paperstack = "paperstack.entrypoint:main"
@@ -30,8 +31,12 @@ paperstack = "paperstack.entrypoint:main"
 [tool.hatch.build.targets.wheel]
 packages = ["src/paperstack"]
 
+[tool.hatch.build.targets.wheel.force-include]
+"scripts/build/site" = "paperstack/viewer_assets/site"
+"scripts/build/vendor/marked.min.js" = "paperstack/viewer_assets/vendor/marked.min.js"
+
 [tool.hatch.build.targets.sdist]
-include = ["/src/paperstack", "/README.md", "/pyproject.toml"]
+include = ["/src/paperstack", "/scripts/build/site", "/scripts/build/vendor/marked.min.js", "/README.md", "/pyproject.toml", "/LICENSE"]
 
 [tool.ruff]
 line-length = 119