GitLabPy 0.6.1__tar.gz → 0.7.0__tar.gz

gitlabpy-0.7.0/.gitignore

@@ -0,0 +1,12 @@
+dist/*
+GitLabPy.egg-info/*
+.pypirc
+.env
+__pycache__/*
+server-output/*
+build/*
+build/lib/GitLabPy.py
+.venv/
+.pytest_cache/
+*.egg-info/
+__pycache__/

{GitLabPy-0.6.1 → gitlabpy-0.7.0}/GitLabPy.py

@@ -1,121 +1,125 @@
-import json
-
-class GitLab:
-    """
-    Instantiate with 1 argument, parsed json string <string>
-    """
-    def __init__(self, arg1):
-        self.json_data = arg1
-
-        # Types of build and issue JSON from GitLab Webhook
-        self.issue_types = ["open", "update", "closed"]
-
-        # Below is for common JSON objects
-        self.object_kind = arg1.get("object_kind", "")
-        self.project_id = arg1.get("project_id", "")
-        self.ref = arg1.get("ref", "")
-        self.project_name = arg1.get("project_name", "")
-        self.user = arg1.get("user", "")
-        self.commit = arg1.get("commit", "")
-        self.object_attributes = arg1.get("object_attributes", "")
-        self.build_status = arg1.get("build_status", "")
-
-        repo_obj = arg1.get("repository", "")
-        if repo_obj != "":
-            self.repository = repo_obj
-            self.repo_name = repo_obj.get("name", "")
-            self.repo_homepage = repo_obj.get("homepage", "")
-
-    def check_repository_atttr(self):
-        if self.repository == "":
-            return False
-        else:
-            return True
-
-    def get_url(self, url=None):
-        """
-        Arguments:
-            - url : type of url to return <string>
-                * input types:
-                    - "http" : retrieve git http url
-                    - "ssh" : retrieve git ssh url
-                    - "homepage" : retrieve homepage url
-                    - (no input) : retrieve default git url, which is: "repository": {"url": <url>}
-        """
-        if check_repository_atttr():
-            return False
-        if url.lower() == "ssh":
-            return self.repository.get("git_ssh_url")
-        elif url.lower() == "http":
-            return self.repository.get("git_http_url")
-        elif url.lower() == "homepage":
-            return self.repository.get("homepage")
-        else:
-            return self.repository.get("url")
-
-    def get_repo_description(self):
-        """
-        Arguments: None
-        Checks to see if the key 'description' is in the webhook
-        """
-        if check_repository_atttr():
-            return self.repository.get("description")
-        else:
-            return False
-
-    def build(self, *args):
-        """
-        Checks to see if JSON data from GitLab is build data and also checks to see that you want build data. If so, return True
-        Arguments: *args <bool><string><list>
-            - can be a list of certain build data  you want
-            - build types are 'success', 'failed', 'runnning'
-        """
-        if self.object_kind == "build" and self.build_status in args:
-            return True
-        else:
-            return False
-
-    def note(self, note_types=False):
-        """
-        Checks to see if JSON data is a note (comment) and you want note JSON data. If so, return True
-        Arguments: note_types <bool>
-            - Returns True if you want note type JSON data to return True and JSON data is a note
-            - Default - False
-        """
-        if note_types and self.object_kind == "note":
-            return True
-        else:
-            return False
-
-    def merge_request(self, merge_request_types=False):
-        """
-        Checks to see if JSON data is a merge request and if you want merge_request data. If so, return True
-        Arguments: merge_request_types <bool>
-            - True if you want merge request data from GitLab to be returned if JSON data is merge request.
-            - Default - False
-        """
-        if merge_request_types and self.object_kind == "merge_request":
-            return True
-        else:
-            return False
-
-    def issue(self, *args):
-        """
-        Checks to see if JSON data is an issue from GitLabJSON
-        Arguments: *args <bool><string><list>
-            - can be list of issue types or boolean
-            - issue types are 'open', 'update', 'closed'
-            - True if you want all issues pass this conditional function
-        """
-        if self.object_kind != "issue":
-            return False
-
-        if "open" in args or "closed" in args:
-            if self.object_attributes.get("state") == "closed" and "closed" in args:
-                return True
-            elif self.object_attributes.get("action") == "open" and "open" in args:
-                return True
-        elif "update" in args and self.object_attributes.get("action") == "update":
-            return True
-        else:
-            return False
+import json
+
+class GitLab:
+    """
+    Instantiate with 1 argument, parsed json string <string>
+    """
+    def __init__(self, arg1):
+        self.json_data = arg1
+
+        # Types of build and issue JSON from GitLab Webhook
+        self.issue_types = ["open", "update", "closed"]
+
+        # Below is for common JSON objects
+        self.object_kind = arg1.get("object_kind", "")
+        self.project_id = arg1.get("project_id", "")
+        self.ref = arg1.get("ref", "")
+        self.project_name = arg1.get("project_name", "")
+        self.user = arg1.get("user", "")
+        self.commit = arg1.get("commit", "")
+        self.object_attributes = arg1.get("object_attributes", "")
+        self.build_status = arg1.get("build_status", "")
+
+        self.repository = ""
+        self.repo_name = ""
+        self.repo_homepage = ""
+
+        repo_obj = arg1.get("repository", "")
+        if repo_obj != "":
+            self.repository = repo_obj
+            self.repo_name = repo_obj.get("name", "")
+            self.repo_homepage = repo_obj.get("homepage", "")
+
+    def check_repository_atttr(self):
+        if self.repository == "":
+            return False
+        else:
+            return True
+
+    def get_url(self, url=None):
+        """
+        Arguments:
+            - url : type of url to return <string>
+                * input types:
+                    - "http" : retrieve git http url
+                    - "ssh" : retrieve git ssh url
+                    - "homepage" : retrieve homepage url
+                    - (no input) : retrieve default git url, which is: "repository": {"url": <url>}
+        """
+        if not self.check_repository_atttr():
+            return False
+        if url is None:
+            return self.repository.get("url")
+        if url.lower() == "ssh":
+            return self.repository.get("git_ssh_url")
+        elif url.lower() == "http":
+            return self.repository.get("git_http_url")
+        elif url.lower() == "homepage":
+            return self.repository.get("homepage")
+        else:
+            return self.repository.get("url")
+
+    def get_repo_description(self):
+        """
+        Arguments: None
+        Checks to see if the key 'description' is in the webhook
+        """
+        if self.check_repository_atttr():
+            return self.repository.get("description")
+        else:
+            return False
+
+    def build(self, *args):
+        """
+        Checks to see if JSON data from GitLab is build data and also checks to see that you want build data. If so, return True
+        Arguments: *args <bool><string><list>
+            - can be a list of certain build data  you want
+            - build types are 'success', 'failed', 'runnning'
+        """
+        if self.object_kind == "build" and self.build_status in args:
+            return True
+        else:
+            return False
+
+    def note(self, note_types=False):
+        """
+        Checks to see if JSON data is a note (comment) and you want note JSON data. If so, return True
+        Arguments: note_types <bool>
+            - Returns True if you want note type JSON data to return True and JSON data is a note
+            - Default - False
+        """
+        if note_types and self.object_kind == "note":
+            return True
+        else:
+            return False
+
+    def merge_request(self, merge_request_types=False):
+        """
+        Checks to see if JSON data is a merge request and if you want merge_request data. If so, return True
+        Arguments: merge_request_types <bool>
+            - True if you want merge request data from GitLab to be returned if JSON data is merge request.
+            - Default - False
+        """
+        if merge_request_types and self.object_kind == "merge_request":
+            return True
+        else:
+            return False
+
+    def issue(self, *args):
+        """
+        Checks to see if JSON data is an issue from GitLabJSON
+        Arguments: *args <bool><string><list>
+            - can be list of issue types or boolean
+            - issue types are 'open', 'update', 'closed'
+            - True if you want all issues pass this conditional function
+        """
+        if self.object_kind != "issue":
+            return False
+
+        if "closed" in args and self.object_attributes.get("state") == "closed":
+            return True
+        if "open" in args and self.object_attributes.get("action") == "open":
+            return True
+        if "update" in args and self.object_attributes.get("action") == "update":
+            return True
+        return False

gitlabpy-0.7.0/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2016 Dixon Begay
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+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.

gitlabpy-0.7.0/PKG-INFO

@@ -0,0 +1,61 @@
+Metadata-Version: 2.5
+Name: GitLabPy
+Version: 0.7.0
+Summary: A Python module to sort GitLab's Webhooks
+Project-URL: Homepage, https://github.com/dixonbegay/GitLabPy
+Project-URL: Issues, https://github.com/dixonbegay/GitLabPy/issues
+Author-email: Dixon Begay <dixon@dixon-labs.net>
+Maintainer-email: Dixon Begay <dixon@dixon-labs.net>
+License-Expression: MIT
+License-File: LICENSE
+Keywords: gitlabpy
+Classifier: Intended Audience :: Developers
+Classifier: Programming Language :: Python :: 3
+Classifier: Topic :: Software Development
+Requires-Python: >=3.10
+Description-Content-Type: text/markdown
+
+# GitLabPy
+A Python module to help sort GitLab's Webhooks
+
+Some of the JSON data coming from GitLab's webhooks are set as attributes to the GitLab class. There are functions within the GitLab class that allow for easy handling of the JSON data.
+
+## Requirements
+* Python >= 3.10
+
+## Install
+* `pip install GitLabPy`
+
+## How to use
+Check out the [wiki](https://github.com/shadez95/GitLabPy/wiki) for information.
+
+### Example
+An example of how to utilize this can be found [here](https://github.com/shadez95/GitLabPy/tree/master/examples/Django-App)
+
+## Development
+This project uses [uv](https://docs.astral.sh/uv/) for dependency management, building, and publishing.
+
+```bash
+# Install dependencies (including dev dependencies)
+uv sync
+
+# Run the test suite
+uv run pytest
+
+# Build the sdist and wheel
+uv build
+```
+
+## Releasing
+Releases are published manually from a local machine (no CI publish step).
+
+```bash
+# 1. Bump the version in pyproject.toml, then build
+uv build
+
+# 2. Publish to PyPI
+uv publish
+
+# 3. Create the GitHub release (tags and publishes the release)
+gh release create vX.Y.Z --generate-notes
+```

gitlabpy-0.7.0/README.md

@@ -0,0 +1,44 @@
+# GitLabPy
+A Python module to help sort GitLab's Webhooks
+
+Some of the JSON data coming from GitLab's webhooks are set as attributes to the GitLab class. There are functions within the GitLab class that allow for easy handling of the JSON data.
+
+## Requirements
+* Python >= 3.10
+
+## Install
+* `pip install GitLabPy`
+
+## How to use
+Check out the [wiki](https://github.com/shadez95/GitLabPy/wiki) for information.
+
+### Example
+An example of how to utilize this can be found [here](https://github.com/shadez95/GitLabPy/tree/master/examples/Django-App)
+
+## Development
+This project uses [uv](https://docs.astral.sh/uv/) for dependency management, building, and publishing.
+
+```bash
+# Install dependencies (including dev dependencies)
+uv sync
+
+# Run the test suite
+uv run pytest
+
+# Build the sdist and wheel
+uv build
+```
+
+## Releasing
+Releases are published manually from a local machine (no CI publish step).
+
+```bash
+# 1. Bump the version in pyproject.toml, then build
+uv build
+
+# 2. Publish to PyPI
+uv publish
+
+# 3. Create the GitHub release (tags and publishes the release)
+gh release create vX.Y.Z --generate-notes
+```

gitlabpy-0.7.0/examples/Django-App/README.md

@@ -0,0 +1,3 @@
+This Django app example shows that you can retrieve a GitLab webhook post request, filter out which data is passed, and post to a discord-app channel through discord's webhooks.
+
+`discord\views.py` contains the example.

gitlabpy-0.7.0/pyproject.toml

@@ -0,0 +1,42 @@
+[build-system]
+requires = ["hatchling"]
+build-backend = "hatchling.build"
+
+[project]
+name = "GitLabPy"
+version = "0.7.0"
+description = "A Python module to sort GitLab's Webhooks"
+readme = "README.md"
+license = "MIT"
+requires-python = ">=3.10"
+authors = [
+    { name = "Dixon Begay", email = "dixon@dixon-labs.net" },
+]
+maintainers = [
+    { name = "Dixon Begay", email = "dixon@dixon-labs.net" },
+]
+keywords = ["gitlabpy"]
+classifiers = [
+    "Intended Audience :: Developers",
+    "Topic :: Software Development",
+    "Programming Language :: Python :: 3",
+]
+dependencies = []
+
+[project.urls]
+Homepage = "https://github.com/dixonbegay/GitLabPy"
+Issues = "https://github.com/dixonbegay/GitLabPy/issues"
+
+[dependency-groups]
+dev = [
+    "pytest>=9.0.3",
+]
+
+[tool.hatch.build.targets.wheel]
+include = ["GitLabPy.py"]
+
+[tool.hatch.build.targets.sdist]
+include = ["GitLabPy.py", "README.md", "LICENSE"]
+
+[tool.pytest.ini_options]
+testpaths = ["tests"]

GitLabPy-0.6.1/GitLabPy.egg-info/PKG-INFO

@@ -1,34 +0,0 @@
-Metadata-Version: 2.1
-Name: GitLabPy
-Version: 0.6.1
-Summary: A Python module to sort GitLab's Webhooks
-Home-page: https://github.com/shadez95/GitLabPy
-Author: Dixon Begay
-Author-email: dixonbegay@gmail.com
-Maintainer: Dixon Begay
-License: MIT
-Description: # GitLabPy
-        A Python module to help sort GitLab's Webhooks
-        
-        Some of the JSON data coming from GitLab's webhooks are set as attributes to the GitLab class. There are functions within the GitLab class that allow for easy handling of the JSON data.
-        
-        ## Requirements
-        * Python3 (has only been tested with Python 3.5.2)
-        
-        
-        ## Install
-        * `pip install GitLabPy`
-        
-        ## How to use
-        Check out the [wiki](https://github.com/shadez95/GitLabPy/wiki) for information.
-        
-        ### Example
-        An example of how to utilize this can be found [here](https://github.com/shadez95/GitLabPy/tree/master/examples/Django-App)
-        
-Keywords: gitlabpy
-Platform: UNKNOWN
-Classifier: Development Status :: 3 - Alpha
-Classifier: Intended Audience :: Developers
-Classifier: Topic :: Software Development
-Classifier: Programming Language :: Python :: 3.5
-Description-Content-Type: text/markdown

GitLabPy-0.6.1/GitLabPy.egg-info/SOURCES.txt

@@ -1,8 +0,0 @@
-GitLabPy.py
-README.md
-setup.cfg
-setup.py
-GitLabPy.egg-info/PKG-INFO
-GitLabPy.egg-info/SOURCES.txt
-GitLabPy.egg-info/dependency_links.txt
-GitLabPy.egg-info/top_level.txt

GitLabPy-0.6.1/GitLabPy.egg-info/dependency_links.txt

@@ -1 +0,0 @@
-

GitLabPy-0.6.1/GitLabPy.egg-info/top_level.txt

@@ -1 +0,0 @@
-GitLabPy

GitLabPy-0.6.1/PKG-INFO

@@ -1,34 +0,0 @@
-Metadata-Version: 2.1
-Name: GitLabPy
-Version: 0.6.1
-Summary: A Python module to sort GitLab's Webhooks
-Home-page: https://github.com/shadez95/GitLabPy
-Author: Dixon Begay
-Author-email: dixonbegay@gmail.com
-Maintainer: Dixon Begay
-License: MIT
-Description: # GitLabPy
-        A Python module to help sort GitLab's Webhooks
-        
-        Some of the JSON data coming from GitLab's webhooks are set as attributes to the GitLab class. There are functions within the GitLab class that allow for easy handling of the JSON data.
-        
-        ## Requirements
-        * Python3 (has only been tested with Python 3.5.2)
-        
-        
-        ## Install
-        * `pip install GitLabPy`
-        
-        ## How to use
-        Check out the [wiki](https://github.com/shadez95/GitLabPy/wiki) for information.
-        
-        ### Example
-        An example of how to utilize this can be found [here](https://github.com/shadez95/GitLabPy/tree/master/examples/Django-App)
-        
-Keywords: gitlabpy
-Platform: UNKNOWN
-Classifier: Development Status :: 3 - Alpha
-Classifier: Intended Audience :: Developers
-Classifier: Topic :: Software Development
-Classifier: Programming Language :: Python :: 3.5
-Description-Content-Type: text/markdown

GitLabPy-0.6.1/README.md

@@ -1,17 +0,0 @@
-# GitLabPy
-A Python module to help sort GitLab's Webhooks
-
-Some of the JSON data coming from GitLab's webhooks are set as attributes to the GitLab class. There are functions within the GitLab class that allow for easy handling of the JSON data.
-
-## Requirements
-* Python3 (has only been tested with Python 3.5.2)
-
-
-## Install
-* `pip install GitLabPy`
-
-## How to use
-Check out the [wiki](https://github.com/shadez95/GitLabPy/wiki) for information.
-
-### Example
-An example of how to utilize this can be found [here](https://github.com/shadez95/GitLabPy/tree/master/examples/Django-App)

GitLabPy-0.6.1/setup.cfg

@@ -1,10 +0,0 @@
-[bdist_wheel]
-universal = 0
-
-[metadata]
-description-file = README.md
-
-[egg_info]
-tag_build = 
-tag_date = 0
-

GitLabPy-0.6.1/setup.py

@@ -1,28 +0,0 @@
-from setuptools import setup, find_packages
-from os import path
-
-# Get the long description from the README file
-with open(path.join(path.dirname(__file__), 'README.md'), encoding='utf-8') as f:
-    long_description = f.read()
-
-setup(
-    name='GitLabPy',
-    version='0.6.1',
-    py_modules=['GitLabPy'],
-    description="A Python module to sort GitLab's Webhooks",
-    long_description=long_description,
-    long_description_content_type="text/markdown",
-    author='Dixon Begay',
-    author_email='dixonbegay@gmail.com',
-    maintainer='Dixon Begay',
-    url='https://github.com/shadez95/GitLabPy',
-    classifiers=[
-        'Development Status :: 3 - Alpha',
-        'Intended Audience :: Developers',
-        'Topic :: Software Development',
-        'Programming Language :: Python :: 3.5'
-    ],
-    license='MIT',
-    keywords='gitlabpy',
-    install_requires=[]
-)