python-backlog 0.7.0__tar.gz → 0.7.4__tar.gz

python_backlog-0.7.4/MANIFEST.in

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

python_backlog-0.7.4/PKG-INFO

@@ -0,0 +1,89 @@
+Metadata-Version: 2.1
+Name: python-backlog
+Version: 0.7.4
+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.4/VERSION

@@ -0,0 +1 @@
+0.7.4

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

@@ -0,0 +1,89 @@
+Metadata-Version: 2.1
+Name: python-backlog
+Version: 0.7.4
+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.0 → python_backlog-0.7.4}/python_backlog.egg-info/SOURCES.txt

@@ -1,5 +1,9 @@
 LICENSE
+MANIFEST.in
 README.md
+VERSION
+requirements-dev.txt
+requirements.txt
 setup.py
 backlog/__init__.py
 backlog/attachment.py
@@ -15,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.4/python_backlog.egg-info/requires.txt

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

python_backlog-0.7.4/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.4/requirements.txt

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

{python-backlog-0.7.0 → python_backlog-0.7.4}/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',
     }

python_backlog-0.7.4/tests/test_api.py

@@ -0,0 +1,120 @@
+# coding: utf-8
+
+import unittest
+import httpretty
+import json
+from backlog.base import BacklogAPI
+
+API_ENDPOINT = "https://{space}.backlog.jp/api/v2/{uri}"
+
+
+class TestApi(unittest.TestCase):
+    def setUp(self):
+        self.api = BacklogAPI("space", "api_key")
+        self.space = "space"
+        self.api_key = "api_key"
+
+    @httpretty.activate
+    def test_invoke_get(self):
+        expects = {
+            "ok": True
+        }
+        _uri = "test"
+
+        # Status Pattern
+        _http_statuses = [200, 201]
+
+        for _status_code in _http_statuses:
+            with self.subTest(status_code=_status_code):
+                httpretty.register_uri(
+                    httpretty.GET,
+                    API_ENDPOINT.format(space=self.space, uri=_uri),
+                    body=json.dumps(expects),
+                    content_type="application/json",
+                    status=_status_code
+                )
+
+                resp = self.api.invoke_method("GET", _uri)
+                self.assertEqual(_status_code, resp.status_code)
+                self.assertEqual(expects, resp.json())
+
+        # Test 204(NO_CONTENT) Response
+        #   NOTE: 204 response MUST NOT include a message-body.
+        #   http://tools.ietf.org/search/rfc2616#section-10.2.5
+        httpretty.register_uri(
+            httpretty.GET,
+            API_ENDPOINT.format(space=self.space, uri=_uri),
+            content_type="application/json",
+            status=204
+        )
+
+        resp = self.api.invoke_method("GET", _uri)
+        self.assertEqual(204, resp.status_code)
+
+    @httpretty.activate
+    def test_invoke_post(self):
+        expects = {
+            "ok": True
+        }
+        _uri = "test"
+
+        # Status Pattern
+        _http_statuses = [200, 201]
+
+        for _status_code in _http_statuses:
+            with self.subTest(status_code=_status_code):
+                httpretty.register_uri(
+                    httpretty.POST,
+                    API_ENDPOINT.format(space=self.space, uri=_uri),
+                    body=json.dumps(expects),
+                    content_type="application/json",
+                    status=_status_code
+                )
+
+                resp = self.api.invoke_method("POST", _uri)
+                self.assertEqual(_status_code, resp.status_code)
+                self.assertEqual(expects, resp.json())
+
+    @httpretty.activate
+    def test_invoke_delete(self):
+        expects = {
+            "ok": True
+        }
+        _uri = "test"
+
+        # Status 200
+        httpretty.register_uri(
+            httpretty.DELETE,
+            API_ENDPOINT.format(space=self.space, uri=_uri),
+            body=json.dumps(expects),
+            content_type="application/json",
+            status=200
+        )
+
+        resp = self.api.invoke_method("DELETE", _uri)
+        self.assertEqual(200, resp.status_code)
+        self.assertEqual(expects, resp.json())
+
+    @httpretty.activate
+    def test_invoke_patch(self):
+        expects = {
+            "ok": True
+        }
+        _uri = "test"
+
+        # Status 200
+        httpretty.register_uri(
+            httpretty.PATCH,
+            API_ENDPOINT.format(space=self.space, uri=_uri),
+            body=json.dumps(expects),
+            content_type="application/json",
+            status=200
+        )
+
+        resp = self.api.invoke_method("PATCH", _uri)
+        self.assertEqual(200, resp.status_code)
+        self.assertEqual(expects, resp.json())
+
+
+if __name__ == "__main__":
+    unittest.main(warnings='ignore')

python_backlog-0.7.4/tests/test_attachment.py

@@ -0,0 +1,55 @@
+# coding: utf-8
+
+import unittest
+import httpretty
+import json
+import os
+import tempfile
+from backlog.base import BacklogAPI
+
+API_ENDPOINT = "https://{space}.backlog.jp/api/v2/{uri}"
+
+
+class TestAttachment(unittest.TestCase):
+    def setUp(self):
+        self.api = BacklogAPI("space", "api_key")
+        self.space = "space"
+        self.api_key = "api_key"
+
+        # tempfile
+        self.test_dir = tempfile.mkdtemp()
+        self.test_fd, self.test_file = tempfile.mkstemp(dir=self.test_dir)
+        self.test_data = b"1234567890"
+
+        with open(self.test_fd, "wb") as fp:
+            fp.write(self.test_data)
+
+    @httpretty.activate
+    def test_upload_attachment(self):
+        _uri = "space/attachment"
+        _filename = os.path.basename(self.test_file)
+        expects = {
+            "id": 1,
+            "name": _filename,
+            "size": 8857
+        }
+        httpretty.register_uri(
+            httpretty.POST,
+            API_ENDPOINT.format(space=self.space, uri=_uri),
+            body=json.dumps(expects)
+        )
+
+        # test
+        resp = self.api.attachment.upload(filename=self.test_file)
+        self.assertTrue(expects, resp)
+
+    @httpretty.activate
+    def test_upload_attachment_file_not_found(self):
+        _filename = "not_exist_file.txt"
+
+        with self.assertRaises(FileNotFoundError):
+            self.api.attachment.upload(filename=_filename)
+
+
+if __name__ == "__main__":
+    unittest.main(warnings='ignore')

python_backlog-0.7.4/tests/test_category.py

@@ -0,0 +1,97 @@
+import unittest
+import json
+import httpretty
+from backlog.base import BacklogAPI
+
+API_ENDPOINT = "https://{space}.backlog.jp/api/v2/{path}"
+
+
+class TestCategory(unittest.TestCase):
+    def setUp(self) -> None:
+        self.api = BacklogAPI("space", "api_key")
+        self.space = "space"
+        self.api_key = "api_key"
+        self.project = "test-project"
+
+    @httpretty.activate
+    def test_list(self):
+        expects = [
+            {
+                "id": 100,
+                "projectId": 1,
+                "name": "test-category",
+                "displayOrder": 1
+            },
+        ]
+        path = f"projects/{self.project}/categories"
+        httpretty.register_uri(
+            httpretty.GET,
+            API_ENDPOINT.format(space=self.space, path=path),
+            body=json.dumps(expects),
+            content_type="application/json"
+        )
+
+        resp = self.api.category.list(self.project)
+        self.assertEqual(expects, resp)
+
+    @httpretty.activate
+    def test_add(self):
+        category = "test-category"
+        expects = {
+            "id": 100,
+            "projectId": 1,
+            "name": category,
+            "displayOrder": 1
+        }
+        path = f"projects/{self.project}/categories"
+        httpretty.register_uri(
+            httpretty.POST,
+            API_ENDPOINT.format(space=self.space, path=path),
+            body=json.dumps(expects),
+            content_type="application/json"
+        )
+
+        resp = self.api.category.add(self.project, category)
+        self.assertEqual(expects, resp)
+
+    @httpretty.activate
+    def test_update(self):
+        category_id = 100
+        category = "updated-category"
+        expects = {
+            "id": category_id,
+            "projectId": 1,
+            "name": category,
+            "displayOrder": 1
+        }
+        path = f"projects/{self.project}/categories/{category_id}"
+        httpretty.register_uri(
+            httpretty.PATCH,
+            API_ENDPOINT.format(space=self.space, path=path),
+            body=json.dumps(expects),
+            content_type="application/json"
+        )
+
+        resp = self.api.category.update(self.project, category_id, category)
+        self.assertEqual(expects, resp)
+
+    @httpretty.activate
+    def test_delete(self):
+        category_id = 100
+        category = "deleted-category"
+        expects = {
+            "id": category_id,
+            "projectId": 1,
+            "name": category,
+            "displayOrder": 1
+        }
+        path = f"projects/{self.project}/categories/{category_id}"
+        httpretty.register_uri(
+            httpretty.DELETE,
+            API_ENDPOINT.format(space=self.space, path=path),
+            body=json.dumps(expects),
+            content_type="application/json"
+        )
+
+        resp = self.api.category.delete(self.project, category_id)
+        self.assertEqual(expects, resp)