python-backlog 0.6.0__tar.gz → 0.7.2__tar.gz

python_backlog-0.7.2/MANIFEST.in

@@ -0,0 +1,3 @@
+include VERSION
+include requirements.txt
+include requirements-dev.txt

python_backlog-0.7.2/PKG-INFO

@@ -0,0 +1,89 @@
+Metadata-Version: 2.1
+Name: python-backlog
+Version: 0.7.2
+Summary: Backlog API v2 wrapper
+Home-page: https://github.com/hassaku63/pbl
+Author: hassaku63
+Author-email: hassaku63@gmail.com
+License: MIT
+Project-URL: Source, https://github.com/hassaku63/pbl
+Keywords: nulab backlog
+Classifier: Development Status :: 4 - Beta
+Classifier: Programming Language :: Python
+Classifier: Programming Language :: Python :: 3.8
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Natural Language :: Japanese
+Requires-Python: >=3.8
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: requests~=2.32.2
+
+# pbl
+
+A Python package wraps Backlog API V2
+
+## Usage
+
+Install
+
+```bash
+pip install python-backlog
+```
+
+Code snippet
+
+```python
+import base64
+import json
+from backlog.base import BacklogAPI
+
+
+def main():
+    """
+    Initialize API Object
+    """
+    api = BacklogAPI("your-space", "your-api-key")
+
+    """
+    Project API
+    """
+    # list project users
+    # https://developer.nulab-inc.com/ja/docs/backlog/api/2/get-project-list/
+    print("# list project users")
+    users = api.project.list_users("SampleProject")
+    print(json.dumps(users, indent=2))
+
+
+    """
+    Wiki API
+    """
+    # list wikis
+    # https://developer.nulab-inc.com/ja/docs/backlog/api/2/get-wiki-page-list/
+    print("# list wikis")
+    wikis = api.wiki.list("SampleProject")
+    print(json.dumps(wikis[0], indent=2))
+
+    # get attachment
+    # https://developer.nulab-inc.com/ja/docs/backlog/api/2/get-issue-attachment/
+    print("# get attachment")
+    wiki = [w for w in api.wiki.list("SampleProject") if len(w["attachments"]) > 0][0]
+    attachment = api.wiki.get_attachment(
+        wikiId=wiki["id"],
+        attachmentId=wiki["attachments"][0]["id"])
+    attachment["data"] = base64.b64encode(attachment["data"]).decode()
+    print(json.dumps(attachment, indent=2))
+
+
+if __name__ == "__main__":
+    main()
+```
+
+## See also
+
+Qiita https://qiita.com/hassaku_63/items/b9eb2a1c7ecd3c19507d
+
+## Contact
+
+Twitter: [hassaku_63](https://twitter.com/hassaku_63)

python_backlog-0.7.2/VERSION

@@ -0,0 +1 @@
+0.7.2

{python-backlog-0.6.0 → python_backlog-0.7.2}/backlog/base.py

@@ -9,6 +9,7 @@ from backlog.issue import Issue
 from backlog.git import Git
 from backlog.user import User
 from backlog.category import Category
+from backlog.custom_field import CustomField
 
 BACKLOG_BASE_URL = "https://{space}.backlog.jp"
 BACKLOG_URI_PREFIX = "/api/v2/"
@@ -97,6 +98,7 @@ class BacklogAPI(BaseAPI):
         self.git = Git(self)
         self.user = User(self)
         self.category = Category(self)
+        self.custom_field = CustomField(self)
 
     def get(self, method, uri, query_param, request_param, headers, **kwargs):
         _url = self.base_url + uri

python_backlog-0.7.2/backlog/custom_field.py

@@ -0,0 +1,378 @@
+from enum import Enum
+from typing import List, TypedDict, NewType, Optional, Union
+
+
+class CustomFieldResponse(TypedDict):
+    id: int
+    projectId: int
+    typeId: int
+    version: str
+    name: str
+    description: str
+    required: bool
+    useIssueType: bool
+    applicableIssueTypes: List[int]
+    displayOrder: int
+
+
+class _InitialDate(TypedDict):
+    id: int
+    shift: Optional[int]
+    date: Optional[str]
+
+
+class NumberCustomFieldResponse(CustomFieldResponse):
+    min: int
+    max: int
+    initialValue: int
+    unit: str
+    initialDate: _InitialDate
+
+
+class DateCustomFieldResponse(CustomFieldResponse):
+    min: str
+    max: str
+    initialValueType: int
+    initialDate: str
+    initialShift: int
+
+
+class _ListCustomFieldResponseItem(TypedDict):
+    id: int
+    name: str
+    displayOrder: int
+
+
+class ListCustomFieldResponse(CustomFieldResponse):
+    items: List[_ListCustomFieldResponseItem]
+    allowInput: bool
+    allowAddItem: bool
+
+
+AddTextCustomFieldResponse = NewType("AddTextCustomFieldResponse", CustomFieldResponse)
+AddSentenceCustomFieldResponse = NewType("AddSentenceCustomFieldResponse", CustomFieldResponse)
+AddNumberCustomFieldResponse = NewType("AddNumberCustomFieldResponse", NumberCustomFieldResponse)
+AddDateCustomFieldResponse = NewType("AddDateCustomFieldResponse", DateCustomFieldResponse)
+AddSingleListCustomFieldResponse = NewType("AddSingleListCustomFieldResponse", ListCustomFieldResponse)
+AddMultipleListCustomFieldResponse = NewType("AddMultipleListCustomFieldResponse", ListCustomFieldResponse)
+AddCheckboxCustomFieldResponse = NewType("AddCheckboxCustomFieldResponse", ListCustomFieldResponse)
+AddRadioCustomFieldResponse = NewType("AddRadioCustomFieldResponse", ListCustomFieldResponse)
+AddCustomFiledResponse = Union[
+    AddTextCustomFieldResponse, AddSentenceCustomFieldResponse,
+    AddNumberCustomFieldResponse, AddDateCustomFieldResponse,
+    AddSingleListCustomFieldResponse, AddMultipleListCustomFieldResponse,
+    AddCheckboxCustomFieldResponse, AddRadioCustomFieldResponse,
+]
+
+DeleteTextCustomFieldResponse = NewType("DeleteTextCustomFieldResponse", CustomFieldResponse)
+DeleteSentenceCustomFieldResponse = NewType("DeleteSentenceCustomFieldResponse", CustomFieldResponse)
+DeleteNumberCustomFieldResponse = NewType("DeleteNumberCustomFieldResponse", NumberCustomFieldResponse)
+DeleteDateCustomFieldResponse = NewType("DeleteDateCustomFieldResponse", DateCustomFieldResponse)
+DeleteSingleListCustomFieldResponse = NewType("DeleteSingleListCustomFieldResponse", ListCustomFieldResponse)
+DeleteMultipleListCustomFieldResponse = NewType("DeleteMultipleListCustomFieldResponse", ListCustomFieldResponse)
+DeleteCheckboxCustomFieldResponse = NewType("DeleteCheckboxCustomFieldResponse", ListCustomFieldResponse)
+DeleteRadioCustomFieldResponse = NewType("DeleteRadioCustomFieldResponse", ListCustomFieldResponse)
+DeleteCustomFiledResponse = Union[
+    DeleteTextCustomFieldResponse, DeleteSentenceCustomFieldResponse,
+    DeleteNumberCustomFieldResponse, DeleteDateCustomFieldResponse,
+    DeleteSingleListCustomFieldResponse, DeleteMultipleListCustomFieldResponse,
+    DeleteCheckboxCustomFieldResponse, DeleteRadioCustomFieldResponse,
+]
+
+
+class CustomField(object):
+    class TypeId(Enum):
+        TEXT = 1
+        SENTENCE = 2
+        NUMBER = 3
+        DATE = 4
+        SINGLE_LIST = 5
+        MULTIPLE_LIST = 6
+        CHECKBOX = 7
+        RADIO = 8
+
+    class DateInitialValueType(Enum):
+        TODAY = 1
+        TODAY_PLUS_INITIAL_SHIFT = 2
+        SPECIFIED_DAY = 3
+
+    def __init__(self, api) -> None:
+        self.api = api
+
+    def list(self, projectIdOrKey: str):
+        """List custom fields
+        https://developer.nulab.com/docs/backlog/api/2/get-custom-field-list/
+
+        :param projectIdOrKey: project id or key
+        :type projectIdOrKey: str
+        """
+        _url = f"projects/{projectIdOrKey}/customFields"
+        _method = "GET"
+
+        resp = self.api.invoke_method(_method, _url)
+
+        return resp.json()
+
+    def add(
+        self,
+        projectIdOrKey: str,
+        typeId: Union[TypeId, int],
+        name: str,
+        applicableIssueTypes: Optional[List[int]] = None,
+        description: Optional[str] = None,
+        required: Optional[bool] = None,
+        **kwargs,
+    ) -> AddCustomFiledResponse:
+        """Add custom field
+        https://developer.nulab.com/docs/backlog/api/2/add-custom-field/#
+        """
+        _url = f"projects/{projectIdOrKey}/customFields"
+        _method = "POST"
+        tid = typeId
+        if isinstance(typeId, Enum):
+            tid = typeId.value
+        elif isinstance(typeId, int):
+            tid = typeId
+        else:
+            raise ValueError(f"invalid typeId: {typeId}")
+        request_param = {
+            "typeId": tid,
+            "name": name,
+            "applicableIssueTypes": applicableIssueTypes,
+            "description": description,
+            "required": required,
+            **kwargs,
+        }
+        for k, v in request_param.copy().items():
+            if v is None:
+                del request_param[k]
+            if type(v) is bool:
+                request_param[k] = "true" if v else "false"
+
+        # for backlog parameter key spec
+        if "applicableIssueTypes" in request_param:
+            request_param["applicableIssueTypes[]"] = request_param["applicableIssueTypes"]
+            del request_param["applicableIssueTypes"]
+        if "items" in request_param:
+            request_param["items[]"] = request_param["items"]
+            del request_param["items"]
+
+        resp = self.api.invoke_method(_method, _url, request_param=request_param)
+
+        return resp.json()
+
+    def add_text_custom_field(
+        self,
+        projectIdOrKey: str,
+        name: str,
+        applicableIssueTypes: Optional[List[int]] = None,
+        description: Optional[str] = None,
+        required: Optional[bool] = None,
+    ) -> AddTextCustomFieldResponse:
+        return self.add(
+            projectIdOrKey,
+            1,
+            name,
+            applicableIssueTypes,
+            description,
+            required,
+        )
+
+    def add_sentence_custom_field(
+        self,
+        projectIdOrKey: str,
+        name: str,
+        applicableIssueTypes: Optional[List[int]] = None,
+        description: Optional[str] = None,
+        required: Optional[bool] = None,
+    ) -> AddSentenceCustomFieldResponse:
+        return self.add(
+            projectIdOrKey,
+            2,
+            name,
+            applicableIssueTypes,
+            description,
+            required,
+        )
+
+    def add_number_custom_field(
+        self,
+        projectIdOrKey: str,
+        name: str,
+        applicableIssueTypes: Optional[List[int]] = None,
+        description: Optional[str] = None,
+        required: Optional[bool] = None,
+        min: Optional[int] = None,
+        max: Optional[int] = None,
+        initialValue: Optional[int] = None,
+        unit: Optional[str] = None,
+    ) -> AddNumberCustomFieldResponse:
+        return self.add(
+            projectIdOrKey,
+            3,
+            name,
+            applicableIssueTypes,
+            description,
+            required,
+            min=min,
+            max=max,
+            initialValue=initialValue,
+            unit=unit,
+        )
+
+    def add_date_custom_field(
+        self,
+        projectIdOrKey: str,
+        name: str,
+        applicableIssueTypes: Optional[List[int]] = None,
+        description: Optional[str] = None,
+        required: Optional[bool] = None,
+        min: Optional[str] = None,  # yyyy-MM-dd
+        max: Optional[str] = None,  # yyyy-MM-dd
+        initialValueType: Optional[DateInitialValueType] = None,
+        initialDate: Optional[str] = None,  # yyyy-MM-dd
+        initialShift: Optional[int] = None,
+    ) -> AddDateCustomFieldResponse:
+        if isinstance(initialValueType, Enum):
+            initialValueType = initialValueType.value
+
+        if (
+            (initialValueType == self.DateInitialValueType.SPECIFIED_DAY.value)
+            and (initialDate is None)
+        ):
+            raise ValueError("initialDate is required when initialValueType is SPECIFIED_DAY")
+
+        return self.add(
+            projectIdOrKey,
+            4,
+            name,
+            applicableIssueTypes,
+            description,
+            required,
+            min=min,
+            max=max,
+            initialValueType=initialValueType,
+            initialDate=initialDate,
+            initialShift=initialShift,
+        )
+
+    def add_single_list_custom_field(
+        self,
+        projectIdOrKey: str,
+        name: str,
+        applicableIssueTypes: Optional[List[int]] = None,
+        description: Optional[str] = None,
+        required: Optional[bool] = None,
+        items: Optional[List[str]] = None,
+        allowInput: Optional[bool] = None,
+        allowAddItem: Optional[bool] = None,
+    ) -> AddSingleListCustomFieldResponse:
+        return self.add(
+            projectIdOrKey,
+            5,
+            name,
+            applicableIssueTypes,
+            description,
+            required,
+            items=items,
+            allowInput=allowInput,
+            allowAddItem=allowAddItem,
+        )
+
+    def add_multiple_list_custom_field(
+        self,
+        projectIdOrKey: str,
+        name: str,
+        applicableIssueTypes: Optional[List[int]] = None,
+        description: Optional[str] = None,
+        required: Optional[bool] = None,
+        items: Optional[List[str]] = None,
+        allowInput: Optional[bool] = None,
+        allowAddItem: Optional[bool] = None,
+    ) -> AddMultipleListCustomFieldResponse:
+        return self.add(
+            projectIdOrKey,
+            6,
+            name,
+            applicableIssueTypes,
+            description,
+            required,
+            items=items,
+            allowInput=allowInput,
+            allowAddItem=allowAddItem,
+        )
+
+    def add_checkbox_custom_field(
+        self,
+        projectIdOrKey: str,
+        name: str,
+        applicableIssueTypes: Optional[List[int]] = None,
+        description: Optional[str] = None,
+        required: Optional[bool] = None,
+        items: Optional[List[str]] = None,
+        allowInput: Optional[bool] = None,
+        allowAddItem: Optional[bool] = None,
+    ) -> AddCheckboxCustomFieldResponse:
+        return self.add(
+            projectIdOrKey,
+            7,
+            name,
+            applicableIssueTypes,
+            description,
+            required,
+            items=items,
+            allowInput=allowInput,
+            allowAddItem=allowAddItem,
+        )
+
+    def add_radio_custom_field(
+        self,
+        projectIdOrKey: str,
+        name: str,
+        applicableIssueTypes: Optional[List[int]] = None,
+        description: Optional[str] = None,
+        required: Optional[bool] = None,
+        items: Optional[List[str]] = None,
+        allowInput: Optional[bool] = None,
+        allowAddItem: Optional[bool] = None,
+    ) -> AddRadioCustomFieldResponse:
+        return self.add(
+            projectIdOrKey,
+            8,
+            name,
+            applicableIssueTypes,
+            description,
+            required,
+            items=items,
+            allowInput=allowInput,
+            allowAddItem=allowAddItem,
+        )
+
+    # def update(self, projectIdOrKey: str, id: int, name: str):
+    #     """Update category
+    #     https://developer.nulab.com/docs/backlog/api/2/update-category/#
+
+    #     :param projectIdOrKey: project id or key
+    #     :type projectIdOrKey: str
+    #     :param id: category id
+    #     :type id: int
+    #     :param name: category name
+    #     :type name: str
+    #     """
+    #     _url = f"projects/{projectIdOrKey}/categories/{id}"
+    #     _method = "PATCH"
+
+    #     resp = self.api.invoke_method(_method, _url, request_param={"name": name})
+
+    #     return resp.json()
+
+    def delete(self, projectIdOrKey: str, id: int) -> DeleteCustomFiledResponse:
+        """Delete custom field
+        https://developer.nulab.com/docs/backlog/api/2/delete-custom-field/#delete-custom-field
+        """
+        _url = f"projects/{projectIdOrKey}/customFields/{id}"
+        _method = "DELETE"
+
+        resp = self.api.invoke_method(_method, _url)
+
+        return resp.json()

python_backlog-0.7.2/python_backlog.egg-info/PKG-INFO

@@ -0,0 +1,89 @@
+Metadata-Version: 2.1
+Name: python-backlog
+Version: 0.7.2
+Summary: Backlog API v2 wrapper
+Home-page: https://github.com/hassaku63/pbl
+Author: hassaku63
+Author-email: hassaku63@gmail.com
+License: MIT
+Project-URL: Source, https://github.com/hassaku63/pbl
+Keywords: nulab backlog
+Classifier: Development Status :: 4 - Beta
+Classifier: Programming Language :: Python
+Classifier: Programming Language :: Python :: 3.8
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Natural Language :: Japanese
+Requires-Python: >=3.8
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: requests~=2.32.2
+
+# pbl
+
+A Python package wraps Backlog API V2
+
+## Usage
+
+Install
+
+```bash
+pip install python-backlog
+```
+
+Code snippet
+
+```python
+import base64
+import json
+from backlog.base import BacklogAPI
+
+
+def main():
+    """
+    Initialize API Object
+    """
+    api = BacklogAPI("your-space", "your-api-key")
+
+    """
+    Project API
+    """
+    # list project users
+    # https://developer.nulab-inc.com/ja/docs/backlog/api/2/get-project-list/
+    print("# list project users")
+    users = api.project.list_users("SampleProject")
+    print(json.dumps(users, indent=2))
+
+
+    """
+    Wiki API
+    """
+    # list wikis
+    # https://developer.nulab-inc.com/ja/docs/backlog/api/2/get-wiki-page-list/
+    print("# list wikis")
+    wikis = api.wiki.list("SampleProject")
+    print(json.dumps(wikis[0], indent=2))
+
+    # get attachment
+    # https://developer.nulab-inc.com/ja/docs/backlog/api/2/get-issue-attachment/
+    print("# get attachment")
+    wiki = [w for w in api.wiki.list("SampleProject") if len(w["attachments"]) > 0][0]
+    attachment = api.wiki.get_attachment(
+        wikiId=wiki["id"],
+        attachmentId=wiki["attachments"][0]["id"])
+    attachment["data"] = base64.b64encode(attachment["data"]).decode()
+    print(json.dumps(attachment, indent=2))
+
+
+if __name__ == "__main__":
+    main()
+```
+
+## See also
+
+Qiita https://qiita.com/hassaku_63/items/b9eb2a1c7ecd3c19507d
+
+## Contact
+
+Twitter: [hassaku_63](https://twitter.com/hassaku_63)

{python-backlog-0.6.0 → python_backlog-0.7.2}/python_backlog.egg-info/SOURCES.txt

@@ -1,10 +1,15 @@
 LICENSE
+MANIFEST.in
 README.md
+VERSION
+requirements-dev.txt
+requirements.txt
 setup.py
 backlog/__init__.py
 backlog/attachment.py
 backlog/base.py
 backlog/category.py
+backlog/custom_field.py
 backlog/git.py
 backlog/issue.py
 backlog/project.py
@@ -14,4 +19,13 @@ python_backlog.egg-info/PKG-INFO
 python_backlog.egg-info/SOURCES.txt
 python_backlog.egg-info/dependency_links.txt
 python_backlog.egg-info/requires.txt
-python_backlog.egg-info/top_level.txt
+python_backlog.egg-info/top_level.txt
+tests/test_api.py
+tests/test_attachment.py
+tests/test_category.py
+tests/test_custom_filed.py
+tests/test_git.py
+tests/test_issue.py
+tests/test_project.py
+tests/test_user.py
+tests/test_wiki.py

python_backlog-0.7.2/python_backlog.egg-info/requires.txt

@@ -0,0 +1 @@
+requests~=2.32.2

python_backlog-0.7.2/requirements-dev.txt

@@ -0,0 +1,4 @@
+flake8~=6.1.0
+tox~=4.11.0
+httpretty~=1.1.0
+coverage~=7.3.0

python_backlog-0.7.2/requirements.txt

@@ -0,0 +1 @@
+requests~=2.32.2

{python-backlog-0.6.0 → python_backlog-0.7.2}/setup.py

@@ -10,14 +10,18 @@ with open(path.join(here, 'README.md'), encoding='utf-8') as f:
     long_description = f.read()
 
 with open(path.join(here, 'VERSION'), encoding='utf-8') as f:
-    version = f.read()
+    version = f.read().strip()
+
+with open(path.join(here, 'requirements.txt'), encoding='utf-8') as f:
+    install_requires = f.read().splitlines()
+
+with open(path.join(here, 'requirements-dev.txt'), encoding='utf-8') as f:
+    tests_require = f.read().splitlines()
 
 setup(
     name='python-backlog',
     version=version,
-    install_requires=[
-        'requests~=2.31.0',
-    ],
+    install_requires=install_requires,
     description='Backlog API v2 wrapper',
     long_description=long_description,
     long_description_content_type='text/markdown',
@@ -38,12 +42,7 @@ setup(
     scripts=[],
     packages=find_packages(exclude=['tests*']),
     python_requires=">=3.8",
-    tests_require=[
-        "flake8~=6.1.0",
-        "tox~=4.11.0",
-        "httpretty~=1.1.0",
-        "coverage~=7.3.0",
-    ],
+    tests_require=install_requires + tests_require,
     project_urls={
         'Source': 'https://github.com/hassaku63/pbl',
     }