swarmauri_tool_githubloader 0.9.0.dev4__tar.gz → 0.9.0.dev34__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.
@@ -1,8 +1,10 @@
1
- Metadata-Version: 2.3
1
+ Metadata-Version: 2.4
2
2
  Name: swarmauri_tool_githubloader
3
- Version: 0.9.0.dev4
3
+ Version: 0.9.0.dev34
4
4
  Summary: Load YAML-defined components directly from GitHub repositories.
5
- License: Apache-2.0
5
+ License-Expression: Apache-2.0
6
+ License-File: LICENSE
7
+ Keywords: swarmauri,sdk,standards,tool,githubloader,tooling
6
8
  Author: Jacob Stewart
7
9
  Author-email: jacob@swarmauri.com
8
10
  Requires-Python: >=3.10,<3.13
@@ -10,13 +12,16 @@ Classifier: License :: OSI Approved :: Apache Software License
10
12
  Classifier: Programming Language :: Python :: 3.10
11
13
  Classifier: Programming Language :: Python :: 3.11
12
14
  Classifier: Programming Language :: Python :: 3.12
15
+ Classifier: Programming Language :: Python
16
+ Classifier: Programming Language :: Python :: 3
17
+ Classifier: Programming Language :: Python :: 3 :: Only
13
18
  Requires-Dist: requests (>=2.32.3)
14
19
  Requires-Dist: swarmauri_base
15
20
  Requires-Dist: swarmauri_core
16
21
  Requires-Dist: swarmauri_standard
17
22
  Description-Content-Type: text/markdown
18
23
 
19
- ![Swamauri Logo](https://res.cloudinary.com/dbjmpekvl/image/upload/v1730099724/Swarmauri-logo-lockup-2048x757_hww01w.png)
24
+ ![Swarmauri Logo](https://github.com/swarmauri/swarmauri-sdk/blob/3d4d1cfa949399d7019ae9d8f296afba773dfb7f/assets/swarmauri.brand.theme.svg)
20
25
 
21
26
  <p align="center">
22
27
  <a href="https://pypi.org/project/swarmauri_tool_githubloader/">
@@ -59,6 +64,43 @@ tool = GithubLoadedTool(
59
64
  result = tool(x=1, y=2)
60
65
  ```
61
66
 
67
+ ### Options
68
+
69
+ Customize how the loader fetches your component:
70
+
71
+ - **branch** – Branch to read from (defaults to `"master"`).
72
+ - **commit_ref** – Specific commit SHA; overrides `branch` when provided.
73
+ - **token** – GitHub token for private repositories.
74
+ - **use_cache** – Set to `False` to reload the component on every call.
75
+
76
+ ### Advanced examples
77
+
78
+ Fetch from a branch and pin a commit:
79
+
80
+ ```python
81
+ tool = GithubLoadedTool(
82
+ owner="myorg",
83
+ repo="myrepo",
84
+ path="tools/addition.yaml",
85
+ branch="develop",
86
+ commit_ref="0123456789abcdef",
87
+ )
88
+ ```
89
+
90
+ Load from a private repository with caching disabled:
91
+
92
+ ```python
93
+ import os
94
+
95
+ tool = GithubLoadedTool(
96
+ owner="myorg",
97
+ repo="private-repo",
98
+ path="tools/addition.yaml",
99
+ token=os.environ["GITHUB_TOKEN"],
100
+ use_cache=False,
101
+ )
102
+ ```
103
+
62
104
  ## Want to help?
63
105
 
64
106
  If you want to contribute to swarmauri-sdk, read up on our [guidelines for contributing](https://github.com/swarmauri/swarmauri-sdk/blob/master/contributing.md) that will help you get started.
@@ -1,4 +1,4 @@
1
- ![Swamauri Logo](https://res.cloudinary.com/dbjmpekvl/image/upload/v1730099724/Swarmauri-logo-lockup-2048x757_hww01w.png)
1
+ ![Swarmauri Logo](https://github.com/swarmauri/swarmauri-sdk/blob/3d4d1cfa949399d7019ae9d8f296afba773dfb7f/assets/swarmauri.brand.theme.svg)
2
2
 
3
3
  <p align="center">
4
4
  <a href="https://pypi.org/project/swarmauri_tool_githubloader/">
@@ -41,6 +41,43 @@ tool = GithubLoadedTool(
41
41
  result = tool(x=1, y=2)
42
42
  ```
43
43
 
44
+ ### Options
45
+
46
+ Customize how the loader fetches your component:
47
+
48
+ - **branch** – Branch to read from (defaults to `"master"`).
49
+ - **commit_ref** – Specific commit SHA; overrides `branch` when provided.
50
+ - **token** – GitHub token for private repositories.
51
+ - **use_cache** – Set to `False` to reload the component on every call.
52
+
53
+ ### Advanced examples
54
+
55
+ Fetch from a branch and pin a commit:
56
+
57
+ ```python
58
+ tool = GithubLoadedTool(
59
+ owner="myorg",
60
+ repo="myrepo",
61
+ path="tools/addition.yaml",
62
+ branch="develop",
63
+ commit_ref="0123456789abcdef",
64
+ )
65
+ ```
66
+
67
+ Load from a private repository with caching disabled:
68
+
69
+ ```python
70
+ import os
71
+
72
+ tool = GithubLoadedTool(
73
+ owner="myorg",
74
+ repo="private-repo",
75
+ path="tools/addition.yaml",
76
+ token=os.environ["GITHUB_TOKEN"],
77
+ use_cache=False,
78
+ )
79
+ ```
80
+
44
81
  ## Want to help?
45
82
 
46
83
  If you want to contribute to swarmauri-sdk, read up on our [guidelines for contributing](https://github.com/swarmauri/swarmauri-sdk/blob/master/contributing.md) that will help you get started.
@@ -1,6 +1,6 @@
1
1
  [project]
2
2
  name = "swarmauri_tool_githubloader"
3
- version = "0.9.0.dev4"
3
+ version = "0.9.0.dev34"
4
4
  description = "Load YAML-defined components directly from GitHub repositories."
5
5
  license = "Apache-2.0"
6
6
  readme = "README.md"
@@ -11,6 +11,9 @@ classifiers = [
11
11
  "Programming Language :: Python :: 3.10",
12
12
  "Programming Language :: Python :: 3.11",
13
13
  "Programming Language :: Python :: 3.12",
14
+ "Programming Language :: Python",
15
+ "Programming Language :: Python :: 3",
16
+ "Programming Language :: Python :: 3 :: Only",
14
17
  ]
15
18
  authors = [{ name = "Jacob Stewart", email = "jacob@swarmauri.com" }]
16
19
  dependencies = [
@@ -19,6 +22,14 @@ dependencies = [
19
22
  "swarmauri_base",
20
23
  "swarmauri_standard",
21
24
  ]
25
+ keywords = [
26
+ 'swarmauri',
27
+ 'sdk',
28
+ 'standards',
29
+ 'tool',
30
+ 'githubloader',
31
+ 'tooling',
32
+ ]
22
33
 
23
34
  [tool.uv.sources]
24
35
  swarmauri_core = { workspace = true }
@@ -20,7 +20,7 @@ class GithubLoadedTool(ToolBase):
20
20
  owner: str
21
21
  repo: str
22
22
  path: str
23
- branch: str = "main"
23
+ branch: str = "master"
24
24
  commit_ref: Optional[str] = None
25
25
  token: Optional[str] = None
26
26
  use_cache: bool = True