swarmauri_toolkit_github 0.6.1.dev3__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.
@@ -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 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 [2025] [Jacob Stewart @ Swarmauri]
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.
@@ -0,0 +1,82 @@
1
+ Metadata-Version: 2.3
2
+ Name: swarmauri_toolkit_github
3
+ Version: 0.6.1.dev3
4
+ Summary: Github Toolkit
5
+ License: Apache-2.0
6
+ Author: Jacob Stewart
7
+ Author-email: jacob@swarmauri.com
8
+ Requires-Python: >=3.10,<3.13
9
+ Classifier: License :: OSI Approved :: Apache Software License
10
+ Classifier: Programming Language :: Python :: 3
11
+ Classifier: Programming Language :: Python :: 3.10
12
+ Classifier: Programming Language :: Python :: 3.11
13
+ Classifier: Programming Language :: Python :: 3.12
14
+ Requires-Dist: pygithub (>=2.4.0,<3.0.0)
15
+ Requires-Dist: swarmauri_base (>=0.6.1.dev4,<0.7.0)
16
+ Requires-Dist: swarmauri_core (>=0.6.1.dev4,<0.7.0)
17
+ Requires-Dist: swarmauri_standard (>=0.6.1.dev4,<0.7.0)
18
+ Project-URL: Repository, http://github.com/swarmauri/swarmauri-sdk
19
+ Description-Content-Type: text/markdown
20
+
21
+ ![Swarmauri Logo](https://res.cloudinary.com/dbjmpekvl/image/upload/v1730099724/Swarmauri-logo-lockup-2048x757_hww01w.png)
22
+
23
+ <div align="center">
24
+
25
+ ![PyPI - Downloads](https://img.shields.io/pypi/dm/swarmauri_tool_github)
26
+ ![PyPI - Python Version](https://img.shields.io/pypi/pyversions/swarmauri-tool-github)
27
+ ![PyPI - License](https://img.shields.io/pypi/l/swarmauri_tool_github)
28
+ ![PyPI - Version](https://img.shields.io/pypi/v/swarmauri-tool-github?label=swarmauri_tool_github&color=green)
29
+
30
+ </div>
31
+
32
+ ---
33
+
34
+ # GitHub Tools Package
35
+
36
+ A collection of GitHub tools for repository, issue, pull request, branch, and commit management using PyGithub.
37
+
38
+ ## Installation
39
+
40
+ ```bash
41
+ pip install swarmauri_tool_github
42
+ ```
43
+
44
+ ## Usage
45
+
46
+ Here's a basic example using the GitHub toolkit:
47
+
48
+ ```python
49
+ from swarmauri.tools.GithubToolkit import GithubToolkit
50
+
51
+ # Initialize the toolkit with your GitHub token
52
+ toolkit = GithubToolkit(token="your_github_token")
53
+
54
+ # Create a repository
55
+ result = toolkit.github_repo_tool(
56
+ action="create_repo",
57
+ repo_name="my-new-repo"
58
+ )
59
+
60
+ # Create an issue
61
+ result = toolkit.github_issue_tool(
62
+ action="create_issue",
63
+ repo_name="owner/repository",
64
+ title="Bug Report",
65
+ body="Description of the issue"
66
+ )
67
+
68
+ # Create a pull request
69
+ result = toolkit.github_pr_tool(
70
+ action="create_pull",
71
+ repo_name="owner/repository",
72
+ title="New Feature",
73
+ head="feature-branch",
74
+ base="main"
75
+ )
76
+ ```
77
+
78
+ ## Want to help?
79
+
80
+ 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.
81
+
82
+
@@ -0,0 +1,61 @@
1
+ ![Swarmauri Logo](https://res.cloudinary.com/dbjmpekvl/image/upload/v1730099724/Swarmauri-logo-lockup-2048x757_hww01w.png)
2
+
3
+ <div align="center">
4
+
5
+ ![PyPI - Downloads](https://img.shields.io/pypi/dm/swarmauri_tool_github)
6
+ ![PyPI - Python Version](https://img.shields.io/pypi/pyversions/swarmauri-tool-github)
7
+ ![PyPI - License](https://img.shields.io/pypi/l/swarmauri_tool_github)
8
+ ![PyPI - Version](https://img.shields.io/pypi/v/swarmauri-tool-github?label=swarmauri_tool_github&color=green)
9
+
10
+ </div>
11
+
12
+ ---
13
+
14
+ # GitHub Tools Package
15
+
16
+ A collection of GitHub tools for repository, issue, pull request, branch, and commit management using PyGithub.
17
+
18
+ ## Installation
19
+
20
+ ```bash
21
+ pip install swarmauri_tool_github
22
+ ```
23
+
24
+ ## Usage
25
+
26
+ Here's a basic example using the GitHub toolkit:
27
+
28
+ ```python
29
+ from swarmauri.tools.GithubToolkit import GithubToolkit
30
+
31
+ # Initialize the toolkit with your GitHub token
32
+ toolkit = GithubToolkit(token="your_github_token")
33
+
34
+ # Create a repository
35
+ result = toolkit.github_repo_tool(
36
+ action="create_repo",
37
+ repo_name="my-new-repo"
38
+ )
39
+
40
+ # Create an issue
41
+ result = toolkit.github_issue_tool(
42
+ action="create_issue",
43
+ repo_name="owner/repository",
44
+ title="Bug Report",
45
+ body="Description of the issue"
46
+ )
47
+
48
+ # Create a pull request
49
+ result = toolkit.github_pr_tool(
50
+ action="create_pull",
51
+ repo_name="owner/repository",
52
+ title="New Feature",
53
+ head="feature-branch",
54
+ base="main"
55
+ )
56
+ ```
57
+
58
+ ## Want to help?
59
+
60
+ 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.
61
+
@@ -0,0 +1,67 @@
1
+ [tool.poetry]
2
+ name = "swarmauri_toolkit_github"
3
+ version = "0.6.1.dev3"
4
+ description = "Github Toolkit"
5
+ authors = ["Jacob Stewart <jacob@swarmauri.com>"]
6
+ license = "Apache-2.0"
7
+ readme = "README.md"
8
+ repository = "http://github.com/swarmauri/swarmauri-sdk"
9
+ classifiers = [
10
+ "License :: OSI Approved :: Apache Software License",
11
+ "Programming Language :: Python :: 3.10",
12
+ "Programming Language :: Python :: 3.11",
13
+ "Programming Language :: Python :: 3.12"
14
+ ]
15
+
16
+ [tool.poetry.dependencies]
17
+ python = ">=3.10,<3.13"
18
+
19
+ # Swarmauri
20
+ swarmauri_core = {version = "^0.6.1.dev4"}
21
+ swarmauri_base = {version = "^0.6.1.dev4"}
22
+ swarmauri_standard = {version = "^0.6.1.dev4"}
23
+
24
+ # Dependencies
25
+ pygithub = "^2.4.0"
26
+
27
+
28
+
29
+ [tool.poetry.group.dev.dependencies]
30
+ flake8 = "^7.0"
31
+ pytest = "^8.0"
32
+ pytest-asyncio = ">=0.24.0"
33
+ pytest-xdist = "^3.6.1"
34
+ pytest-json-report = "^1.5.0"
35
+ python-dotenv = "*"
36
+ requests = "^2.32.3"
37
+
38
+ [build-system]
39
+ requires = ["poetry-core>=1.0.0"]
40
+ build-backend = "poetry.core.masonry.api"
41
+
42
+ [tool.pytest.ini_options]
43
+ norecursedirs = ["combined", "scripts"]
44
+
45
+ markers = [
46
+ "test: standard test",
47
+ "unit: Unit tests",
48
+ "integration: Integration tests",
49
+ "acceptance: Acceptance tests",
50
+ "experimental: Experimental tests"
51
+ ]
52
+ log_cli = true
53
+ log_cli_level = "INFO"
54
+ log_cli_format = "%(asctime)s [%(levelname)s] %(message)s"
55
+ log_cli_date_format = "%Y-%m-%d %H:%M:%S"
56
+ asyncio_default_fixture_loop_scope = "function"
57
+
58
+ [tool.poetry.plugins."swarmauri.tools"]
59
+ GithubBranchTool = "swarmauri_toolkit_github.GithubBranchTool:GithubBranchTool"
60
+ GithubCommitTool = "swarmauri_toolkit_github.GithubCommitTool:GithubCommitTool"
61
+ GithubIssueTool = "swarmauri_toolkit_github.GithubIssueTool:GithubIssueTool"
62
+ GithubPRTool = "swarmauri_toolkit_github.GithubPRTool:GithubPRTool"
63
+ GithubRepoTool = "swarmauri_toolkit_github.GithubRepoTool:GithubRepoTool"
64
+
65
+ [tool.poetry.plugins."swarmauri.toolkits"]
66
+ GithubToolkit = "swarmauri_toolkit_github.GithubToolkit:GithubToolkit"
67
+
@@ -0,0 +1,108 @@
1
+ # swarmauri/community/tools/concrete/GithubCommunityTool.py
2
+
3
+ from github import Github, GithubException
4
+ from typing import List, Dict, Literal, Any
5
+ from swarmauri_core.ComponentBase import ComponentBase
6
+ from pydantic import Field, ConfigDict
7
+ from swarmauri_base.tools.ToolBase import ToolBase
8
+ from swarmauri_standard.tools.Parameter import Parameter
9
+
10
+
11
+ @ComponentBase.register_type(ToolBase, "GithubBranchTool")
12
+ class GithubBranchTool(ToolBase):
13
+ version: str = "1.1.0"
14
+ parameters: List[Parameter] = Field(
15
+ default_factory=lambda: [
16
+ Parameter(
17
+ name="action",
18
+ type="string",
19
+ description="The action to perform on the GitHub API, e.g., 'create_repo', 'delete_repo', 'create_issue', etc.",
20
+ required=True,
21
+ ),
22
+ Parameter(
23
+ name="repo_name",
24
+ type="string",
25
+ description="The full name of the repository to interact with, e.g. 'owner/repository'.",
26
+ required=True,
27
+ ),
28
+ Parameter(
29
+ name="branch_name",
30
+ type="string",
31
+ description="The name of the branch to interact with.",
32
+ required=False,
33
+ ),
34
+ Parameter(
35
+ name="source_branch",
36
+ type="string",
37
+ description="The name of the source branch to create a branch from.",
38
+ required=False,
39
+ ),
40
+ ]
41
+ )
42
+ name: str = "GithubBranchTool"
43
+ description: str = "Interacts with GitHub branches using PyGithub."
44
+ type: Literal["GithubBranchTool"] = "GithubBranchTool"
45
+ token: str
46
+ model_config = ConfigDict(arbitrary_types_allowed=True)
47
+
48
+ def __call__(self, action: str, **kwargs) -> Dict[str, Any]:
49
+ """
50
+ Central method to call various GitHub API actions.
51
+
52
+ Args:
53
+ action (str): The action to perform.
54
+ **kwargs: Additional keyword arguments related to the action.
55
+
56
+ Returns:
57
+ Dict[str, Any]: The result of the action.
58
+ """
59
+ action_map = {
60
+ "create_branch": self.create_branch,
61
+ "delete_branch": self.delete_branch,
62
+ "list_branches": self.list_branches,
63
+ "get_branch": self.get_branch,
64
+ }
65
+
66
+ if action in action_map:
67
+ self._github = Github(self.token)
68
+ return {action: action_map[action](**kwargs)}
69
+
70
+ raise ValueError(f"Action '{action}' is not supported.")
71
+
72
+ # Branch Management Methods
73
+ def create_branch(
74
+ self, repo_name: str, branch_name: str, source: str = "main"
75
+ ) -> str:
76
+ try:
77
+ repo = self._github.get_repo(repo_name)
78
+ source_branch = repo.get_branch(source)
79
+ repo.create_git_ref(
80
+ ref=f"refs/heads/{branch_name}", sha=source_branch.commit.sha
81
+ )
82
+ return f"Branch '{branch_name}' created successfully."
83
+ except GithubException as e:
84
+ return f"Error creating branch: {e}"
85
+
86
+ def delete_branch(self, repo_name: str, branch_name: str) -> str:
87
+ try:
88
+ repo = self._github.get_repo(repo_name)
89
+ ref = repo.get_git_ref(f"heads/{branch_name}")
90
+ ref.delete()
91
+ return f"Branch '{branch_name}' deleted successfully."
92
+ except GithubException as e:
93
+ return f"Error deleting branch: {e}"
94
+
95
+ def list_branches(self, repo_name: str) -> List[str]:
96
+ try:
97
+ repo = self._github.get_repo(repo_name)
98
+ return [branch.name for branch in repo.get_branches()]
99
+ except GithubException as e:
100
+ return f"Error listing branches: {e}"
101
+
102
+ def get_branch(self, repo_name: str, branch_name: str) -> str:
103
+ try:
104
+ repo = self._github.get_repo(repo_name)
105
+ branch = repo.get_branch(branch_name)
106
+ return f"Branch {branch.name}: {branch.commit.sha}"
107
+ except GithubException as e:
108
+ return f"Error retrieving branch: {e}"
@@ -0,0 +1,141 @@
1
+ from github import Github, GithubException
2
+ from typing import List, Dict, Literal, Any
3
+ from swarmauri_core.ComponentBase import ComponentBase
4
+ from pydantic import Field, ConfigDict
5
+ from swarmauri_base.tools.ToolBase import ToolBase
6
+ from swarmauri_standard.tools.Parameter import Parameter
7
+
8
+
9
+ @ComponentBase.register_type(ToolBase, "GithubCommitTool")
10
+ class GithubCommitTool(ToolBase):
11
+ version: str = "1.1.0"
12
+ parameters: List[Parameter] = Field(
13
+ default_factory=lambda: [
14
+ Parameter(
15
+ name="action",
16
+ type="string",
17
+ description="The action to perform on the GitHub API, e.g., 'create_repo', 'delete_repo', 'create_issue', etc.",
18
+ required=True,
19
+ ),
20
+ Parameter(
21
+ name="repo_name",
22
+ type="string",
23
+ description="The full name of the repository to interact with, e.g. 'owner/repository'.",
24
+ required=True,
25
+ ),
26
+ Parameter(
27
+ name="file_path",
28
+ type="string",
29
+ description="The path to the file in the repository, e.g. 'path/to/file.txt'.",
30
+ required=False,
31
+ ),
32
+ Parameter(
33
+ name="message",
34
+ type="string",
35
+ description=".",
36
+ required=False,
37
+ ),
38
+ Parameter(
39
+ name="content",
40
+ type="string",
41
+ description="The name of the branch to interact with.",
42
+ required=False,
43
+ ),
44
+ Parameter(
45
+ name="branch_name",
46
+ type="string",
47
+ description="The name of the branch to interact with.",
48
+ required=False,
49
+ ),
50
+ Parameter(
51
+ name="sha",
52
+ type="string",
53
+ description="The sha of the commit to interact with.",
54
+ required=False,
55
+ ),
56
+ Parameter(
57
+ name="base",
58
+ type="string",
59
+ description="The base of the commit to interact with.",
60
+ required=False,
61
+ ),
62
+ Parameter(
63
+ name="head",
64
+ type="string",
65
+ description="The head of the commit to interact with.",
66
+ required=False,
67
+ ),
68
+ ]
69
+ )
70
+ name: str = "GithubCommitTool"
71
+ description: str = (
72
+ "Interacts with GitHub repositories using PyGithub to submit commits."
73
+ )
74
+ type: Literal["GithubCommitTool"] = "GithubCommitTool"
75
+ token: str
76
+ model_config = ConfigDict(arbitrary_types_allowed=True)
77
+
78
+ def __call__(self, action: str, **kwargs) -> Dict[str, Any]:
79
+ """
80
+ Central method to call various GitHub API actions.
81
+
82
+ Args:
83
+ action (str): The action to perform.
84
+ **kwargs: Additional keyword arguments related to the action.
85
+
86
+ Returns:
87
+ Dict[str, Any]: The result of the action.
88
+ """
89
+ action_map = {
90
+ "create_commit": self.create_commit,
91
+ "list_commits": self.list_commits,
92
+ "get_commit": self.get_commit,
93
+ "compare_commits": self.compare_commits,
94
+ }
95
+
96
+ if action in action_map:
97
+ self._github = Github(self.token)
98
+ return {action: action_map[action](**kwargs)}
99
+
100
+ raise ValueError(f"Action '{action}' is not supported.")
101
+
102
+ # Commit Management Methods
103
+ def create_commit(
104
+ self,
105
+ repo_name: str,
106
+ file_path: str,
107
+ message: str,
108
+ content: str,
109
+ branch: str = "main",
110
+ ) -> str:
111
+ try:
112
+ repo = self._github.get_repo(repo_name)
113
+ repo.create_file(
114
+ path=file_path, message=message, content=content, branch=branch
115
+ )
116
+ return f"Commit created successfully at {file_path}."
117
+ except GithubException as e:
118
+ return f"Error creating commit: {e}"
119
+
120
+ def list_commits(self, repo_name: str) -> List[str]:
121
+ try:
122
+ repo = self._github.get_repo(repo_name)
123
+ return [commit.commit.message for commit in repo.get_commits()]
124
+ except GithubException as e:
125
+ return f"Error listing commits: {e}"
126
+
127
+ def get_commit(self, repo_name: str, sha: str) -> str:
128
+ try:
129
+ repo = self._github.get_repo(repo_name)
130
+ commit = repo.get_commit(sha=sha)
131
+ return f"Commit {commit.sha}: {commit.commit.message}"
132
+ except GithubException as e:
133
+ return f"Error retrieving commit: {e}"
134
+
135
+ def compare_commits(self, repo_name: str, base: str, head: str) -> str:
136
+ try:
137
+ repo = self._github.get_repo(repo_name)
138
+ comparison = repo.compare(base, head)
139
+ return f"Comparison from {base} to {head}:\n{comparison.diff_url}"
140
+ except GithubException as e:
141
+ return f"Error comparing commits: {e}"
@@ -0,0 +1,117 @@
1
+ from github import Github, GithubException
2
+ from typing import List, Dict, Literal, Any
3
+ from swarmauri_core.ComponentBase import ComponentBase
4
+ from pydantic import Field, ConfigDict
5
+ from swarmauri_base.tools.ToolBase import ToolBase
6
+ from swarmauri_standard.tools.Parameter import Parameter
7
+
8
+
9
+ @ComponentBase.register_type(ToolBase, "GithubIssueTool")
10
+ class GithubIssueTool(ToolBase):
11
+ version: str = "1.1.0"
12
+ parameters: List[Parameter] = Field(
13
+ default_factory=lambda: [
14
+ Parameter(
15
+ name="action",
16
+ type="string",
17
+ description="The action to perform on the GitHub API, e.g., 'create_issue', 'delete_issue', 'close_issue', 'list_issues', 'get_issue'",
18
+ required=True,
19
+ ),
20
+ Parameter(
21
+ name="repo_name",
22
+ type="string",
23
+ description="The full name of the repository to interact with, e.g. 'owner/repository'.",
24
+ required=False,
25
+ ),
26
+ Parameter(
27
+ name="title",
28
+ type="string",
29
+ description="Title of the issue to create",
30
+ required=False,
31
+ ),
32
+ Parameter(
33
+ name="body",
34
+ type="string",
35
+ description="Body of the issue to create",
36
+ required=False,
37
+ ),
38
+ Parameter(
39
+ name="issue_number",
40
+ type="integer",
41
+ description="The number of the issue to interact with.",
42
+ required=False,
43
+ ),
44
+ ]
45
+ )
46
+ name: str = "GithubIssueTool"
47
+ description: str = "Interacts with GitHub repositories using PyGithub."
48
+ type: Literal["GithubIssueTool"] = "GithubIssueTool"
49
+ token: str
50
+ model_config = ConfigDict(arbitrary_types_allowed=True)
51
+
52
+ def __call__(self, action: str, **kwargs) -> Dict[str, Any]:
53
+ """
54
+ Central method to call various GitHub API actions.
55
+
56
+ Args:
57
+ action (str): The action to perform.
58
+ **kwargs: Additional keyword arguments related to the action.
59
+
60
+ Returns:
61
+ Dict[str, Any]: The result of the action.
62
+ """
63
+ action_map = {
64
+ "create_issue": self.create_issue,
65
+ "close_issue": self.close_issue,
66
+ "update_issue": self.update_issue,
67
+ "list_issues": self.list_issues,
68
+ "get_issue": self.get_issue,
69
+ }
70
+
71
+ if action in action_map:
72
+ self._github = Github(self.token)
73
+ return {action: action_map[action](**kwargs)}
74
+
75
+ raise ValueError(f"Action '{action}' is not supported.")
76
+
77
+ # Issue Management Methods
78
+ def create_issue(self, repo_name: str, title: str, body: str = None) -> str:
79
+ try:
80
+ repo = self._github.get_repo(repo_name)
81
+ repo.create_issue(title=title, body=body)
82
+ return f"Issue '{title}' created successfully."
83
+ except GithubException as e:
84
+ return f"Error creating issue: {e}"
85
+
86
+ def close_issue(self, repo_name: str, issue_number: int) -> str:
87
+ try:
88
+ repo = self._github.get_repo(repo_name)
89
+ issue = repo.get_issue(number=issue_number)
90
+ issue.edit(state="closed")
91
+ return f"Issue '{issue_number}' closed successfully."
92
+ except GithubException as e:
93
+ return f"Error closing issue: {e}"
94
+
95
+ def update_issue(self, repo_name: str, issue_number: int, **kwargs) -> str:
96
+ try:
97
+ repo = self._github.get_repo(repo_name)
98
+ issue = repo.get_issue(number=issue_number)
99
+ issue.edit(**kwargs)
100
+ return f"Issue '{issue_number}' updated successfully."
101
+ except GithubException as e:
102
+ return f"Error updating issue: {e}"
103
+
104
+ def list_issues(self, repo_name: str) -> List[str]:
105
+ try:
106
+ repo = self._github.get_repo(repo_name)
107
+ return [issue.title for issue in repo.get_issues(state="open")]
108
+ except GithubException as e:
109
+ return f"Error listing issues: {e}"
110
+
111
+ def get_issue(self, repo_name: str, issue_number: int) -> str:
112
+ try:
113
+ repo = self._github.get_repo(repo_name)
114
+ issue = repo.get_issue(number=issue_number)
115
+ return f"Issue #{issue.number}: {issue.title}\n{issue.body}"
116
+ except GithubException as e:
117
+ return f"Error retrieving issue: {e}"
@@ -0,0 +1,131 @@
1
+ from github import Github, GithubException
2
+ from typing import List, Dict, Literal, Any
3
+ from pydantic import Field, ConfigDict
4
+ from swarmauri_core.ComponentBase import ComponentBase
5
+ from swarmauri_base.tools.ToolBase import ToolBase
6
+ from swarmauri_standard.tools.Parameter import Parameter
7
+
8
+
9
+ @ComponentBase.register_type(ToolBase, "GithubPRTool")
10
+ class GithubPRTool(ToolBase):
11
+ version: str = "1.1.0"
12
+ parameters: List[Parameter] = Field(
13
+ default_factory=lambda: [
14
+ Parameter(
15
+ name="action",
16
+ type="string",
17
+ description="The action to perform on the GitHub API, e.g., 'create_pull', 'merge_pull', 'close_pull', 'get_pull', 'list_pulls' etc.",
18
+ required=True,
19
+ ),
20
+ Parameter(
21
+ name="repo_name",
22
+ type="string",
23
+ description="The full name of the repository to interact with, e.g. 'owner/repository'.",
24
+ required=False,
25
+ ),
26
+ Parameter(
27
+ name="pull_number",
28
+ type="integer",
29
+ description="The number of the pull request to interact with.",
30
+ required=False,
31
+ ),
32
+ Parameter(
33
+ name="title",
34
+ type="string",
35
+ description="The title of the pull request to create.",
36
+ required=False,
37
+ ),
38
+ Parameter(
39
+ name="head",
40
+ type="string",
41
+ description="The head branch with your changes",
42
+ required=False,
43
+ ),
44
+ Parameter(
45
+ name="base",
46
+ type="string",
47
+ description="The base branch you're merging into, typically 'main' or 'master'",
48
+ required=False,
49
+ ),
50
+ Parameter(
51
+ name="body",
52
+ type="string",
53
+ description="The description of the pull request to create.",
54
+ required=False,
55
+ ),
56
+ ]
57
+ )
58
+ name: str = "GithubPRTool"
59
+ description: str = "Interacts with GitHub repositories using PyGithub."
60
+ type: Literal["GithubPRTool"] = "GithubPRTool"
61
+ token: str
62
+ model_config = ConfigDict(arbitrary_types_allowed=True)
63
+
64
+ def __call__(self, action: str, **kwargs) -> Dict[str, Any]:
65
+ """
66
+ Central method to call various GitHub API actions.
67
+
68
+ Args:
69
+ action (str): The action to perform.
70
+ **kwargs: Additional keyword arguments related to the action.
71
+
72
+ Returns:
73
+ Dict[str, Any]: The result of the action.
74
+ """
75
+ action_map = {
76
+ "create_pull": self.create_pull,
77
+ "merge_pull": self.merge_pull,
78
+ "close_pull": self.close_pull,
79
+ "list_pulls": self.list_pulls,
80
+ "get_pull": self.get_pull,
81
+ }
82
+
83
+ if action in action_map:
84
+ self._github = Github(self.token)
85
+ return {action: action_map[action](**kwargs)}
86
+
87
+ raise ValueError(f"Action '{action}' is not supported.")
88
+
89
+ # Pull Request Management Methods
90
+ def create_pull(
91
+ self, repo_name: str, title: str, head: str, base: str, body: str = None
92
+ ) -> str:
93
+ try:
94
+ repo = self._github.get_repo(repo_name)
95
+ repo.create_pull(title=title, body=body, head=head, base=base)
96
+ return f"Pull request '{title}' created successfully."
97
+ except GithubException as e:
98
+ return f"Error creating pull request: {e}"
99
+
100
+ def merge_pull(self, repo_name: str, pull_number: int) -> str:
101
+ try:
102
+ repo = self._github.get_repo(repo_name)
103
+ pull = repo.get_pull(number=pull_number)
104
+ pull.merge()
105
+ return f"Pull request '{pull_number}' merged successfully."
106
+ except GithubException as e:
107
+ return f"Error merging pull request: {e}"
108
+
109
+ def close_pull(self, repo_name: str, pull_number: int) -> str:
110
+ try:
111
+ repo = self._github.get_repo(repo_name)
112
+ pull = repo.get_pull(number=pull_number)
113
+ pull.edit(state="closed")
114
+ return f"Pull request '{pull_number}' closed successfully."
115
+ except GithubException as e:
116
+ return f"Error closing pull request: {e}"
117
+
118
+ def list_pulls(self, repo_name: str) -> List[str]:
119
+ try:
120
+ repo = self._github.get_repo(repo_name)
121
+ return [pr.title for pr in repo.get_pulls(state="open")]
122
+ except GithubException as e:
123
+ return f"Error listing pull requests: {e}"
124
+
125
+ def get_pull(self, repo_name: str, pull_number: int) -> str:
126
+ try:
127
+ repo = self._github.get_repo(repo_name)
128
+ pull = repo.get_pull(number=pull_number)
129
+ return f"Pull Request #{pull.number}: {pull.title}\n{pull.body}"
130
+ except GithubException as e:
131
+ return f"Error retrieving pull request: {e}"
@@ -0,0 +1,104 @@
1
+ from github import Github, GithubException
2
+ from typing import List, Dict, Literal, Any
3
+ from swarmauri_core.ComponentBase import ComponentBase
4
+ from pydantic import Field, ConfigDict
5
+ from swarmauri_base.tools.ToolBase import ToolBase
6
+ from swarmauri_standard.tools.Parameter import Parameter
7
+
8
+
9
+ @ComponentBase.register_type(ToolBase, "GithubRepoTool")
10
+ class GithubRepoTool(ToolBase):
11
+ version: str = "1.1.0"
12
+ parameters: List[Parameter] = Field(
13
+ default_factory=lambda: [
14
+ Parameter(
15
+ name="action",
16
+ type="string",
17
+ description="The action to perform on the GitHub API, e.g., 'create_repo', 'delete_repo', 'update_repo', and 'get_repo'",
18
+ required=True,
19
+ ),
20
+ Parameter(
21
+ name="repo_name",
22
+ type="string",
23
+ description="The full name of the repository to interact with, e.g. 'owner/repository'.",
24
+ required=False,
25
+ ),
26
+ Parameter(
27
+ name="file_path",
28
+ type="string",
29
+ description="The path to the file in the repository, e.g. 'path/to/file.txt'.",
30
+ required=False,
31
+ ),
32
+ ]
33
+ )
34
+ name: str = "GithubRepoTool"
35
+ description: str = "Interacts with GitHub repositories using PyGithub."
36
+ type: Literal["GithubRepoTool"] = "GithubRepoTool"
37
+ token: str
38
+ model_config = ConfigDict(arbitrary_types_allowed=True)
39
+
40
+ def __call__(self, action: str, **kwargs) -> Dict[str, Any]:
41
+ """
42
+ Central method to call various GitHub API actions.
43
+
44
+ Args:
45
+ action (str): The action to perform.
46
+ **kwargs: Additional keyword arguments related to the action.
47
+
48
+ Returns:
49
+ Dict[str, Any]: The result of the action.
50
+ """
51
+ action_map = {
52
+ "create_repo": self.create_repo,
53
+ "delete_repo": self.delete_repo,
54
+ "get_repo": self.get_repo,
55
+ "list_repos": self.list_repos,
56
+ "update_repo": self.update_repo,
57
+ }
58
+
59
+ if action in action_map:
60
+ self._github = Github(self.token)
61
+ return {action: action_map[action](**kwargs)}
62
+
63
+ raise ValueError(f"Action '{action}' is not supported.")
64
+
65
+ # Repository Management Methods
66
+ def create_repo(self, repo_name: str, private: bool = False) -> str:
67
+ try:
68
+ user = self._github.get_user()
69
+ user.create_repo(repo_name, private=private)
70
+ return f"Repository '{repo_name}' created successfully."
71
+ except GithubException as e:
72
+ return f"Error creating repository: {e}"
73
+
74
+ def delete_repo(self, repo_name: str) -> str:
75
+ try:
76
+ user = self._github.get_user()
77
+ repo = user.get_repo(repo_name)
78
+ repo.delete()
79
+ return f"Repository '{repo_name}' deleted successfully."
80
+ except GithubException as e:
81
+ return f"Error deleting repository: {e}"
82
+
83
+ def get_repo(self, repo_name: str) -> str:
84
+ try:
85
+ repo = self._github.get_repo(repo_name)
86
+ repo_info = f"Repository: {repo.full_name}\nDescription: {repo.description}\nClone URL: {repo.clone_url}"
87
+ return repo_info
88
+ except GithubException as e:
89
+ return f"Error retrieving repository info: {e}"
90
+
91
+ def list_repos(self) -> List[str]:
92
+ try:
93
+ user = self._github.get_user()
94
+ return [repo.full_name for repo in user.get_repos()]
95
+ except GithubException as e:
96
+ return f"Error listing repositories: {e}"
97
+
98
+ def update_repo(self, repo_name: str, **kwargs) -> str:
99
+ try:
100
+ repo = self._github.get_repo(repo_name)
101
+ repo.edit(**kwargs)
102
+ return f"Repository '{repo_name}' updated successfully."
103
+ except GithubException as e:
104
+ return f"Error updating repository: {e}"
@@ -0,0 +1,46 @@
1
+ from typing import Literal, Optional
2
+
3
+ from swarmauri_core.ComponentBase import ComponentBase
4
+
5
+ from swarmauri_base.toolkits.ToolkitBase import ToolkitBase
6
+ from swarmauri_toolkit_github.GithubRepoTool import GithubRepoTool
7
+ from swarmauri_toolkit_github.GithubIssueTool import GithubIssueTool
8
+ from swarmauri_toolkit_github.GithubPRTool import GithubPRTool
9
+ from swarmauri_toolkit_github.GithubBranchTool import GithubBranchTool
10
+ from swarmauri_toolkit_github.GithubCommitTool import GithubCommitTool
11
+
12
+ from dotenv import load_dotenv
13
+
14
+ load_dotenv()
15
+
16
+
17
+ @ComponentBase.register_type(ToolkitBase, "GithubToolkit")
18
+ class GithubToolkit(ToolkitBase):
19
+ type: Literal["GithubToolkit"] = "GithubToolkit"
20
+ api_token: str = None
21
+ # Explicitly define the tools as fields
22
+ github_repo_tool: Optional[GithubRepoTool] = None
23
+ github_issue_tool: Optional[GithubIssueTool] = None
24
+ github_pr_tool: Optional[GithubPRTool] = None
25
+ github_branch_tool: Optional[GithubBranchTool] = None
26
+ github_commit_tool: Optional[GithubCommitTool] = None
27
+
28
+ def __init__(self, api_token: str, **kwargs):
29
+ super().__init__(**kwargs)
30
+
31
+ if not api_token:
32
+ raise ValueError("Invalid Token or Missing token")
33
+
34
+ self.api_token = api_token
35
+
36
+ self.github_repo_tool = GithubRepoTool(token=self.api_token)
37
+ self.github_issue_tool = GithubIssueTool(token=self.api_token)
38
+ self.github_pr_tool = GithubPRTool(token=self.token)
39
+ self.github_branch_tool = GithubBranchTool(token=self.api_token)
40
+ self.github_commit_tool = GithubCommitTool(token=self.api_token)
41
+
42
+ self.add_tool(self.github_repo_tool)
43
+ self.add_tool(self.github_issue_tool)
44
+ self.add_tool(self.github_pr_tool)
45
+ self.add_tool(self.github_commit_tool)
46
+ self.add_tool(self.github_branch_tool)
@@ -0,0 +1,29 @@
1
+ from .GithubBranchTool import GithubBranchTool
2
+ from .GithubCommitTool import GithubCommitTool
3
+ from .GithubIssueTool import GithubIssueTool
4
+ from .GithubPRTool import GithubPRTool
5
+ from .GithubRepoTool import GithubRepoTool
6
+ from .GithubToolkit import GithubToolkit
7
+
8
+
9
+ __all__ = [
10
+ "GithubBranchTool",
11
+ "GithubCommitTool",
12
+ "GithubIssueTool",
13
+ "GithubPRTool",
14
+ "GithubRepoTool",
15
+ "GithubToolkit",
16
+ ]
17
+
18
+ try:
19
+ # For Python 3.8 and newer
20
+ from importlib.metadata import version, PackageNotFoundError
21
+ except ImportError:
22
+ # For older Python versions, use the backport
23
+ from importlib_metadata import version, PackageNotFoundError
24
+
25
+ try:
26
+ __version__ = version("swarmauri_toolkit_github")
27
+ except PackageNotFoundError:
28
+ # If the package is not installed (for example, during development)
29
+ __version__ = "0.0.0"