graphcore-distro 0.1.0__tar.gz

graphcore_distro-0.1.0/LICENSE

@@ -0,0 +1,202 @@
+
+                                 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.

graphcore_distro-0.1.0/NOTICE

@@ -0,0 +1,2 @@
+GraphCore
+Copyright 2026 Andrew Passero

graphcore_distro-0.1.0/PKG-INFO

@@ -0,0 +1,78 @@
+Metadata-Version: 2.4
+Name: graphcore-distro
+Version: 0.1.0
+Summary: GraphCore distro — CLI, scaffolding, and curated built-in apps
+Author: GraphCore
+License-Expression: Apache-2.0
+Project-URL: Repository, https://github.com/graphcore-org/graphcore
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Programming Language :: Python :: 3.14
+Classifier: Framework :: Django
+Classifier: Framework :: Django :: 5.2
+Requires-Python: >=3.13
+Description-Content-Type: text/markdown
+License-File: LICENSE
+License-File: NOTICE
+Requires-Dist: graphcore-kernel[redis,server]==0.1.0
+Requires-Dist: graphcore-agents==0.1.0
+Requires-Dist: python-dotenv<2,>=1.0
+Dynamic: license-file
+
+# graphcore-distro (distro backend)
+
+Consumer-facing pip package `graphcore-distro`: the `graphcore` CLI, project
+scaffolding, and the kernel and built-in apps at versions released together. The wheel is a bundle of **sibling
+import packages**. `graphcore_cli` is only the command surface (argparse +
+dispatch). Anything a caller might import without going through the
+`graphcore` command is its own package; the CLI consumes it, the same way it
+consumes `graphcore_user_guides`. Generic components never live inside
+`graphcore_cli/`.
+
+```
+distro/backend/
+  graphcore_cli/            # command surface only
+  graphcore_project/        # operate a generated project — import graphcore_project
+  graphcore_user_guides/    # curated markdown
+  graphcore_project_kit/    # scaffold, skills, infra, scripts (assets only)
+  doc_topics.py             # guide topic registry
+```
+
+`graphcore_project` is the library for a generated project on disk: find the
+root, read `.env`, migrate, run. The CLI consumes it; callers that want the
+same operations without the CLI import this package. It is not
+`graphcore_project_kit` — that package is assets, not Python. The on-disk
+unit is a **project**; "deployment" in the vision docs means a running
+backend, not this directory.
+
+Requires Python 3.13+; generated projects run 3.14.
+
+```bash
+pip install graphcore-distro
+graphcore startproject myproj
+```
+
+To develop the framework, install the monorepo's packages as editables
+instead (`pip install -r requirements-dev.txt` from the monorepo root) and
+generate projects with `graphcore startproject --local-framework`. Redis is included for
+multi-process deploys; you can still point `settings.py` at LocMem or another
+cache if you do not want to use it.
+
+## Tests
+
+From the monorepo root, with the shared Postgres running (`graphcore infra up`):
+
+```bash
+scripts/test                # every suite on Postgres, database-dependent suites on SQLite
+scripts/test graphcore_cli  # narrow to a test label, on every database
+```
+
+See `.agents/skills/run-tests/SKILL.md` for the options.
+
+## CLI surface
+
+`graphcore startproject`, `startapp`, `apps list`, `run`, `migrate`, `test`,
+`dev reset`, `docker`, `infra`, `db`, `api`, `docs`, `frontend`, `skills`.
+
+`graphcore apps list` prints every discovered app and its provenance
+(`entry point: <dist>` or `apps/ directory`).

graphcore_distro-0.1.0/README.md

@@ -0,0 +1,57 @@
+# graphcore-distro (distro backend)
+
+Consumer-facing pip package `graphcore-distro`: the `graphcore` CLI, project
+scaffolding, and the kernel and built-in apps at versions released together. The wheel is a bundle of **sibling
+import packages**. `graphcore_cli` is only the command surface (argparse +
+dispatch). Anything a caller might import without going through the
+`graphcore` command is its own package; the CLI consumes it, the same way it
+consumes `graphcore_user_guides`. Generic components never live inside
+`graphcore_cli/`.
+
+```
+distro/backend/
+  graphcore_cli/            # command surface only
+  graphcore_project/        # operate a generated project — import graphcore_project
+  graphcore_user_guides/    # curated markdown
+  graphcore_project_kit/    # scaffold, skills, infra, scripts (assets only)
+  doc_topics.py             # guide topic registry
+```
+
+`graphcore_project` is the library for a generated project on disk: find the
+root, read `.env`, migrate, run. The CLI consumes it; callers that want the
+same operations without the CLI import this package. It is not
+`graphcore_project_kit` — that package is assets, not Python. The on-disk
+unit is a **project**; "deployment" in the vision docs means a running
+backend, not this directory.
+
+Requires Python 3.13+; generated projects run 3.14.
+
+```bash
+pip install graphcore-distro
+graphcore startproject myproj
+```
+
+To develop the framework, install the monorepo's packages as editables
+instead (`pip install -r requirements-dev.txt` from the monorepo root) and
+generate projects with `graphcore startproject --local-framework`. Redis is included for
+multi-process deploys; you can still point `settings.py` at LocMem or another
+cache if you do not want to use it.
+
+## Tests
+
+From the monorepo root, with the shared Postgres running (`graphcore infra up`):
+
+```bash
+scripts/test                # every suite on Postgres, database-dependent suites on SQLite
+scripts/test graphcore_cli  # narrow to a test label, on every database
+```
+
+See `.agents/skills/run-tests/SKILL.md` for the options.
+
+## CLI surface
+
+`graphcore startproject`, `startapp`, `apps list`, `run`, `migrate`, `test`,
+`dev reset`, `docker`, `infra`, `db`, `api`, `docs`, `frontend`, `skills`.
+
+`graphcore apps list` prints every discovered app and its provenance
+(`entry point: <dist>` or `apps/ directory`).

graphcore_distro-0.1.0/doc_topics.py

@@ -0,0 +1,75 @@
+"""Documentation topics contributed by the graphcore distro.
+
+These curated user guides live in the ``graphcore_user_guides`` content
+package. Their public paths are namespaced under ``distro`` by discovery.
+"""
+
+from graphcore.docs.docs_discovery import Doc
+
+TOPICS: dict[str, Doc] = {
+    "readme": Doc(
+        "graphcore_user_guides",
+        "getting_started.md",
+        "Setup, creating an app, and CLI live testing",
+    ),
+    "app-design": Doc(
+        "graphcore_user_guides",
+        "app_design/how_to_design_gc_apps.md",
+        "Design and build an app: the decisions, its TDD, building it, using it over MCP",
+    ),
+    "app-design/template": Doc(
+        "graphcore_user_guides",
+        "app_design/app_tdd_template.md",
+        "Fill-in technical design (TDD) for a new app",
+    ),
+    "app-design/example": Doc(
+        "graphcore_user_guides",
+        "app_design/stacks_tdd.md",
+        "Worked example: the Stacks app's technical design",
+    ),
+    "entities": Doc(
+        "graphcore_user_guides",
+        "entities.md",
+        "Entity types: typed fields and storage, queries, type metadata, references",
+    ),
+    "agent-views": Doc(
+        "graphcore_user_guides",
+        "agent_views.md",
+        "Agent views over MCP: rendering places, routes, tools and operations, the base views",
+    ),
+    "frontend": Doc(
+        "graphcore_user_guides",
+        "frontend.md",
+        "The web frontend: views, public pages, base path, layout, running strategies",
+    ),
+    "writing-strategies": Doc(
+        "graphcore_user_guides",
+        "writing_strategies.md",
+        "Writing strategies: apply, saving entities, retries, refusing requests, testing strategies and agent views",
+    ),
+    "custom-authorization": Doc(
+        "graphcore_user_guides",
+        "custom_authorization.md",
+        "Configure custom authorization for an app",
+    ),
+    "deployment-access": Doc(
+        "graphcore_user_guides",
+        "deployment_access.md",
+        "Administrators, groups, deployment roles, and what new users receive",
+    ),
+    "identity-infrastructure": Doc(
+        "graphcore_user_guides",
+        "identity_infrastructure.md",
+        "Identity domains, linking and token exchange; the local Keycloak, and any OIDC provider in production",
+    ),
+    "service-accounts": Doc(
+        "graphcore_user_guides",
+        "service_accounts.md",
+        "Service accounts: a process an app ships, signing in with its own client",
+    ),
+    "production": Doc(
+        "graphcore_user_guides",
+        "production.md",
+        "Running in production: what a project needs, settings, deploy steps",
+    ),
+}