refactor: follow python EOL schedule.

Author: netmarkjp

.github/workflows/ci.yml

@@ -10,7 +10,7 @@ jobs:
 
     strategy:
       matrix:
-        python-version: [3.11, 3.12, 3.13, 3.14]
+        python-version: [3.10, 3.11, 3.12, 3.13, 3.14]
 
     steps:
     - name: Check out code

README.md

@@ -10,57 +10,63 @@ Backlog API v2 Client Library for Python
 - Python 3.11+
 - requests 2.x
 
-# Install
+# Usage: install
 
 ```
 pip install pybacklog
 ```
 
-# Usage
+# Usage: code
 
 ```python
 from pybacklog import BacklogClient
+import os
 
-client = BacklogClient("your_space_name", "your_api_key")
+YOUR_SPACE_NAME = os.getenv("BACKLOG_SPACE_NAME", "")
+YOUR_API_KEY = os.getenv("BACKLOG_API_KEY", "")
+YOUR_PROJECT = os.getenv("BACKLOG_PROJECT", "")
+YOUR_ISSUE_KEY = os.getenv("BACKLOG_ISSUE_KEY", "")
+
+client = BacklogClient(YOUR_SPACE_NAME, YOUR_API_KEY)
 
 # space
-space = client.do("GET", "space")  # GET /api/v2/space
-print(space.get(u"spaceKey"))
+space = client.space()
+print(space.get("spaceKey"))
 
 # project
 projects = client.projects()
 
 # activity
-activities = client.project_activities("YOUR_PROJECT", {"activityTypeId[]": [1, 2]})
+activities = client.project_activities(YOUR_PROJECT, {"activityTypeId[]": [1, 2]})
 
 # list issue
-project_id = client.get_project_id("YOUR_PROJECT")
-issues = client.issues({"projectId[]":[project_id], "sort": "dueDate"})
+project_id = client.get_project_id(YOUR_PROJECT)
+issues = client.issues({"projectId[]": [project_id], "sort": "dueDate"})
 
 # specified issue
-issue = client.issue("YOUR_PROJECT-999")
+issue = client.issue(YOUR_ISSUE_KEY)
 
 # create issue
-project_id = client.get_project_id(project_key)
-issue_type_id = client.project_issue_types(project_key)[0][u"id"]
-priority_id = client.priorities()[0][u"id"]
+project_id = client.get_project_id(YOUR_PROJECT)
+issue_type_id = client.project_issue_types(YOUR_PROJECT)[0]["id"]
+priority_id = client.priorities()[0]["id"]
 
-client.create_issue(project_id,
-                    u"some summary",
-                    issue_type_id,
-                    priority_id,
-                    {"description": u"a is b and c or d."})
+if project_id and issue_type_id and priority_id:
+    client.create_issue(project_id, "some summary", issue_type_id, priority_id, {"description": "a is b and c or d."})
 
 # add comment
-client.add_issue_comment("YOUR_PROJECT-999", u"or ... else e.")
+client.add_issue_comment(YOUR_ISSUE_KEY, "or ... else e.")
 
 # top 10 star collector
-star_collectors = [(client.user_stars_count(u[u"id"], {"since": "2017-06-01", "until": "2017-06-30"})[u"count"], u[u"name"]) for u in client.users()]
+star_collectors = [
+    (client.user_stars_count(u["id"], {"since": "2017-06-01", "until": "2017-06-30"})["count"], u["name"])
+    for u in client.users()
+]
 star_collectors.sort()
 star_collectors.reverse()
 
 for i, (c, u) in enumerate(star_collectors[:10]):
-    print(i+1, c, u)
+    print(i + 1, c, u)
 ```
 
 supported operations are `pydoc pybacklog.BacklogClient`
@@ -74,16 +80,21 @@ Use `do` or let's write code and Pull Request.
 
 ```python
 from pybacklog import BacklogClient
+import os
+
+YOUR_SPACE_NAME = os.getenv("BACKLOG_SPACE_NAME", "")
+YOUR_API_KEY = os.getenv("BACKLOG_API_KEY", "")
+YOUR_PROJECT = os.getenv("BACKLOG_PROJECT", "")
 
-client = BacklogClient("your_space_name", "your_api_key")
+client = BacklogClient(YOUR_SPACE_NAME, YOUR_API_KEY)
 space = client.do("GET", "space")  # GET /api/v2/space
-projects = client.do("GET", "projects",
-          query_params={"archived": false}
-          )  # GET /api/v2/projects?archived=false
-activities = client.do("GET", "projects/{project_id_or_key}/activities",
-          url_params={"project_id_or_key": "myproj"},
-          query_params={"activityTypeId[]": [1, 2]}
-          )  # GET /api/v2/projects/myproj/activities?activityTypeIds%5B%5D=1&activityTypeIds%5B%5D=2
+projects = client.do("GET", "projects", query_params={"archived": False})  # GET /api/v2/projects?archived=false
+activities = client.do(
+    "GET",
+    "projects/{project_id_or_key}/activities",
+    url_params={"project_id_or_key": YOUR_PROJECT},
+    query_params={"activityTypeId[]": [1, 2]},
+)  # GET /api/v2/projects/myproj/activities?activityTypeIds%5B%5D=1&activityTypeIds%5B%5D=2
 ```
 
 see also [Backlog API Overview \| Backlog Developer API \| Nulab](https://developer.nulab-inc.com/docs/backlog/)

examples/project_activities.py

@@ -34,7 +34,9 @@
 
         try:
             summary = activity["content"]["summary"]
-        except (KeyError, TypeError):
+        except KeyError:
+            summary = ""
+        except TypeError:
             summary = ""
 
         item = (created, url, summary)

examples/project_activities2.py

@@ -26,9 +26,10 @@
 
         try:
             summary = activity["content"]["summary"]
-        except (KeyError, TypeError):
+        except KeyError:
+            summary = ""
+        except TypeError:
             summary = ""
-
         item = (created, url, summary)
         items.append(item)
 

examples/readme.py

@@ -0,0 +1,48 @@
+from pybacklog import BacklogClient
+import os
+
+YOUR_SPACE_NAME = os.getenv("BACKLOG_SPACE_NAME", "")
+YOUR_API_KEY = os.getenv("BACKLOG_API_KEY", "")
+YOUR_PROJECT = os.getenv("BACKLOG_PROJECT", "")
+YOUR_ISSUE_KEY = os.getenv("BACKLOG_ISSUE_KEY", "")
+
+client = BacklogClient(YOUR_SPACE_NAME, YOUR_API_KEY)
+
+# space
+space = client.space()
+print(space.get("spaceKey"))
+
+# project
+projects = client.projects()
+
+# activity
+activities = client.project_activities(YOUR_PROJECT, {"activityTypeId[]": [1, 2]})
+
+# list issue
+project_id = client.get_project_id(YOUR_PROJECT)
+issues = client.issues({"projectId[]": [project_id], "sort": "dueDate"})
+
+# specified issue
+issue = client.issue(YOUR_ISSUE_KEY)
+
+# create issue
+project_id = client.get_project_id(YOUR_PROJECT)
+issue_type_id = client.project_issue_types(YOUR_PROJECT)[0]["id"]
+priority_id = client.priorities()[0]["id"]
+
+if project_id and issue_type_id and priority_id:
+    client.create_issue(project_id, "some summary", issue_type_id, priority_id, {"description": "a is b and c or d."})
+
+# add comment
+client.add_issue_comment(YOUR_ISSUE_KEY, "or ... else e.")
+
+# top 10 star collector
+star_collectors = [
+    (client.user_stars_count(u["id"], {"since": "2017-06-01", "until": "2017-06-30"})["count"], u["name"])
+    for u in client.users()
+]
+star_collectors.sort()
+star_collectors.reverse()
+
+for i, (c, u) in enumerate(star_collectors[:10]):
+    print(i + 1, c, u)

examples/readme2.py

@@ -0,0 +1,16 @@
+from pybacklog import BacklogClient
+import os
+
+YOUR_SPACE_NAME = os.getenv("BACKLOG_SPACE_NAME", "")
+YOUR_API_KEY = os.getenv("BACKLOG_API_KEY", "")
+YOUR_PROJECT = os.getenv("BACKLOG_PROJECT", "")
+
+client = BacklogClient(YOUR_SPACE_NAME, YOUR_API_KEY)
+space = client.do("GET", "space")  # GET /api/v2/space
+projects = client.do("GET", "projects", query_params={"archived": False})  # GET /api/v2/projects?archived=false
+activities = client.do(
+    "GET",
+    "projects/{project_id_or_key}/activities",
+    url_params={"project_id_or_key": YOUR_PROJECT},
+    query_params={"activityTypeId[]": [1, 2]},
+)  # GET /api/v2/projects/myproj/activities?activityTypeIds%5B%5D=1&activityTypeIds%5B%5D=2

pyproject.toml

@@ -13,13 +13,14 @@ authors = [
 ]
 urls = { "Homepage" = "https://github.com/netmarkjp/pybacklog" }
 classifiers = [
+  "Programming Language :: Python :: 3.10",
   "Programming Language :: Python :: 3.11",
   "Programming Language :: Python :: 3.12",
   "Programming Language :: Python :: 3.13",
   "Programming Language :: Python :: 3.14",
   "Topic :: Utilities"
 ]
-requires-python = ">=3.11, <3.15"
+requires-python = ">=3.10, <3.15"
 
 dependencies = [
   "requests >=2.12.4,<3.0"
@@ -36,12 +37,12 @@ dev = [
 # Additional uv-specific configurations can be added here.
 
 [tool.ruff]
-target-version = "py314"
+target-version = "py310"
 line-length = 120
 # lint.select = ["E", "F", "W"]
 # lint.ignore = []
 exclude = [".venv", "build", "dist", ".eggs", "*.egg-info", ".ruff_cache", "__pycache__"]
 
 [tool.pyright]
-pythonVersion = "3.11"
+pythonVersion = "3.10"
 typeCheckingMode = "strict"