py-forge-studio 0.1.0a2__tar.gz

py_forge_studio-0.1.0a2/.gitignore

@@ -0,0 +1,216 @@
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[codz]
+*$py.class
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+share/python-wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+MANIFEST
+
+# PyInstaller
+#  Usually these files are written by a python script from a template
+#  before PyInstaller builds the exe, so as to inject date/other infos into it.
+*.manifest
+*.spec
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.nox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*.cover
+*.py.cover
+.hypothesis/
+.pytest_cache/
+cover/
+
+# Translations
+*.mo
+*.pot
+
+# Django stuff:
+*.log
+local_settings.py
+db.sqlite3
+db.sqlite3-journal
+
+# Flask stuff:
+instance/
+.webassets-cache
+
+# Scrapy stuff:
+.scrapy
+
+# Sphinx documentation
+docs/_build/
+
+# PyBuilder
+.pybuilder/
+target/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# IPython
+profile_default/
+ipython_config.py
+
+# pyenv
+#   For a library or package, you might want to ignore these files since the code is
+#   intended to run in multiple environments; otherwise, check them in:
+# .python-version
+
+# pipenv
+#   According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
+#   However, in case of collaboration, if having platform-specific dependencies or dependencies
+#   having no cross-platform support, pipenv may install dependencies that don't work, or not
+#   install all needed dependencies.
+#Pipfile.lock
+
+# UV
+#   Similar to Pipfile.lock, it is generally recommended to include uv.lock in version control.
+#   This is especially recommended for binary packages to ensure reproducibility, and is more
+#   commonly ignored for libraries.
+#uv.lock
+
+# poetry
+#   Similar to Pipfile.lock, it is generally recommended to include poetry.lock in version control.
+#   This is especially recommended for binary packages to ensure reproducibility, and is more
+#   commonly ignored for libraries.
+#   https://python-poetry.org/docs/basic-usage/#commit-your-poetrylock-file-to-version-control
+#poetry.lock
+#poetry.toml
+
+# pdm
+#   Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control.
+#   pdm recommends including project-wide configuration in pdm.toml, but excluding .pdm-python.
+#   https://pdm-project.org/en/latest/usage/project/#working-with-version-control
+#pdm.lock
+#pdm.toml
+.pdm-python
+.pdm-build/
+
+# pixi
+#   Similar to Pipfile.lock, it is generally recommended to include pixi.lock in version control.
+#pixi.lock
+#   Pixi creates a virtual environment in the .pixi directory, just like venv module creates one
+#   in the .venv directory. It is recommended not to include this directory in version control.
+.pixi
+
+# PEP 582; used by e.g. github.com/David-OConnor/pyflow and github.com/pdm-project/pdm
+__pypackages__/
+
+# Celery stuff
+celerybeat-schedule
+celerybeat.pid
+
+# SageMath parsed files
+*.sage.py
+
+# Environments
+.env
+.envrc
+.venv
+env/
+venv/
+ENV/
+env.bak/
+venv.bak/
+
+# Spyder project settings
+.spyderproject
+.spyproject
+
+# Rope project settings
+.ropeproject
+
+# mkdocs documentation
+/site
+
+# mypy
+.mypy_cache/
+.dmypy.json
+dmypy.json
+
+# Pyre type checker
+.pyre/
+
+# pytype static type analyzer
+.pytype/
+
+# Cython debug symbols
+cython_debug/
+
+# PyCharm
+#  JetBrains specific template is maintained in a separate JetBrains.gitignore that can
+#  be found at https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore
+#  and can be added to the global gitignore or merged into this file.  For a more nuclear
+#  option (not recommended) you can uncomment the following to ignore the entire idea folder.
+#.idea/
+
+# Abstra
+# Abstra is an AI-powered process automation framework.
+# Ignore directories containing user credentials, local state, and settings.
+# Learn more at https://abstra.io/docs
+.abstra/
+
+# Visual Studio Code
+#  Visual Studio Code specific template is maintained in a separate VisualStudioCode.gitignore 
+#  that can be found at https://github.com/github/gitignore/blob/main/Global/VisualStudioCode.gitignore
+#  and can be added to the global gitignore or merged into this file. However, if you prefer, 
+#  you could uncomment the following to ignore the entire vscode folder
+# .vscode/
+
+# Ruff stuff:
+.ruff_cache/
+
+# PyPI configuration file
+.pypirc
+
+# Cursor
+#  Cursor is an AI-powered code editor. `.cursorignore` specifies files/directories to
+#  exclude from AI features like autocomplete and code analysis. Recommended for sensitive data
+#  refer to https://docs.cursor.com/context/ignore-files
+.cursorignore
+.cursorindexingignore
+
+# Marimo
+marimo/_static/
+marimo/_lsp/
+__marimo__/
+
+# ralph
+ralph.py
+progress.md
+PRD.md
+openapi.json
+
+# others
+uv.lock

py_forge_studio-0.1.0a2/LICENSE

@@ -0,0 +1,17 @@
+Copyright (c) 2026 Forge Systems, Inc. All rights reserved.
+
+This software and associated documentation files (the "Software") are the
+proprietary property of Forge Systems, Inc. Unauthorized copying, distribution,
+modification, or use of this Software, via any medium, is strictly prohibited.
+
+The Software is provided to authorized licensees under the terms of a separate
+license agreement. Use of the Software is subject to the terms and conditions
+of that agreement.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

py_forge_studio-0.1.0a2/PKG-INFO

@@ -0,0 +1,95 @@
+Metadata-Version: 2.4
+Name: py-forge-studio
+Version: 0.1.0a2
+Summary: Python client for the Forge Studio API
+Project-URL: Homepage, https://forge-studio.tech
+Project-URL: Documentation, https://github.com/Forge-Systems/forge-py#readme
+Project-URL: Repository, https://github.com/Forge-Systems/forge-py
+Project-URL: Bug Tracker, https://github.com/Forge-Systems/forge-py/issues
+Author-email: Forge Systems <support@forge-studio.tech>
+License-Expression: LicenseRef-Proprietary
+License-File: LICENSE
+Classifier: Development Status :: 3 - Alpha
+Classifier: Intended Audience :: Developers
+Classifier: License :: Other/Proprietary License
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Typing :: Typed
+Requires-Python: >=3.9
+Requires-Dist: anyio>=4.0
+Requires-Dist: httpx>=0.27
+Requires-Dist: pydantic>=2.0
+Provides-Extra: dev
+Requires-Dist: pyright>=1.1; extra == 'dev'
+Requires-Dist: pytest-asyncio>=0.21; extra == 'dev'
+Requires-Dist: pytest-timeout>=2.0; extra == 'dev'
+Requires-Dist: pytest>=7.0; extra == 'dev'
+Requires-Dist: respx>=0.20; extra == 'dev'
+Requires-Dist: ruff>=0.4; extra == 'dev'
+Description-Content-Type: text/markdown
+
+# py-forge-studio
+
+Python client for the Forge Studio API.
+
+## Install
+
+```bash
+pip install py-forge-studio
+```
+
+## Quick start
+
+```python
+from py_forge import Client
+
+client = Client()  # uses FORGE_API_KEY env var
+
+repo = client.repositories.create(name="my-repo", repo_type_key="TST")
+branch = client.branches.create(repo.id, name="main-work")
+node = client.nodes.create(repo.id, branch.id, node_data={
+    "@type": "Folder",
+    "@id": "Folder_1",
+    "doc_string": "My first node",
+})
+print(f"Created node {node.id} on branch {branch.id}")
+```
+
+## Authentication
+
+Set `FORGE_API_KEY` and `FORGE_BASE_URL` as environment variables:
+
+```bash
+export FORGE_API_KEY="your-api-key"
+export FORGE_BASE_URL="https://your-instance.forge-studio.tech/api"
+```
+
+Or pass them directly:
+
+```python
+client = Client(
+    api_key="your-api-key",
+    base_url="https://your-instance.forge-studio.tech/api",
+)
+```
+
+Each Forge instance has its own URL in the form `https://<instance>.forge-studio.tech/api`. Contact your Forge account team if you don't know your instance name.
+
+## Usage highlights
+
+| Topic | Example |
+|---|---|
+| Quick start | [`examples/quickstart.py`](examples/quickstart.py) |
+| Repositories | [`examples/repositories.py`](examples/repositories.py) |
+| Branches | [`examples/branches.py`](examples/branches.py) |
+| Nodes | [`examples/nodes.py`](examples/nodes.py) |
+| Merge & rebase | [`examples/merge_and_rebase.py`](examples/merge_and_rebase.py) |
+| Async usage | [`examples/async_usage.py`](examples/async_usage.py) |
+
+## Requirements
+
+Python >= 3.9

py_forge_studio-0.1.0a2/README.md

@@ -0,0 +1,61 @@
+# py-forge-studio
+
+Python client for the Forge Studio API.
+
+## Install
+
+```bash
+pip install py-forge-studio
+```
+
+## Quick start
+
+```python
+from py_forge import Client
+
+client = Client()  # uses FORGE_API_KEY env var
+
+repo = client.repositories.create(name="my-repo", repo_type_key="TST")
+branch = client.branches.create(repo.id, name="main-work")
+node = client.nodes.create(repo.id, branch.id, node_data={
+    "@type": "Folder",
+    "@id": "Folder_1",
+    "doc_string": "My first node",
+})
+print(f"Created node {node.id} on branch {branch.id}")
+```
+
+## Authentication
+
+Set `FORGE_API_KEY` and `FORGE_BASE_URL` as environment variables:
+
+```bash
+export FORGE_API_KEY="your-api-key"
+export FORGE_BASE_URL="https://your-instance.forge-studio.tech/api"
+```
+
+Or pass them directly:
+
+```python
+client = Client(
+    api_key="your-api-key",
+    base_url="https://your-instance.forge-studio.tech/api",
+)
+```
+
+Each Forge instance has its own URL in the form `https://<instance>.forge-studio.tech/api`. Contact your Forge account team if you don't know your instance name.
+
+## Usage highlights
+
+| Topic | Example |
+|---|---|
+| Quick start | [`examples/quickstart.py`](examples/quickstart.py) |
+| Repositories | [`examples/repositories.py`](examples/repositories.py) |
+| Branches | [`examples/branches.py`](examples/branches.py) |
+| Nodes | [`examples/nodes.py`](examples/nodes.py) |
+| Merge & rebase | [`examples/merge_and_rebase.py`](examples/merge_and_rebase.py) |
+| Async usage | [`examples/async_usage.py`](examples/async_usage.py) |
+
+## Requirements
+
+Python >= 3.9

py_forge_studio-0.1.0a2/examples/async_usage.py

@@ -0,0 +1,53 @@
+"""
+Async usage — async mirror of the quickstart example.
+
+Usage:
+    export FORGE_API_KEY="your-api-key"
+    python examples/async_usage.py
+"""
+
+import asyncio
+from py_forge import AsyncClient
+
+async def main():
+    client = AsyncClient()
+    repo = None
+
+    try:
+        # Create a repository
+        repo = await client.repositories.create(
+            name="async-example-repo",
+            repo_type_key="TST",
+            description="Created by async example",
+        )
+        print(f"Repository: {repo.id} ({repo.name})")
+
+        # Create a branch
+        branch = await client.branches.create(repo.id, name="async-branch")
+        print(f"Branch: {branch.id} ({branch.name})")
+
+        # Create a node
+        node = await client.nodes.create(
+            repo.id,
+            branch.id,
+            node_data={
+                "@type": "Folder",
+                "@id": "Folder_async",
+                "doc_string": "Created asynchronously",
+            },
+        )
+        print(f"Node: {node.id}")
+
+        # List nodes with async pagination
+        page = await client.nodes.list(repo.id, branch.id)
+        async for n in page:
+            print(f"  - {n.id}")
+
+    finally:
+        if repo:
+            await client.repositories.delete(repo.id)
+            print("Cleaned up repository")
+
+
+if __name__ == "__main__":
+    asyncio.run(main())

py_forge_studio-0.1.0a2/examples/branches.py

@@ -0,0 +1,71 @@
+"""
+Branches — CRUD operations and diff.
+
+Usage:
+    export FORGE_API_KEY="your-api-key"
+    python examples/branches.py
+"""
+
+from py_forge import Client
+
+def main():
+    client = Client()
+    repo = None
+
+    try:
+        repo = client.repositories.create(
+            name="branches-example",
+            repo_type_key="TST",
+        )
+        print(f"Repository: {repo.id}")
+
+        # Create two branches
+        branch_a = client.branches.create(repo.id, name="branch-a", description="First branch")
+        branch_b = client.branches.create(repo.id, name="branch-b", description="Second branch")
+        print(f"Created: {branch_a.name}, {branch_b.name}")
+
+        # Get a single branch
+        fetched = client.branches.get(repo.id, branch_a.id)
+        print(f"Fetched: {fetched.name} (is_default: {fetched.is_default})")
+
+        # Update
+        updated = client.branches.update(
+            repo.id, branch_a.id, description="Updated description"
+        )
+        print(f"Updated: {updated.name} — {updated.description}")
+
+        # List all branches
+        page = client.branches.list(repo.id)
+        print(f"Total branches: {page.total_count}")
+        for b in page.data:
+            print(f"  - {b.name} ({b.id})")
+
+        # Get branch head
+        head = client.branches.get_head(repo.id, branch_a.id)
+        print(f"Branch head: {head}")
+
+        # Add a node to branch_a so there's something to diff
+        client.nodes.create(
+            repo.id,
+            branch_a.id,
+            node_data={"@type": "Folder", "@id": "Folder_diff", "doc_string": "For diff"},
+        )
+
+        # Diff between branches
+        diff = client.branches.diff(
+            repo.id, branch_a.id, target_branch_id=branch_b.id
+        )
+        print(f"Diff: {diff}")
+
+        # Delete a branch
+        client.branches.delete(repo.id, branch_b.id)
+        print(f"Deleted {branch_b.name}")
+
+    finally:
+        if repo:
+            client.repositories.delete(repo.id)
+            print("Cleaned up repository")
+
+
+if __name__ == "__main__":
+    main()

py_forge_studio-0.1.0a2/examples/merge_and_rebase.py

@@ -0,0 +1,85 @@
+"""
+Merge and rebase — diff branches, then merge or rebase.
+
+Usage:
+    export FORGE_API_KEY="your-api-key"
+    python examples/merge_and_rebase.py
+"""
+
+from py_forge import Client
+
+def main():
+    client = Client()
+    repo = None
+
+    try:
+        repo = client.repositories.create(
+            name="merge-rebase-example",
+            repo_type_key="TST",
+        )
+
+        # Set up two branches with diverging content
+        main_branch = client.branches.create(repo.id, name="main-line")
+        feature = client.branches.create(
+            repo.id, name="feature", source_branch_id=main_branch.id
+        )
+
+        # Add a node to the feature branch
+        client.nodes.create(
+            repo.id,
+            feature.id,
+            node_data={
+                "@type": "Folder",
+                "@id": "Folder_feature",
+                "doc_string": "Feature work",
+            },
+        )
+
+        # Diff before merging
+        diff = client.branches.diff(
+            repo.id, feature.id, target_branch_id=main_branch.id
+        )
+        print(f"Diff (feature → main): {diff}")
+
+        # Merge feature into main
+        merge_result = client.repositories.merge(
+            repo.id,
+            source_branch_id=feature.id,
+            target_branch_id=main_branch.id,
+            message="Merge feature into main",
+        )
+        print(f"Merge result: {merge_result}")
+
+        # --- Rebase example ---
+
+        rebase_branch = client.branches.create(
+            repo.id, name="rebase-me", source_branch_id=main_branch.id
+        )
+
+        client.nodes.create(
+            repo.id,
+            rebase_branch.id,
+            node_data={
+                "@type": "Folder",
+                "@id": "Folder_rebase",
+                "doc_string": "Will be rebased",
+            },
+        )
+
+        # Rebase onto main
+        rebase_result = client.repositories.rebase(
+            repo.id,
+            source_branch=rebase_branch.id,
+            onto_branch=main_branch.id,
+            message="Rebase onto main",
+        )
+        print(f"Rebase result: {rebase_result}")
+
+    finally:
+        if repo:
+            client.repositories.delete(repo.id)
+            print("Cleaned up repository")
+
+
+if __name__ == "__main__":
+    main()

py_forge_studio-0.1.0a2/examples/nodes.py

@@ -0,0 +1,106 @@
+"""
+Nodes — CRUD, history, and commit with batched operations.
+
+Usage:
+    export FORGE_API_KEY="your-api-key"
+    python examples/nodes.py
+"""
+
+from py_forge import Client
+
+def main():
+    client = Client()
+    repo = None
+
+    try:
+        repo = client.repositories.create(
+            name="nodes-example",
+            repo_type_key="TST",
+        )
+        branch = client.branches.create(repo.id, name="work")
+        print(f"Repository: {repo.id}, Branch: {branch.id}")
+
+        # Create a node directly
+        node = client.nodes.create(
+            repo.id,
+            branch.id,
+            node_data={
+                "@type": "Folder",
+                "@id": "Folder_1",
+                "doc_string": "First folder",
+            },
+        )
+        print(f"Created node: {node.id}")
+
+        # Read it back
+        fetched = client.nodes.get(repo.id, branch.id, node.id)
+        print(f"Fetched: {fetched.node}")
+
+        # Update the node
+        updated = client.nodes.update(
+            repo.id,
+            branch.id,
+            node.id,
+            node_data={
+                "@type": "Folder",
+                "@id": "Folder_1",
+                "doc_string": "Updated folder",
+            },
+        )
+        print(f"Updated: {updated.node}")
+
+        # List nodes
+        page = client.nodes.list(repo.id, branch.id)
+        print(f"Total nodes: {page.total_count}")
+        for n in page.data:
+            print(f"  - {n.id}")
+
+        # Node history
+        history = client.nodes.get_history(repo.id, branch.id, node.id)
+        print(f"History: {history}")
+
+        # Single commit with multiple operations (create, update, delete)
+        commit = client.commits.create(
+            repo.id,
+            branch.id,
+            message="Batch: create, update, and delete nodes",
+            operations=[
+                {
+                    "type": "node_create",
+                    "data": {
+                        "node_data": {
+                            "@type": "Folder",
+                            "@id": "Folder_batch_1",
+                            "doc_string": "Created in batch",
+                        }
+                    },
+                },
+                {
+                    "type": "node_update",
+                    "data": {
+                        "node_id": node.id,
+                        "node_data": {
+                            "@type": "Folder",
+                            "@id": "Folder_1",
+                            "doc_string": "Updated in batch",
+                        },
+                    },
+                },
+                {
+                    "type": "node_delete",
+                    "data": {
+                        "node_id": node.id,
+                    },
+                },
+            ],
+        )
+        print(f"Commit: {commit.id} — {commit.message}")
+
+    finally:
+        if repo:
+            client.repositories.delete(repo.id)
+            print("Cleaned up repository")
+
+
+if __name__ == "__main__":
+    main()