researchforge 0.1.0__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 (216) hide show
  1. researchforge-0.1.0/.github/ISSUE_TEMPLATE/beta_feedback.yml +40 -0
  2. researchforge-0.1.0/.github/ISSUE_TEMPLATE/bug_report.yml +29 -0
  3. researchforge-0.1.0/.github/ISSUE_TEMPLATE/setup_failure.yml +38 -0
  4. researchforge-0.1.0/.github/workflows/ci.yml +34 -0
  5. researchforge-0.1.0/.github/workflows/release.yml +42 -0
  6. researchforge-0.1.0/.gitignore +27 -0
  7. researchforge-0.1.0/CHANGELOG.md +27 -0
  8. researchforge-0.1.0/LICENSE +201 -0
  9. researchforge-0.1.0/PKG-INFO +333 -0
  10. researchforge-0.1.0/README.md +297 -0
  11. researchforge-0.1.0/claude-plugin/README.md +15 -0
  12. researchforge-0.1.0/docs/RESEARCHFORGE_PHASED_BUILD_SPEC.md +2204 -0
  13. researchforge-0.1.0/docs/architecture.md +122 -0
  14. researchforge-0.1.0/docs/claude-mode.md +117 -0
  15. researchforge-0.1.0/docs/demo.md +113 -0
  16. researchforge-0.1.0/docs/experiment-mode.md +98 -0
  17. researchforge-0.1.0/docs/research-mode.md +148 -0
  18. researchforge-0.1.0/docs/security.md +84 -0
  19. researchforge-0.1.0/examples/docker-python/Dockerfile +6 -0
  20. researchforge-0.1.0/examples/docker-python/README.md +18 -0
  21. researchforge-0.1.0/examples/docker-python/benchmarks/evaluate.py +86 -0
  22. researchforge-0.1.0/examples/docker-python/requirements.txt +1 -0
  23. researchforge-0.1.0/examples/docker-python/researchforge.example.yaml +44 -0
  24. researchforge-0.1.0/examples/docker-python/src/__init__.py +0 -0
  25. researchforge-0.1.0/examples/docker-python/src/classifier.py +64 -0
  26. researchforge-0.1.0/examples/docker-python/src/config.py +4 -0
  27. researchforge-0.1.0/examples/simple-python/README.md +31 -0
  28. researchforge-0.1.0/examples/simple-python/benchmarks/evaluate.py +86 -0
  29. researchforge-0.1.0/examples/simple-python/requirements.txt +1 -0
  30. researchforge-0.1.0/examples/simple-python/researchforge.example.yaml +44 -0
  31. researchforge-0.1.0/examples/simple-python/src/__init__.py +0 -0
  32. researchforge-0.1.0/examples/simple-python/src/classifier.py +64 -0
  33. researchforge-0.1.0/examples/simple-python/src/config.py +4 -0
  34. researchforge-0.1.0/pyproject.toml +73 -0
  35. researchforge-0.1.0/src/researchforge/__init__.py +3 -0
  36. researchforge-0.1.0/src/researchforge/__main__.py +4 -0
  37. researchforge-0.1.0/src/researchforge/analytics/__init__.py +1 -0
  38. researchforge-0.1.0/src/researchforge/analytics/cli.py +93 -0
  39. researchforge-0.1.0/src/researchforge/analytics/service.py +167 -0
  40. researchforge-0.1.0/src/researchforge/claude/__init__.py +1 -0
  41. researchforge-0.1.0/src/researchforge/claude/cli.py +87 -0
  42. researchforge-0.1.0/src/researchforge/claude/installer.py +184 -0
  43. researchforge-0.1.0/src/researchforge/claude/skills/researchforge-baseline/SKILL.md +65 -0
  44. researchforge-0.1.0/src/researchforge/claude/skills/researchforge-doctor/SKILL.md +33 -0
  45. researchforge-0.1.0/src/researchforge/claude/skills/researchforge-hypotheses/SKILL.md +50 -0
  46. researchforge-0.1.0/src/researchforge/claude/skills/researchforge-landscape/SKILL.md +54 -0
  47. researchforge-0.1.0/src/researchforge/claude/skills/researchforge-paper/SKILL.md +42 -0
  48. researchforge-0.1.0/src/researchforge/claude/skills/researchforge-papers/SKILL.md +47 -0
  49. researchforge-0.1.0/src/researchforge/claude/skills/researchforge-plan/SKILL.md +76 -0
  50. researchforge-0.1.0/src/researchforge/claude/skills/researchforge-results/SKILL.md +47 -0
  51. researchforge-0.1.0/src/researchforge/claude/skills/researchforge-run/SKILL.md +58 -0
  52. researchforge-0.1.0/src/researchforge/claude/skills/researchforge-ship/SKILL.md +75 -0
  53. researchforge-0.1.0/src/researchforge/claude/skills/researchforge-start/SKILL.md +70 -0
  54. researchforge-0.1.0/src/researchforge/claude/skills/researchforge-validate/SKILL.md +41 -0
  55. researchforge-0.1.0/src/researchforge/cli.py +369 -0
  56. researchforge-0.1.0/src/researchforge/config/__init__.py +0 -0
  57. researchforge-0.1.0/src/researchforge/config/paths.py +85 -0
  58. researchforge-0.1.0/src/researchforge/config/paths_cli.py +52 -0
  59. researchforge-0.1.0/src/researchforge/config/registry.py +108 -0
  60. researchforge-0.1.0/src/researchforge/config/settings.py +37 -0
  61. researchforge-0.1.0/src/researchforge/contract/__init__.py +0 -0
  62. researchforge-0.1.0/src/researchforge/contract/cli.py +198 -0
  63. researchforge-0.1.0/src/researchforge/contract/render.py +131 -0
  64. researchforge-0.1.0/src/researchforge/contract/service.py +125 -0
  65. researchforge-0.1.0/src/researchforge/contract/validate.py +186 -0
  66. researchforge-0.1.0/src/researchforge/contract/wizard.py +95 -0
  67. researchforge-0.1.0/src/researchforge/domain/__init__.py +48 -0
  68. researchforge-0.1.0/src/researchforge/domain/baseline.py +51 -0
  69. researchforge-0.1.0/src/researchforge/domain/contract.py +166 -0
  70. researchforge-0.1.0/src/researchforge/domain/deliverable.py +26 -0
  71. researchforge-0.1.0/src/researchforge/domain/environment.py +31 -0
  72. researchforge-0.1.0/src/researchforge/domain/evidence.py +27 -0
  73. researchforge-0.1.0/src/researchforge/domain/experiment.py +255 -0
  74. researchforge-0.1.0/src/researchforge/domain/hypothesis.py +65 -0
  75. researchforge-0.1.0/src/researchforge/domain/landscape.py +49 -0
  76. researchforge-0.1.0/src/researchforge/domain/paper.py +46 -0
  77. researchforge-0.1.0/src/researchforge/domain/project.py +55 -0
  78. researchforge-0.1.0/src/researchforge/domain/repo_scan.py +58 -0
  79. researchforge-0.1.0/src/researchforge/execution/__init__.py +0 -0
  80. researchforge-0.1.0/src/researchforge/execution/baseline.py +208 -0
  81. researchforge-0.1.0/src/researchforge/execution/cli.py +122 -0
  82. researchforge-0.1.0/src/researchforge/execution/constraints.py +96 -0
  83. researchforge-0.1.0/src/researchforge/execution/docker_exec.py +114 -0
  84. researchforge-0.1.0/src/researchforge/execution/environment.py +177 -0
  85. researchforge-0.1.0/src/researchforge/execution/evaluation.py +348 -0
  86. researchforge-0.1.0/src/researchforge/execution/experiments.py +825 -0
  87. researchforge-0.1.0/src/researchforge/execution/metrics.py +121 -0
  88. researchforge-0.1.0/src/researchforge/execution/path_guard.py +122 -0
  89. researchforge-0.1.0/src/researchforge/execution/ranking.py +303 -0
  90. researchforge-0.1.0/src/researchforge/execution/runner.py +103 -0
  91. researchforge-0.1.0/src/researchforge/execution/validation.py +214 -0
  92. researchforge-0.1.0/src/researchforge/execution/venv_exec.py +103 -0
  93. researchforge-0.1.0/src/researchforge/execution/worktrees.py +197 -0
  94. researchforge-0.1.0/src/researchforge/experiments/__init__.py +0 -0
  95. researchforge-0.1.0/src/researchforge/experiments/cli.py +595 -0
  96. researchforge-0.1.0/src/researchforge/experiments/context_export.py +241 -0
  97. researchforge-0.1.0/src/researchforge/experiments/importers.py +427 -0
  98. researchforge-0.1.0/src/researchforge/hypotheses/__init__.py +0 -0
  99. researchforge-0.1.0/src/researchforge/hypotheses/cli.py +108 -0
  100. researchforge-0.1.0/src/researchforge/project/__init__.py +0 -0
  101. researchforge-0.1.0/src/researchforge/project/cli.py +104 -0
  102. researchforge-0.1.0/src/researchforge/project/service.py +89 -0
  103. researchforge-0.1.0/src/researchforge/py.typed +0 -0
  104. researchforge-0.1.0/src/researchforge/reporting/__init__.py +0 -0
  105. researchforge-0.1.0/src/researchforge/reporting/cli.py +148 -0
  106. researchforge-0.1.0/src/researchforge/reporting/dashboard.py +605 -0
  107. researchforge-0.1.0/src/researchforge/reporting/dashboard_cli.py +116 -0
  108. researchforge-0.1.0/src/researchforge/reporting/engineering_report.py +330 -0
  109. researchforge-0.1.0/src/researchforge/reporting/paper_cli.py +73 -0
  110. researchforge-0.1.0/src/researchforge/reporting/research_package.py +475 -0
  111. researchforge-0.1.0/src/researchforge/reporting/research_report.py +272 -0
  112. researchforge-0.1.0/src/researchforge/reporting/svg_charts.py +519 -0
  113. researchforge-0.1.0/src/researchforge/repository/__init__.py +0 -0
  114. researchforge-0.1.0/src/researchforge/repository/cli.py +87 -0
  115. researchforge-0.1.0/src/researchforge/repository/scanner.py +257 -0
  116. researchforge-0.1.0/src/researchforge/research/__init__.py +0 -0
  117. researchforge-0.1.0/src/researchforge/research/arxiv_client.py +200 -0
  118. researchforge-0.1.0/src/researchforge/research/cli.py +261 -0
  119. researchforge-0.1.0/src/researchforge/research/context_export.py +152 -0
  120. researchforge-0.1.0/src/researchforge/research/dedup.py +39 -0
  121. researchforge-0.1.0/src/researchforge/research/importers.py +236 -0
  122. researchforge-0.1.0/src/researchforge/research/queries.py +57 -0
  123. researchforge-0.1.0/src/researchforge/research/ranking.py +98 -0
  124. researchforge-0.1.0/src/researchforge/research/search_service.py +113 -0
  125. researchforge-0.1.0/src/researchforge/research/text.py +153 -0
  126. researchforge-0.1.0/src/researchforge/server/__init__.py +1 -0
  127. researchforge-0.1.0/src/researchforge/server/app.py +149 -0
  128. researchforge-0.1.0/src/researchforge/server/cli.py +221 -0
  129. researchforge-0.1.0/src/researchforge/server/data.py +134 -0
  130. researchforge-0.1.0/src/researchforge/server/hub.py +172 -0
  131. researchforge-0.1.0/src/researchforge/server/monitor.py +204 -0
  132. researchforge-0.1.0/src/researchforge/server/pages.py +828 -0
  133. researchforge-0.1.0/src/researchforge/shipping/__init__.py +0 -0
  134. researchforge-0.1.0/src/researchforge/shipping/branch.py +412 -0
  135. researchforge-0.1.0/src/researchforge/shipping/cli.py +264 -0
  136. researchforge-0.1.0/src/researchforge/shipping/gh.py +178 -0
  137. researchforge-0.1.0/src/researchforge/shipping/pr_body.py +201 -0
  138. researchforge-0.1.0/src/researchforge/storage/__init__.py +0 -0
  139. researchforge-0.1.0/src/researchforge/storage/baseline_repository.py +56 -0
  140. researchforge-0.1.0/src/researchforge/storage/contract_repository.py +57 -0
  141. researchforge-0.1.0/src/researchforge/storage/db.py +260 -0
  142. researchforge-0.1.0/src/researchforge/storage/deliverable_repository.py +72 -0
  143. researchforge-0.1.0/src/researchforge/storage/experiment_repository.py +274 -0
  144. researchforge-0.1.0/src/researchforge/storage/hypothesis_repository.py +45 -0
  145. researchforge-0.1.0/src/researchforge/storage/paper_repository.py +136 -0
  146. researchforge-0.1.0/src/researchforge/storage/project_repository.py +72 -0
  147. researchforge-0.1.0/src/researchforge/storage/scan_repository.py +31 -0
  148. researchforge-0.1.0/src/researchforge/storage/synthesis_repository.py +47 -0
  149. researchforge-0.1.0/src/researchforge/utils/__init__.py +0 -0
  150. researchforge-0.1.0/src/researchforge/utils/artifact_io.py +41 -0
  151. researchforge-0.1.0/src/researchforge/utils/output.py +47 -0
  152. researchforge-0.1.0/src/researchforge/utils/system_checks.py +117 -0
  153. researchforge-0.1.0/tests/conftest.py +451 -0
  154. researchforge-0.1.0/tests/fixtures/README.md +5 -0
  155. researchforge-0.1.0/tests/fixtures/artifacts/hypotheses_missing_claim.yaml +8 -0
  156. researchforge-0.1.0/tests/fixtures/artifacts/hypotheses_overlap.yaml +13 -0
  157. researchforge-0.1.0/tests/fixtures/artifacts/hypotheses_valid.yaml +58 -0
  158. researchforge-0.1.0/tests/fixtures/artifacts/landscape_bad_paper_ref.yaml +7 -0
  159. researchforge-0.1.0/tests/fixtures/artifacts/landscape_valid.yaml +49 -0
  160. researchforge-0.1.0/tests/fixtures/arxiv/malformed.xml +5 -0
  161. researchforge-0.1.0/tests/fixtures/arxiv/search_empty.xml +9 -0
  162. researchforge-0.1.0/tests/fixtures/arxiv/search_overlapping.xml +34 -0
  163. researchforge-0.1.0/tests/fixtures/arxiv/search_page1.xml +55 -0
  164. researchforge-0.1.0/tests/fixtures/arxiv/search_page2.xml +35 -0
  165. researchforge-0.1.0/tests/fixtures/contracts/example_full.yaml +61 -0
  166. researchforge-0.1.0/tests/fixtures/eval_scripts/failing.py +6 -0
  167. researchforge-0.1.0/tests/fixtures/eval_scripts/good.py +16 -0
  168. researchforge-0.1.0/tests/fixtures/eval_scripts/knobs.py +28 -0
  169. researchforge-0.1.0/tests/fixtures/eval_scripts/wrong_metric.py +8 -0
  170. researchforge-0.1.0/tests/integration/test_examples.py +183 -0
  171. researchforge-0.1.0/tests/unit/test_analytics.py +156 -0
  172. researchforge-0.1.0/tests/unit/test_arxiv_client.py +144 -0
  173. researchforge-0.1.0/tests/unit/test_baseline_docker_args.py +70 -0
  174. researchforge-0.1.0/tests/unit/test_baseline_venv.py +142 -0
  175. researchforge-0.1.0/tests/unit/test_claude_skills.py +270 -0
  176. researchforge-0.1.0/tests/unit/test_cli.py +50 -0
  177. researchforge-0.1.0/tests/unit/test_constraints.py +105 -0
  178. researchforge-0.1.0/tests/unit/test_context_export.py +66 -0
  179. researchforge-0.1.0/tests/unit/test_contract_cli.py +133 -0
  180. researchforge-0.1.0/tests/unit/test_contract_validate.py +170 -0
  181. researchforge-0.1.0/tests/unit/test_contract_wizard.py +101 -0
  182. researchforge-0.1.0/tests/unit/test_dashboard.py +328 -0
  183. researchforge-0.1.0/tests/unit/test_doctor.py +164 -0
  184. researchforge-0.1.0/tests/unit/test_domain_contract.py +67 -0
  185. researchforge-0.1.0/tests/unit/test_domain_experiment.py +71 -0
  186. researchforge-0.1.0/tests/unit/test_domain_project.py +61 -0
  187. researchforge-0.1.0/tests/unit/test_domain_research.py +169 -0
  188. researchforge-0.1.0/tests/unit/test_engineering_report.py +241 -0
  189. researchforge-0.1.0/tests/unit/test_environment_resolver.py +187 -0
  190. researchforge-0.1.0/tests/unit/test_experiment_planning.py +319 -0
  191. researchforge-0.1.0/tests/unit/test_experiment_run.py +336 -0
  192. researchforge-0.1.0/tests/unit/test_experiment_storage.py +193 -0
  193. researchforge-0.1.0/tests/unit/test_experiment_tree.py +223 -0
  194. researchforge-0.1.0/tests/unit/test_hub.py +237 -0
  195. researchforge-0.1.0/tests/unit/test_importers.py +183 -0
  196. researchforge-0.1.0/tests/unit/test_init.py +59 -0
  197. researchforge-0.1.0/tests/unit/test_metrics_parser.py +102 -0
  198. researchforge-0.1.0/tests/unit/test_path_guard.py +97 -0
  199. researchforge-0.1.0/tests/unit/test_project_cli.py +121 -0
  200. researchforge-0.1.0/tests/unit/test_ranking.py +238 -0
  201. researchforge-0.1.0/tests/unit/test_repo_scanner.py +115 -0
  202. researchforge-0.1.0/tests/unit/test_report.py +143 -0
  203. researchforge-0.1.0/tests/unit/test_research_pure.py +160 -0
  204. researchforge-0.1.0/tests/unit/test_run_lifecycle.py +226 -0
  205. researchforge-0.1.0/tests/unit/test_runner.py +95 -0
  206. researchforge-0.1.0/tests/unit/test_search_service.py +117 -0
  207. researchforge-0.1.0/tests/unit/test_server.py +456 -0
  208. researchforge-0.1.0/tests/unit/test_settings.py +47 -0
  209. researchforge-0.1.0/tests/unit/test_ship_branch.py +166 -0
  210. researchforge-0.1.0/tests/unit/test_ship_pr.py +293 -0
  211. researchforge-0.1.0/tests/unit/test_status.py +36 -0
  212. researchforge-0.1.0/tests/unit/test_storage.py +90 -0
  213. researchforge-0.1.0/tests/unit/test_storage_migration.py +114 -0
  214. researchforge-0.1.0/tests/unit/test_validation.py +291 -0
  215. researchforge-0.1.0/tests/unit/test_worktree_patch_ops.py +85 -0
  216. researchforge-0.1.0/tests/unit/test_worktrees.py +117 -0
@@ -0,0 +1,40 @@
1
+ name: Beta feedback
2
+ description: How did ResearchForge work for you? (The questions we are trying to answer this beta.)
3
+ labels: [beta-feedback]
4
+ body:
5
+ - type: textarea
6
+ id: journey
7
+ attributes:
8
+ label: What did you use it for, and how far did you get?
9
+ description: e.g. "explore mode through the report" or "improve mode, stuck at baseline".
10
+ validations:
11
+ required: true
12
+ - type: dropdown
13
+ id: hypotheses-quality
14
+ attributes:
15
+ label: Were the hypotheses meaningfully better than generic LLM suggestions?
16
+ options: [yes, somewhat, no, did not get that far]
17
+ - type: dropdown
18
+ id: evidence-clarity
19
+ attributes:
20
+ label: Was the distinction between paper evidence and your project's measured evidence clear?
21
+ options: [yes, mostly, no]
22
+ - type: dropdown
23
+ id: rejected-value
24
+ attributes:
25
+ label: Did you find the rejected/failed experiment history valuable?
26
+ options: [yes, no, did not get that far]
27
+ - type: dropdown
28
+ id: recommendation-shape
29
+ attributes:
30
+ label: Do you prefer one recommendation or a trade-off frontier?
31
+ options: [one recommendation, the frontier, depends]
32
+ - type: textarea
33
+ id: benchmark
34
+ attributes:
35
+ label: Could you provide a reliable benchmark? What was hard about it?
36
+ - type: textarea
37
+ id: anything-else
38
+ attributes:
39
+ label: Anything else
40
+ description: Paper selection trust, Docker vs venv experience, what you'd pay for, what almost made you quit.
@@ -0,0 +1,29 @@
1
+ name: Bug report
2
+ description: Something behaved incorrectly.
3
+ labels: [bug]
4
+ body:
5
+ - type: input
6
+ id: version
7
+ attributes:
8
+ label: ResearchForge version
9
+ description: "`pip show researchforge` or `researchforge --help` header"
10
+ validations:
11
+ required: true
12
+ - type: textarea
13
+ id: what-happened
14
+ attributes:
15
+ label: What happened?
16
+ description: Include the command you ran and its output (secrets are redacted in logs, but double-check before pasting).
17
+ validations:
18
+ required: true
19
+ - type: textarea
20
+ id: expected
21
+ attributes:
22
+ label: What did you expect?
23
+ validations:
24
+ required: true
25
+ - type: textarea
26
+ id: doctor
27
+ attributes:
28
+ label: "`researchforge doctor --json` output"
29
+ render: json
@@ -0,0 +1,38 @@
1
+ name: Setup failure
2
+ description: A baseline or environment setup failed — these reports directly shape the beta.
3
+ labels: [setup-failure]
4
+ body:
5
+ - type: dropdown
6
+ id: category
7
+ attributes:
8
+ label: Failure category
9
+ description: Matches the categories in `researchforge analytics show` and baseline statuses.
10
+ options:
11
+ - failed_setup (environment/deps could not be prepared)
12
+ - failed_execution (benchmark command crashed)
13
+ - failed_timeout (hit the contract time limit)
14
+ - failed_invalid_result (result file missing or malformed)
15
+ - contract validation (researchforge.yaml would not approve)
16
+ - doctor (missing git/docker/python requirement)
17
+ - other
18
+ validations:
19
+ required: true
20
+ - type: dropdown
21
+ id: mode
22
+ attributes:
23
+ label: Execution mode
24
+ options: [docker, venv, unsure]
25
+ validations:
26
+ required: true
27
+ - type: textarea
28
+ id: details
29
+ attributes:
30
+ label: Command + output
31
+ description: The failing command and what it printed. `researchforge analytics show --json` output is welcome if you opted in.
32
+ validations:
33
+ required: true
34
+ - type: textarea
35
+ id: repo-shape
36
+ attributes:
37
+ label: Repository shape
38
+ description: Language/framework, how the benchmark is invoked, Dockerfile or not. No source code needed.
@@ -0,0 +1,34 @@
1
+ name: CI
2
+
3
+ on:
4
+ push:
5
+ branches: [main]
6
+ pull_request:
7
+
8
+ jobs:
9
+ test:
10
+ runs-on: ubuntu-latest
11
+ strategy:
12
+ matrix:
13
+ python-version: ["3.12", "3.13"]
14
+ steps:
15
+ - uses: actions/checkout@v6
16
+
17
+ - uses: actions/setup-python@v6
18
+ with:
19
+ python-version: ${{ matrix.python-version }}
20
+
21
+ - name: Install package with dev dependencies
22
+ run: pip install -e ".[dev]"
23
+
24
+ - name: Lint (ruff check)
25
+ run: ruff check .
26
+
27
+ - name: Format check (ruff format)
28
+ run: ruff format --check .
29
+
30
+ - name: Type check (mypy)
31
+ run: mypy src
32
+
33
+ - name: Test (pytest)
34
+ run: pytest --cov=researchforge --cov-report=term-missing
@@ -0,0 +1,42 @@
1
+ name: Release
2
+
3
+ on:
4
+ push:
5
+ tags: ["v*"]
6
+
7
+ jobs:
8
+ build:
9
+ runs-on: ubuntu-latest
10
+ steps:
11
+ - uses: actions/checkout@v6
12
+
13
+ - uses: actions/setup-python@v6
14
+ with:
15
+ python-version: "3.12"
16
+
17
+ - name: Build sdist and wheel
18
+ run: |
19
+ pip install build
20
+ python -m build
21
+
22
+ - uses: actions/upload-artifact@v4
23
+ with:
24
+ name: dist
25
+ path: dist/
26
+
27
+ publish:
28
+ needs: build
29
+ runs-on: ubuntu-latest
30
+ # Requires a PyPI trusted publisher configured for this repository and
31
+ # workflow, plus this GitHub environment. Nothing publishes without both.
32
+ environment: pypi
33
+ permissions:
34
+ id-token: write
35
+ steps:
36
+ - uses: actions/download-artifact@v4
37
+ with:
38
+ name: dist
39
+ path: dist/
40
+
41
+ - name: Publish to PyPI (trusted publishing)
42
+ uses: pypa/gh-action-pypi-publish@release/v1
@@ -0,0 +1,27 @@
1
+ # Python
2
+ __pycache__/
3
+ *.py[cod]
4
+ *.egg-info/
5
+ .eggs/
6
+ build/
7
+ dist/
8
+ .venv/
9
+ venv/
10
+
11
+ # Test / coverage / type-check caches
12
+ .pytest_cache/
13
+ .mypy_cache/
14
+ .ruff_cache/
15
+ .coverage
16
+ htmlcov/
17
+
18
+ # Editors / OS
19
+ .vscode/
20
+ .idea/
21
+ .DS_Store
22
+
23
+ # ResearchForge local project state
24
+ .researchforge/
25
+
26
+ # Local Claude Code state (skills are installed per-project via `researchforge claude install`)
27
+ .claude/
@@ -0,0 +1,27 @@
1
+ # Changelog
2
+
3
+ ## 0.1.0 — Phase 1 open-source beta (2026-07-24)
4
+
5
+ The complete local pipeline, Claude-first.
6
+
7
+ - **Research intelligence**: arXiv discovery (dedup + deterministic
8
+ ranking), the Claude↔CLI synthesis handshake (landscape + hypotheses with
9
+ graded evidence), citation-backed research report.
10
+ - **Experiment contract**: `researchforge.yaml` wizard, 14 semantic
11
+ validation rules, typed approval into immutable versions with drift
12
+ detection.
13
+ - **Isolated execution**: detached git worktrees per attempt, Docker
14
+ (locked-down defaults) and `.venv` runners, path guard with run-time
15
+ re-check, process-group timeouts, secrets redaction.
16
+ - **Experiment funnel**: Claude-authored patch variants through screening →
17
+ full benchmark → repeated validation; hard constraints; Pareto ranking
18
+ with honesty caveats; rejected/failed experiments preserved.
19
+ - **Shipping**: clean branch reconstructed from the frozen baseline
20
+ (pre-ship re-validation, post-conditions asserted), opt-in draft PR via
21
+ gh, engineering report, research package (BibTeX, outline,
22
+ reproducibility bundle).
23
+ - **Claude Code experience**: 12 installable project skills
24
+ (`researchforge init --claude`), manifest-based installer that never
25
+ clobbers user edits.
26
+ - **Beta tooling**: tested launch-demo examples, opt-in local-only
27
+ analytics, security notes.
@@ -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
95
+ Derivative 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,
103
+ excluding those notices that do not pertain to any part of
104
+ the Derivative 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
141
+ the 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 ResearchForge contributors
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.