relore 0.3.17__tar.gz

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (78) hide show
  1. relore-0.3.17/LICENSE +201 -0
  2. relore-0.3.17/PKG-INFO +125 -0
  3. relore-0.3.17/README.md +81 -0
  4. relore-0.3.17/pyproject.toml +78 -0
  5. relore-0.3.17/relore/__init__.py +12 -0
  6. relore-0.3.17/relore/api/__init__.py +0 -0
  7. relore-0.3.17/relore/api/schemas.py +363 -0
  8. relore-0.3.17/relore/api/server.py +781 -0
  9. relore-0.3.17/relore/api/tokens.py +219 -0
  10. relore-0.3.17/relore/api/ui.py +812 -0
  11. relore-0.3.17/relore/bench/__init__.py +10 -0
  12. relore-0.3.17/relore/bench/dataset.py +220 -0
  13. relore-0.3.17/relore/bench/judge.py +155 -0
  14. relore-0.3.17/relore/bench/mine.py +550 -0
  15. relore-0.3.17/relore/bench/run.py +433 -0
  16. relore-0.3.17/relore/cli.py +972 -0
  17. relore-0.3.17/relore/code/__init__.py +53 -0
  18. relore-0.3.17/relore/code/api.py +105 -0
  19. relore-0.3.17/relore/code/blame.py +398 -0
  20. relore-0.3.17/relore/code/clone.py +105 -0
  21. relore-0.3.17/relore/code/defs.py +61 -0
  22. relore-0.3.17/relore/code/providers/__init__.py +0 -0
  23. relore-0.3.17/relore/code/providers/ctags.py +104 -0
  24. relore-0.3.17/relore/code/providers/python.py +65 -0
  25. relore-0.3.17/relore/code/providers/treesitter.py +176 -0
  26. relore-0.3.17/relore/code/refresh.py +79 -0
  27. relore-0.3.17/relore/code/refs.py +97 -0
  28. relore-0.3.17/relore/code/registry.py +137 -0
  29. relore-0.3.17/relore/code/repomap.py +123 -0
  30. relore-0.3.17/relore/code/survey.py +297 -0
  31. relore-0.3.17/relore/code/walk.py +96 -0
  32. relore-0.3.17/relore/daemon.py +828 -0
  33. relore-0.3.17/relore/duration.py +25 -0
  34. relore-0.3.17/relore/entrypoints.py +42 -0
  35. relore-0.3.17/relore/freshness.py +14 -0
  36. relore-0.3.17/relore/github/__init__.py +0 -0
  37. relore-0.3.17/relore/github/bulk.py +142 -0
  38. relore-0.3.17/relore/github/client.py +243 -0
  39. relore-0.3.17/relore/github/fetch_thread.py +107 -0
  40. relore-0.3.17/relore/github/graphql.py +235 -0
  41. relore-0.3.17/relore/guidance.py +176 -0
  42. relore-0.3.17/relore/ingest/__init__.py +0 -0
  43. relore-0.3.17/relore/ingest/authority.py +202 -0
  44. relore-0.3.17/relore/ingest/backfill.py +305 -0
  45. relore-0.3.17/relore/ingest/chunk.py +107 -0
  46. relore-0.3.17/relore/ingest/extract.py +534 -0
  47. relore-0.3.17/relore/ingest/index_thread.py +536 -0
  48. relore-0.3.17/relore/ingest/normalize.py +101 -0
  49. relore-0.3.17/relore/ingest/poll.py +236 -0
  50. relore-0.3.17/relore/ingest/relationships.py +92 -0
  51. relore-0.3.17/relore/ingest/sample.py +251 -0
  52. relore-0.3.17/relore/ingest/sweep.py +85 -0
  53. relore-0.3.17/relore/ingest/timestamps.py +31 -0
  54. relore-0.3.17/relore/ingest/versions.py +18 -0
  55. relore-0.3.17/relore/render.py +1044 -0
  56. relore-0.3.17/relore/search/__init__.py +55 -0
  57. relore-0.3.17/relore/search/backends/__init__.py +35 -0
  58. relore-0.3.17/relore/search/backends/base.py +1595 -0
  59. relore-0.3.17/relore/search/backends/postgres.py +162 -0
  60. relore-0.3.17/relore/search/backends/sqlite.py +96 -0
  61. relore-0.3.17/relore/search/expansion.py +335 -0
  62. relore-0.3.17/relore/search/queries.py +640 -0
  63. relore-0.3.17/relore/search/ranking.py +224 -0
  64. relore-0.3.17/relore/security/__init__.py +0 -0
  65. relore-0.3.17/relore/security/untrusted.py +201 -0
  66. relore-0.3.17/relore/store/__init__.py +0 -0
  67. relore-0.3.17/relore/store/dialect.py +189 -0
  68. relore-0.3.17/relore/store/migrations/__init__.py +252 -0
  69. relore-0.3.17/relore/store/repository.py +772 -0
  70. relore-0.3.17/relore/store/schema.py +346 -0
  71. relore-0.3.17/relore/wire.py +95 -0
  72. relore-0.3.17/relore.egg-info/PKG-INFO +125 -0
  73. relore-0.3.17/relore.egg-info/SOURCES.txt +76 -0
  74. relore-0.3.17/relore.egg-info/dependency_links.txt +1 -0
  75. relore-0.3.17/relore.egg-info/entry_points.txt +6 -0
  76. relore-0.3.17/relore.egg-info/requires.txt +23 -0
  77. relore-0.3.17/relore.egg-info/top_level.txt +1 -0
  78. relore-0.3.17/setup.cfg +4 -0
relore-0.3.17/LICENSE ADDED
@@ -0,0 +1,201 @@
1
+ Apache License
2
+ Version 2.0, January 2004
3
+ http://www.apache.org/licenses/
4
+
5
+ TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
6
+
7
+ 1. Definitions.
8
+
9
+ "License" shall mean the terms and conditions for use, reproduction,
10
+ and distribution as defined by Sections 1 through 9 of this document.
11
+
12
+ "Licensor" shall mean the copyright owner or entity authorized by
13
+ the copyright owner that is granting the License.
14
+
15
+ "Legal Entity" shall mean the union of the acting entity and all
16
+ other entities that control, are controlled by, or are under common
17
+ control with that entity. For the purposes of this definition,
18
+ "control" means (i) the power, direct or indirect, to cause the
19
+ direction or management of such entity, whether by contract or
20
+ otherwise, or (ii) ownership of fifty percent (50%) or more of the
21
+ outstanding shares, or (iii) beneficial ownership of such entity.
22
+
23
+ "You" (or "Your") shall mean an individual or Legal Entity
24
+ exercising permissions granted by this License.
25
+
26
+ "Source" form shall mean the preferred form for making modifications,
27
+ including but not limited to software source code, documentation
28
+ source, and configuration files.
29
+
30
+ "Object" form shall mean any form resulting from mechanical
31
+ transformation or translation of a Source form, including but
32
+ not limited to compiled object code, generated documentation,
33
+ and conversions to other media types.
34
+
35
+ "Work" shall mean the work of authorship, whether in Source or
36
+ Object form, made available under the License, as indicated by a
37
+ copyright notice that is included in or attached to the work
38
+ (an example is provided in the Appendix below).
39
+
40
+ "Derivative Works" shall mean any work, whether in Source or Object
41
+ form, that is based on (or derived from) the Work and for which the
42
+ editorial revisions, annotations, elaborations, or other modifications
43
+ represent, as a whole, an original work of authorship. For the purposes
44
+ of this License, Derivative Works shall not include works that remain
45
+ separable from, or merely link (or bind by name) to the interfaces of,
46
+ the Work and Derivative Works thereof.
47
+
48
+ "Contribution" shall mean any work of authorship, including
49
+ the original version of the Work and any modifications or additions
50
+ to that Work or Derivative Works thereof, that is intentionally
51
+ submitted to Licensor for inclusion in the Work by the copyright owner
52
+ or by an individual or Legal Entity authorized to submit on behalf of
53
+ the copyright owner. For the purposes of this definition, "submitted"
54
+ means any form of electronic, verbal, or written communication sent
55
+ to the Licensor or its representatives, including but not limited to
56
+ communication on electronic mailing lists, source code control systems,
57
+ and issue tracking systems that are managed by, or on behalf of, the
58
+ Licensor for the purpose of discussing and improving the Work, but
59
+ excluding communication that is conspicuously marked or otherwise
60
+ designated in writing by the copyright owner as "Not a Contribution."
61
+
62
+ "Contributor" shall mean Licensor and any individual or Legal Entity
63
+ on behalf of whom a Contribution has been received by Licensor and
64
+ subsequently incorporated within the Work.
65
+
66
+ 2. Grant of Copyright License. Subject to the terms and conditions of
67
+ this License, each Contributor hereby grants to You a perpetual,
68
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
69
+ copyright license to reproduce, prepare Derivative Works of,
70
+ publicly display, publicly perform, sublicense, and distribute the
71
+ Work and such Derivative Works in Source or Object form.
72
+
73
+ 3. Grant of Patent License. Subject to the terms and conditions of
74
+ this License, each Contributor hereby grants to You a perpetual,
75
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
76
+ (except as stated in this section) patent license to make, have made,
77
+ use, offer to sell, sell, import, and otherwise transfer the Work,
78
+ where such license applies only to those patent claims licensable
79
+ by such Contributor that are necessarily infringed by their
80
+ Contribution(s) alone or by combination of their Contribution(s)
81
+ with the Work to which such Contribution(s) was submitted. If You
82
+ institute patent litigation against any entity (including a
83
+ cross-claim or counterclaim in a lawsuit) alleging that the Work
84
+ or a Contribution incorporated within the Work constitutes direct
85
+ or contributory patent infringement, then any patent licenses
86
+ granted to You under this License for that Work shall terminate
87
+ as of the date such litigation is filed.
88
+
89
+ 4. Redistribution. You may reproduce and distribute copies of the
90
+ Work or Derivative Works thereof in any medium, with or without
91
+ modifications, and in Source or Object form, provided that You
92
+ meet the following conditions:
93
+
94
+ (a) You must give any other recipients of the Work or Derivative
95
+ Works a copy of this License; and
96
+
97
+ (b) You must cause any modified files to carry prominent notices
98
+ stating that You changed the files; and
99
+
100
+ (c) You must retain, in the Source form of any Derivative Works
101
+ that You distribute, all copyright, patent, trademark, and
102
+ attribution notices from the Source form of the Work, excluding
103
+ those notices that do not pertain to any part of the Derivative
104
+ Works; and
105
+
106
+ (d) If the Work includes a "NOTICE" text file as part of its
107
+ distribution, then any Derivative Works that You distribute must
108
+ include a readable copy of the attribution notices contained
109
+ within such NOTICE file, excluding those notices that do not
110
+ pertain to any part of the Derivative Works, in at least one
111
+ of the following places: within a NOTICE text file distributed
112
+ as part of the Derivative Works; within the Source form or
113
+ documentation, if provided along with the Derivative Works; or,
114
+ within a display generated by the Derivative Works, if and
115
+ wherever such third-party notices normally appear. The contents
116
+ of the NOTICE file are for informational purposes only and
117
+ do not modify the License. You may add Your own attribution
118
+ notices within Derivative Works that You distribute, alongside
119
+ or as an addendum to the NOTICE text from the Work, provided
120
+ that such additional attribution notices cannot be construed
121
+ as modifying the License.
122
+
123
+ You may add Your own copyright statement to Your modifications and
124
+ may provide additional or different license terms and conditions
125
+ for use, reproduction, or distribution of Your modifications, or
126
+ for any such Derivative Works as a whole, provided Your use,
127
+ reproduction, and distribution of the Work otherwise complies with
128
+ the conditions stated in this License.
129
+
130
+ 5. Submission of Contributions. Unless You explicitly state otherwise,
131
+ any Contribution intentionally submitted for inclusion in the Work
132
+ by You to the Licensor shall be under the terms and conditions of
133
+ this License, without any additional terms or conditions.
134
+ Notwithstanding the above, nothing herein shall supersede or modify
135
+ the terms of any separate license agreement you may have executed
136
+ with Licensor regarding such Contributions.
137
+
138
+ 6. Trademarks. This License does not grant permission to use the trade
139
+ names, trademarks, service marks, or product names of the Licensor,
140
+ except as required for reasonable and customary use in describing the
141
+ origin of the Work and reproducing the content of the NOTICE file.
142
+
143
+ 7. Disclaimer of Warranty. Unless required by applicable law or
144
+ agreed to in writing, Licensor provides the Work (and each
145
+ Contributor provides its Contributions) on an "AS IS" BASIS,
146
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
147
+ implied, including, without limitation, any warranties or conditions
148
+ of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
149
+ PARTICULAR PURPOSE. You are solely responsible for determining the
150
+ appropriateness of using or redistributing the Work and assume any
151
+ risks associated with Your exercise of permissions under this License.
152
+
153
+ 8. Limitation of Liability. In no event and under no legal theory,
154
+ whether in tort (including negligence), contract, or otherwise,
155
+ unless required by applicable law (such as deliberate and grossly
156
+ negligent acts) or agreed to in writing, shall any Contributor be
157
+ liable to You for damages, including any direct, indirect, special,
158
+ incidental, or consequential damages of any character arising as a
159
+ result of this License or out of the use or inability to use the
160
+ Work (including but not limited to damages for loss of goodwill,
161
+ work stoppage, computer failure or malfunction, or any and all
162
+ other commercial damages or losses), even if such Contributor
163
+ has been advised of the possibility of such damages.
164
+
165
+ 9. Accepting Warranty or Additional Liability. While redistributing
166
+ the Work or Derivative Works thereof, You may choose to offer,
167
+ and charge a fee for, acceptance of support, warranty, indemnity,
168
+ or other liability obligations and/or rights consistent with this
169
+ License. However, in accepting such obligations, You may act only
170
+ on Your own behalf and on Your sole responsibility, not on behalf
171
+ of any other Contributor, and only if You agree to indemnify,
172
+ defend, and hold each Contributor harmless for any liability
173
+ incurred by, or claims asserted against, such Contributor by reason
174
+ of your accepting any such warranty or additional liability.
175
+
176
+ END OF TERMS AND CONDITIONS
177
+
178
+ APPENDIX: How to apply the Apache License to your work.
179
+
180
+ To apply the Apache License to your work, attach the following
181
+ boilerplate notice, with the fields enclosed by brackets "[]"
182
+ replaced with your own identifying information. (Don't include
183
+ the brackets!) The text should be enclosed in the appropriate
184
+ comment syntax for the file format. We also recommend that a
185
+ file or class name and description of purpose be included on the
186
+ same "printed page" as the copyright notice for easier
187
+ identification within third-party archives.
188
+
189
+ Copyright 2026 The HuggingFace Team. All rights reserved.
190
+
191
+ Licensed under the Apache License, Version 2.0 (the "License");
192
+ you may not use this file except in compliance with the License.
193
+ You may obtain a copy of the License at
194
+
195
+ http://www.apache.org/licenses/LICENSE-2.0
196
+
197
+ Unless required by applicable law or agreed to in writing, software
198
+ distributed under the License is distributed on an "AS IS" BASIS,
199
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
200
+ See the License for the specific language governing permissions and
201
+ limitations under the License.
relore-0.3.17/PKG-INFO ADDED
@@ -0,0 +1,125 @@
1
+ Metadata-Version: 2.4
2
+ Name: relore
3
+ Version: 0.3.17
4
+ Summary: GitHub project memory: index a repository's issue/PR history and serve it to agents and humans
5
+ Author-email: The Hugging Face Team <transformers@huggingface.co>
6
+ License-Expression: Apache-2.0
7
+ Project-URL: Homepage, https://github.com/huggingface/relore
8
+ Project-URL: Repository, https://github.com/huggingface/relore
9
+ Project-URL: Documentation, https://github.com/huggingface/relore/tree/main/docs
10
+ Project-URL: Issues, https://github.com/huggingface/relore/issues
11
+ Project-URL: Changelog, https://github.com/huggingface/relore/blob/main/CHANGELOG.md
12
+ Keywords: github,issues,search,agents,project-memory
13
+ Classifier: Development Status :: 4 - Beta
14
+ Classifier: Intended Audience :: Developers
15
+ Classifier: Operating System :: OS Independent
16
+ Classifier: Programming Language :: Python :: 3
17
+ Classifier: Programming Language :: Python :: 3.10
18
+ Classifier: Programming Language :: Python :: 3.11
19
+ Classifier: Programming Language :: Python :: 3.12
20
+ Classifier: Programming Language :: Python :: 3.13
21
+ Classifier: Topic :: Software Development
22
+ Requires-Python: >=3.10
23
+ Description-Content-Type: text/markdown
24
+ License-File: LICENSE
25
+ Requires-Dist: httpx>=0.27
26
+ Provides-Extra: server
27
+ Requires-Dist: SQLAlchemy>=2.0; extra == "server"
28
+ Requires-Dist: fastapi>=0.110; extra == "server"
29
+ Requires-Dist: uvicorn>=0.29; extra == "server"
30
+ Requires-Dist: pydantic>=2.6; extra == "server"
31
+ Provides-Extra: postgres
32
+ Requires-Dist: relore[server]; extra == "postgres"
33
+ Requires-Dist: psycopg[binary]>=3.1; extra == "postgres"
34
+ Provides-Extra: code
35
+ Requires-Dist: tree-sitter>=0.21; extra == "code"
36
+ Provides-Extra: python
37
+ Requires-Dist: relore[code]; extra == "python"
38
+ Requires-Dist: tree-sitter-python>=0.21; extra == "python"
39
+ Provides-Extra: dev
40
+ Requires-Dist: relore[postgres,python]; extra == "dev"
41
+ Requires-Dist: pytest>=8; extra == "dev"
42
+ Requires-Dist: ruff>=0.5; extra == "dev"
43
+ Dynamic: license-file
44
+
45
+ # relore — GitHub project memory
46
+
47
+ **Every codebase has lore. Ask it, then check it against the code.**
48
+
49
+ <img src="docs/relore.png" alt="logo" width="200">
50
+
51
+ `relore` indexes a repository's complete issue and pull-request history and keeps a working
52
+ clone beside it, both served over one HTTP API. Three questions, in the order an agent hits
53
+ them:
54
+
55
+ **1. Is somebody already doing this?** `inflight <issue>` — every open claimant, its state
56
+ and its author, in one hop. The most expensive thing an agent does is patch something that
57
+ is already in review.
58
+
59
+ **2. Why is it like this?** Why a fallback cannot be removed, which approach was tried and
60
+ rejected, what a maintainer made the last five contributors change — none of it is in the
61
+ codebase. `thread`, `why PATH:LINE` and `search` return it at comment level with who said
62
+ it attached, so `--trust authoritative` keeps only what someone with write access settled
63
+ and machine authors are excluded by default. `search --symbol GemmaRotaryEmbedding` asks
64
+ what has been *said* about a function — a question `grep` cannot answer.
65
+
66
+ **3. Is that still true?** `grep`, `symbol` and `copies` run against that clone at HEAD,
67
+ server-side, no checkout on your side. A three-year-old review is a claim about code that
68
+ has moved since.
69
+
70
+ ![Relore connects project history with current code to answer an agent's three questions.](docs/relore-diag.png)
71
+
72
+ Threads tell you what people decided; the code verbs tell you whether it was true. A
73
+ [contributor claim] confirmed by `grep` is stronger evidence than either alone — the
74
+ argument for this over a search box.
75
+
76
+ Six agents have run it cold on the same `transformers` bug, one per release, on `--help`
77
+ alone and with no memory of the runs before. They filed 39 issues against the tool; most
78
+ are fixed, each run checking the last one's from the outside.
79
+ [#8](https://github.com/huggingface/relore/issues/8) is the record.
80
+
81
+ ## Get started
82
+
83
+ - [Deploy the service](docs/operations.md).
84
+ - [Use relore](docs/cli.md).
85
+
86
+ ## What you get
87
+
88
+ | | |
89
+ | --- | --- |
90
+ | **Comment-level results** | the matching document with its author, trust tier, age and URL — not a thread number to go re-read |
91
+ | **Exact signals** | errors, files, symbols, test ids, shas, extracted at ingest and repeatable as filters |
92
+ | **Trust tiers** | maintainer / contributor / bot, as a filter rather than a weight |
93
+ | **Schema to join on** | "which threads touched this file", and a bug and its merged fix as one record — `search --file` under-returns the newest PRs touching a path until [#48](https://github.com/huggingface/relore/issues/48) lands |
94
+ | **The code, server-side** | `why PATH:LINE`, `grep`, `copies`, `symbol`, and `defs`/`refs` with `--repo`, against a working clone the daemon keeps |
95
+ | **Throughput** | every query is a Postgres query and makes no GitHub request; ten agents in parallel cost the same as one |
96
+
97
+ The trade is freshness: each thread records its last indexing visit; later GitHub changes
98
+ are unknown. Collector poll times do not guarantee freshness for every thread.
99
+ [Why not GitHub search](docs/why-not-github-search.md) has the measurements.
100
+
101
+ Running the daemon needs a Postgres and a GitHub token with `issues:read` +
102
+ `pull_requests:read` — never write. `deploy/` has a Helm chart and the scripts that are its
103
+ interface; setup is in [`docs/operations.md`](docs/operations.md).
104
+
105
+ ## Docs
106
+
107
+ - [`docs/how-search-works.md`](docs/how-search-works.md) — what kind of index this is
108
+ (lexical and ranked, no embeddings), and what it is better and worse at than `grep`.
109
+ - [`docs/cli.md`](docs/cli.md) — worked queries, and the empty results that are not faults.
110
+ - [`docs/why-not-github-search.md`](docs/why-not-github-search.md) — the comparison.
111
+ - [`docs/architecture.md`](docs/architecture.md) — what is indexed, what is deliberately
112
+ not, the symbol lens, and language plugins.
113
+ - [`docs/agents.md`](docs/agents.md) — wiring it into a harness (not to be confused with
114
+ `AGENTS.md` below, which is the contributor contract for this repository).
115
+ - [`docs/ranking.md`](docs/ranking.md) — the scoring model and what the benchmark says.
116
+ - [`docs/operations.md`](docs/operations.md) — backfill, poll, clones, tokens, serving.
117
+ - [`docs/security.md`](docs/security.md) — the properties and how each is enforced.
118
+ - [`docs/release.md`](docs/release.md) — release branches, tags, and PyPI publishing.
119
+ - [`CHANGELOG.md`](CHANGELOG.md) — notable changes by release.
120
+ - [`docs/prior-art.md`](docs/prior-art.md) — related work, and what was borrowed.
121
+ - [`AGENTS.md`](AGENTS.md) — the operating contract: the invariants with tests behind them.
122
+
123
+ ## License
124
+
125
+ [Apache-2.0](LICENSE).
@@ -0,0 +1,81 @@
1
+ # relore — GitHub project memory
2
+
3
+ **Every codebase has lore. Ask it, then check it against the code.**
4
+
5
+ <img src="docs/relore.png" alt="logo" width="200">
6
+
7
+ `relore` indexes a repository's complete issue and pull-request history and keeps a working
8
+ clone beside it, both served over one HTTP API. Three questions, in the order an agent hits
9
+ them:
10
+
11
+ **1. Is somebody already doing this?** `inflight <issue>` — every open claimant, its state
12
+ and its author, in one hop. The most expensive thing an agent does is patch something that
13
+ is already in review.
14
+
15
+ **2. Why is it like this?** Why a fallback cannot be removed, which approach was tried and
16
+ rejected, what a maintainer made the last five contributors change — none of it is in the
17
+ codebase. `thread`, `why PATH:LINE` and `search` return it at comment level with who said
18
+ it attached, so `--trust authoritative` keeps only what someone with write access settled
19
+ and machine authors are excluded by default. `search --symbol GemmaRotaryEmbedding` asks
20
+ what has been *said* about a function — a question `grep` cannot answer.
21
+
22
+ **3. Is that still true?** `grep`, `symbol` and `copies` run against that clone at HEAD,
23
+ server-side, no checkout on your side. A three-year-old review is a claim about code that
24
+ has moved since.
25
+
26
+ ![Relore connects project history with current code to answer an agent's three questions.](docs/relore-diag.png)
27
+
28
+ Threads tell you what people decided; the code verbs tell you whether it was true. A
29
+ [contributor claim] confirmed by `grep` is stronger evidence than either alone — the
30
+ argument for this over a search box.
31
+
32
+ Six agents have run it cold on the same `transformers` bug, one per release, on `--help`
33
+ alone and with no memory of the runs before. They filed 39 issues against the tool; most
34
+ are fixed, each run checking the last one's from the outside.
35
+ [#8](https://github.com/huggingface/relore/issues/8) is the record.
36
+
37
+ ## Get started
38
+
39
+ - [Deploy the service](docs/operations.md).
40
+ - [Use relore](docs/cli.md).
41
+
42
+ ## What you get
43
+
44
+ | | |
45
+ | --- | --- |
46
+ | **Comment-level results** | the matching document with its author, trust tier, age and URL — not a thread number to go re-read |
47
+ | **Exact signals** | errors, files, symbols, test ids, shas, extracted at ingest and repeatable as filters |
48
+ | **Trust tiers** | maintainer / contributor / bot, as a filter rather than a weight |
49
+ | **Schema to join on** | "which threads touched this file", and a bug and its merged fix as one record — `search --file` under-returns the newest PRs touching a path until [#48](https://github.com/huggingface/relore/issues/48) lands |
50
+ | **The code, server-side** | `why PATH:LINE`, `grep`, `copies`, `symbol`, and `defs`/`refs` with `--repo`, against a working clone the daemon keeps |
51
+ | **Throughput** | every query is a Postgres query and makes no GitHub request; ten agents in parallel cost the same as one |
52
+
53
+ The trade is freshness: each thread records its last indexing visit; later GitHub changes
54
+ are unknown. Collector poll times do not guarantee freshness for every thread.
55
+ [Why not GitHub search](docs/why-not-github-search.md) has the measurements.
56
+
57
+ Running the daemon needs a Postgres and a GitHub token with `issues:read` +
58
+ `pull_requests:read` — never write. `deploy/` has a Helm chart and the scripts that are its
59
+ interface; setup is in [`docs/operations.md`](docs/operations.md).
60
+
61
+ ## Docs
62
+
63
+ - [`docs/how-search-works.md`](docs/how-search-works.md) — what kind of index this is
64
+ (lexical and ranked, no embeddings), and what it is better and worse at than `grep`.
65
+ - [`docs/cli.md`](docs/cli.md) — worked queries, and the empty results that are not faults.
66
+ - [`docs/why-not-github-search.md`](docs/why-not-github-search.md) — the comparison.
67
+ - [`docs/architecture.md`](docs/architecture.md) — what is indexed, what is deliberately
68
+ not, the symbol lens, and language plugins.
69
+ - [`docs/agents.md`](docs/agents.md) — wiring it into a harness (not to be confused with
70
+ `AGENTS.md` below, which is the contributor contract for this repository).
71
+ - [`docs/ranking.md`](docs/ranking.md) — the scoring model and what the benchmark says.
72
+ - [`docs/operations.md`](docs/operations.md) — backfill, poll, clones, tokens, serving.
73
+ - [`docs/security.md`](docs/security.md) — the properties and how each is enforced.
74
+ - [`docs/release.md`](docs/release.md) — release branches, tags, and PyPI publishing.
75
+ - [`CHANGELOG.md`](CHANGELOG.md) — notable changes by release.
76
+ - [`docs/prior-art.md`](docs/prior-art.md) — related work, and what was borrowed.
77
+ - [`AGENTS.md`](AGENTS.md) — the operating contract: the invariants with tests behind them.
78
+
79
+ ## License
80
+
81
+ [Apache-2.0](LICENSE).
@@ -0,0 +1,78 @@
1
+ [build-system]
2
+ requires = ["setuptools>=77"]
3
+ build-backend = "setuptools.build_meta"
4
+
5
+ [project]
6
+ name = "relore"
7
+ # Read from relore/__init__.py: the client and the daemon refuse to talk across a version
8
+ # difference (relore/wire.py), so two places to write it is one place to get it wrong.
9
+ dynamic = ["version"]
10
+ description = "GitHub project memory: index a repository's issue/PR history and serve it to agents and humans"
11
+ readme = "README.md"
12
+ requires-python = ">=3.10"
13
+ license = "Apache-2.0"
14
+ license-files = ["LICENSE"]
15
+ authors = [{ name = "The Hugging Face Team", email = "transformers@huggingface.co" }]
16
+ keywords = ["github", "issues", "search", "agents", "project-memory"]
17
+ classifiers = [
18
+ "Development Status :: 4 - Beta",
19
+ "Intended Audience :: Developers",
20
+ "Operating System :: OS Independent",
21
+ "Programming Language :: Python :: 3",
22
+ "Programming Language :: Python :: 3.10",
23
+ "Programming Language :: Python :: 3.11",
24
+ "Programming Language :: Python :: 3.12",
25
+ "Programming Language :: Python :: 3.13",
26
+ "Topic :: Software Development",
27
+ ]
28
+
29
+ # The base install is the CLIENT. It must stay small enough to `pip install` inside a
30
+ # constrained agent sandbox: no database driver, no parser, no ML stack.
31
+ # See AGENTS.md, "The four invariants".
32
+ dependencies = ["httpx>=0.27"]
33
+
34
+ [project.optional-dependencies]
35
+ # The daemon. Never a base dependency -- see the build plan section 2.
36
+ # SQLAlchemy Core (not the ORM) owns the portable half of the schema; SQLite needs no
37
+ # driver, so `[server]` alone runs on a dev laptop and in the test suite.
38
+ server = ["SQLAlchemy>=2.0", "fastapi>=0.110", "uvicorn>=0.29", "pydantic>=2.6"]
39
+ # Production. SQLite is for tests and laptops only -- see AGENTS.md.
40
+ postgres = ["relore[server]", "psycopg[binary]>=3.1"]
41
+ # The code-lens engine. Ships no grammars.
42
+ code = ["tree-sitter>=0.21"]
43
+ # One extra per language. Adding a language must not touch core.
44
+ python = ["relore[code]", "tree-sitter-python>=0.21"]
45
+ dev = ["relore[postgres,python]", "pytest>=8", "ruff>=0.5"]
46
+
47
+ [project.scripts]
48
+ relore = "relore.cli:main"
49
+ # Through the shim, not straight at `relore.daemon:main`: the base install registers this
50
+ # script and does NOT carry the daemon's dependencies, so the import has to be guarded or
51
+ # a client-only install answers `relored --help` with a ModuleNotFoundError traceback.
52
+ relored = "relore.entrypoints:relored"
53
+
54
+ [project.urls]
55
+ Homepage = "https://github.com/huggingface/relore"
56
+ Repository = "https://github.com/huggingface/relore"
57
+ Documentation = "https://github.com/huggingface/relore/tree/main/docs"
58
+ Issues = "https://github.com/huggingface/relore/issues"
59
+ Changelog = "https://github.com/huggingface/relore/blob/main/CHANGELOG.md"
60
+
61
+ [project.entry-points."relore.languages"]
62
+ python = "relore.code.providers.python:PythonProvider"
63
+
64
+ [tool.setuptools.dynamic]
65
+ version = { attr = "relore.__version__" }
66
+
67
+ [tool.setuptools.packages.find]
68
+ include = ["relore*"]
69
+
70
+ [tool.ruff]
71
+ line-length = 100
72
+ target-version = "py310"
73
+
74
+ [tool.ruff.lint]
75
+ select = ["E", "F", "I", "UP", "B", "SIM"]
76
+
77
+ [tool.pytest.ini_options]
78
+ testpaths = ["tests"]
@@ -0,0 +1,12 @@
1
+ """relore -- GitHub project memory."""
2
+
3
+ #: The one place the version is written. ``pyproject.toml`` reads it from here, so the
4
+ #: distribution, ``relore --version``, ``relored --version``, the ``/api/v1/status``
5
+ #: payload and the wire handshake (:mod:`relore.wire`) can never disagree.
6
+ #:
7
+ #: The minor is the milestone the build plan considers complete; the patch is every
8
+ #: release inside it. **Bump it in the same commit as any change a client can see** --
9
+ #: a wire payload, a renderer, a CLI flag -- because the client and the daemon must run
10
+ #: the same version to talk at all (:mod:`relore.wire`), which makes this string the
11
+ #: compatibility contract rather than a label.
12
+ __version__ = "0.3.17"
File without changes