jira2py 0.1.0__tar.gz

jira2py-0.1.0/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024 Enver
+
+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.

jira2py-0.1.0/PKG-INFO

@@ -0,0 +1,28 @@
+Metadata-Version: 2.1
+Name: jira2py
+Version: 0.1.0
+Summary: The Python library to interact with Atlassian Jira REST API
+Home-page: https://github.com/en-ver/jira2py
+Author: nEver1
+Author-email: 7fhhwpuuo@mozmail.com
+Classifier: Programming Language :: Python :: 3
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: OS Independent
+Requires-Python: >3.10
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: python-dotenv>=1.0.0
+Requires-Dist: requests>=2.0.0
+
+# jira2py
+
+**jira2py** is a Python package designed for seamless integration with JIRA API. It provides an intuitive and modular approach to managing issues, searching for data, handling fields, and interacting with JIRA. The package is built on top of the official Jira API and simply wraps the API calls into a Pythonic interface.
+
+---
+
+## Features
+
+- **Issue Management**: Retrieve and update JIRA issue data.
+- **JIRA Query Language (JQL) Support**: Search for issues using powerful JQL expressions.
+- **Field Management**: Fetch metadata about JIRA fields and map between field names and IDs.
+- **Changelog Retrieval**: Retrieve the history of changes for specific issues.

jira2py-0.1.0/README.md

@@ -0,0 +1,12 @@
+# jira2py
+
+**jira2py** is a Python package designed for seamless integration with JIRA API. It provides an intuitive and modular approach to managing issues, searching for data, handling fields, and interacting with JIRA. The package is built on top of the official Jira API and simply wraps the API calls into a Pythonic interface.
+
+---
+
+## Features
+
+- **Issue Management**: Retrieve and update JIRA issue data.
+- **JIRA Query Language (JQL) Support**: Search for issues using powerful JQL expressions.
+- **Field Management**: Fetch metadata about JIRA fields and map between field names and IDs.
+- **Changelog Retrieval**: Retrieve the history of changes for specific issues.

jira2py-0.1.0/jira2py/__init__.py

@@ -0,0 +1 @@
+from .jira import Jira

jira2py-0.1.0/jira2py/fields.py

@@ -0,0 +1,10 @@
+from .jirabase import JiraBase
+
+
+class Fields(JiraBase):
+
+    def get(self) -> list[dict]:
+
+        kwargs = {"method": "GET", "context_path": "field"}
+
+        return self._request_jira(**kwargs)

jira2py-0.1.0/jira2py/issue.py

@@ -0,0 +1,53 @@
+from .jirabase import JiraBase
+
+
+class Issue(JiraBase):
+
+    def get(
+        self,
+        key: str,
+        fields: str = "*all",
+        expand: str = "names",
+    ):
+
+        kwargs = {
+            "method": "GET",
+            "context_path": f"issue/{key}",
+            "params": {"expand": expand, "fields": fields},
+        }
+
+        issue = self._request_jira(**kwargs)
+        return issue
+
+    def get_changelogs(self, key: str, start_at: int = 0, max_results: int = 100):
+
+        kwargs = {
+            "method": "GET",
+            "context_path": f"issue/{key}/changelog",
+            "params": {"startAt": start_at, "maxResults": max_results},
+        }
+
+        changelogs = self._request_jira(**kwargs)
+        return changelogs
+
+    def edit(
+        self,
+        key: str,
+        fields: dict,
+        return_issue: bool = True,
+        notify_users: bool = False,
+        expand: str = "names",
+    ):
+
+        kwargs = {
+            "method": "PUT",
+            "context_path": f"issue/{key}",
+            "params": {
+                "notifyUsers": notify_users,
+                "returnIssue": return_issue,
+                "expand": expand,
+            },
+            "data": {"fields": fields},
+        }
+        response = self._request_jira(**kwargs)
+        return response

jira2py-0.1.0/jira2py/jira.py

@@ -0,0 +1,34 @@
+from requests.auth import HTTPBasicAuth
+import json, os
+from decimal import Decimal
+
+
+class Jira:
+
+    def __init__(self, url: str, user: str, api_token: str):
+
+        os.environ["_JIRA_URL"] = url
+        os.environ["_JIRA_USER"] = user
+        os.environ["_JIRA_API_TOKEN"] = api_token
+
+    def search(self):
+        from .search import Search
+
+        return Search()
+
+    def issue(self):
+        from .issue import Issue
+
+        return Issue()
+
+    def fields(self):
+        from .fields import Fields
+
+        return Fields()
+
+
+class DecimalEncoder(json.JSONEncoder):
+    def default(self, obj):
+        if isinstance(obj, Decimal):
+            return float(obj)
+        return super().default(obj)

jira2py-0.1.0/jira2py/jirabase.py

@@ -0,0 +1,42 @@
+from requests.auth import HTTPBasicAuth
+import json, os, requests
+from decimal import Decimal
+from abc import ABC
+
+
+class DecimalEncoder(json.JSONEncoder):
+    def default(self, obj):
+        if isinstance(obj, Decimal):
+            return float(obj)
+        return super().default(obj)
+
+
+class JiraBase(ABC):
+
+    def _request_jira(
+        self,
+        method: str,
+        context_path: str,
+        params: dict | None = None,
+        data: dict | None = None,
+    ) -> any:
+
+        jira_url = os.getenv("_JIRA_URL", None)
+        jira_user = os.getenv("_JIRA_USER", None)
+        jira_api_token = os.getenv("_JIRA_API_TOKEN", None)
+
+        try:
+            response = requests.request(
+                method=method,
+                url=f'{jira_url}/rest/api/3/{context_path.strip("/")}',
+                params=params,
+                data=json.dumps(data, cls=DecimalEncoder) if data else None,
+                headers={
+                    "Accept": "application/json",
+                    "Content-Type": "application/json",
+                },
+                auth=HTTPBasicAuth(jira_user, jira_api_token),
+            )
+            return response.json()
+        except Exception as e:
+            raise e

jira2py-0.1.0/jira2py/search.py

@@ -0,0 +1,27 @@
+from .jirabase import JiraBase
+
+
+class Search(JiraBase):
+
+    def jql(
+        self,
+        jql: str,
+        fields: list[str] | None = None,
+        max_results: int | None = 50,
+        next_page_token: str | None = None,
+        expand: str | None = None,
+    ) -> dict:
+
+        kwargs = {
+            "method": "POST",
+            "context_path": "search/jql",
+            "data": {
+                "jql": jql,
+                "nextPageToken": next_page_token,
+                "fields": fields,
+                "expand": expand,
+                "maxResults": max_results,
+            },
+        }
+
+        return self._request_jira(**kwargs)

jira2py-0.1.0/jira2py.egg-info/PKG-INFO

@@ -0,0 +1,28 @@
+Metadata-Version: 2.1
+Name: jira2py
+Version: 0.1.0
+Summary: The Python library to interact with Atlassian Jira REST API
+Home-page: https://github.com/en-ver/jira2py
+Author: nEver1
+Author-email: 7fhhwpuuo@mozmail.com
+Classifier: Programming Language :: Python :: 3
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: OS Independent
+Requires-Python: >3.10
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: python-dotenv>=1.0.0
+Requires-Dist: requests>=2.0.0
+
+# jira2py
+
+**jira2py** is a Python package designed for seamless integration with JIRA API. It provides an intuitive and modular approach to managing issues, searching for data, handling fields, and interacting with JIRA. The package is built on top of the official Jira API and simply wraps the API calls into a Pythonic interface.
+
+---
+
+## Features
+
+- **Issue Management**: Retrieve and update JIRA issue data.
+- **JIRA Query Language (JQL) Support**: Search for issues using powerful JQL expressions.
+- **Field Management**: Fetch metadata about JIRA fields and map between field names and IDs.
+- **Changelog Retrieval**: Retrieve the history of changes for specific issues.

jira2py-0.1.0/jira2py.egg-info/SOURCES.txt

@@ -0,0 +1,15 @@
+LICENSE
+README.md
+pyproject.toml
+setup.py
+jira2py/__init__.py
+jira2py/fields.py
+jira2py/issue.py
+jira2py/jira.py
+jira2py/jirabase.py
+jira2py/search.py
+jira2py.egg-info/PKG-INFO
+jira2py.egg-info/SOURCES.txt
+jira2py.egg-info/dependency_links.txt
+jira2py.egg-info/requires.txt
+jira2py.egg-info/top_level.txt

jira2py-0.1.0/jira2py.egg-info/dependency_links.txt

@@ -0,0 +1 @@
+

jira2py-0.1.0/jira2py.egg-info/requires.txt

@@ -0,0 +1,2 @@
+python-dotenv>=1.0.0
+requests>=2.0.0

jira2py-0.1.0/jira2py.egg-info/top_level.txt

@@ -0,0 +1 @@
+jira2py

jira2py-0.1.0/pyproject.toml

@@ -0,0 +1,3 @@
+[build-system]
+requires = ["setuptools>=42", "wheel"]
+build-backend = "setuptools.build_meta"

jira2py-0.1.0/setup.cfg

@@ -0,0 +1,4 @@
+[egg_info]
+tag_build = 
+tag_date = 0
+

jira2py-0.1.0/setup.py

@@ -0,0 +1,20 @@
+from setuptools import setup, find_packages
+
+setup(
+    name="jira2py",
+    version="0.1.0",
+    author="nEver1",
+    author_email="7fhhwpuuo@mozmail.com",
+    description="The Python library to interact with Atlassian Jira REST API",
+    long_description=open("README.md").read(),
+    long_description_content_type="text/markdown",
+    url="https://github.com/en-ver/jira2py",
+    packages=find_packages(),
+    install_requires=["python-dotenv>=1.0.0", "requests>=2.0.0"],
+    classifiers=[
+        "Programming Language :: Python :: 3",
+        "License :: OSI Approved :: MIT License",
+        "Operating System :: OS Independent",
+    ],
+    python_requires=">3.10",
+)