gitcode-api 1.3.1__py3-none-any.whl → 1.3.3__py3-none-any.whl

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
gitcode_api/cli.py CHANGED
@@ -281,7 +281,7 @@ Examples:
281
281
  %(prog)s users me --api-key "$GITCODE_ACCESS_TOKEN"
282
282
  %(prog)s pulls list --set only_count=true --set reviewer=demo
283
283
 
284
- Extra keyword arguments (**params / **payload on some methods):
284
+ Extra keyword arguments (when needed):
285
285
  Repeat --set key=value (value is JSON if it parses as JSON; otherwise a string).
286
286
  --set-json merges one JSON object (or @path/to/file.json) into those kwargs.
287
287
 
@@ -375,7 +375,7 @@ Each method -h opens with resource.method_signature("<name>") from the Python SD
375
375
  action="append",
376
376
  default=None,
377
377
  metavar="KEY=VALUE",
378
- help="Extra keyword argument (merged into **params / **payload).",
378
+ help="Extra keyword arguments.",
379
379
  )
380
380
  method_parser.add_argument(
381
381
  "--set-json",
@@ -77,16 +77,43 @@ class AbstractOrgsResource(ABC):
77
77
  """
78
78
 
79
79
  @abstractmethod
80
- def create_repo(self, *, org: str, name: str, **payload) -> Repository:
80
+ def create_repo(
81
+ self,
82
+ *,
83
+ org: str,
84
+ name: str,
85
+ description: Optional[str] = None,
86
+ homepage: Optional[str] = None,
87
+ has_issues: Optional[bool] = None,
88
+ has_wiki: Optional[bool] = None,
89
+ can_comment: Optional[bool] = None,
90
+ public: Optional[int] = None,
91
+ private: Optional[bool] = None,
92
+ auto_init: Optional[bool] = None,
93
+ gitignore_template: Optional[str] = None,
94
+ license_template: Optional[str] = None,
95
+ path: Optional[str] = None,
96
+ default_branch: Optional[str] = None,
97
+ **kwargs,
98
+ ) -> Repository:
81
99
  """Create an organization repository.
82
100
 
83
- Additional payload fields match the organization repository creation
84
- endpoint, such as ``description``, ``homepage``, ``private``,
85
- ``public``, ``auto_init``, and ``default_branch``.
86
-
87
101
  :param org: Organization path or login.
88
102
  :param name: Repository name.
89
- :param payload: Additional repository creation fields.
103
+ :param description: Repository description.
104
+ :param homepage: Homepage URL.
105
+ :param has_issues: Allow issues to be created. Default: ``True``.
106
+ :param has_wiki: Provide wiki. Default: ``True``.
107
+ :param can_comment: Allow users to comment on repositories. Default: ``True``.
108
+ :param public: Open source type: ``0`` (private), ``1`` (external), ``2`` (internal).
109
+ Mutually exclusive with *private*.
110
+ :param private: Repository visibility. Mutually exclusive with *public*.
111
+ :param auto_init: Initialize with a README. Default: ``False``.
112
+ :param gitignore_template: ``.gitignore`` template name.
113
+ :param license_template: License template name.
114
+ :param path: Repository path.
115
+ :param default_branch: Default branch name. Default: ``main``.
116
+ :param kwargs: Additional arguments forwarded directly in request.
90
117
  :returns: Created repository metadata.
91
118
  """
92
119
 
@@ -184,11 +211,26 @@ class AbstractOrgsResource(ABC):
184
211
  """
185
212
 
186
213
  @abstractmethod
187
- def update(self, *, org: str, **payload) -> Organization:
214
+ def update(
215
+ self,
216
+ *,
217
+ org: str,
218
+ name: Optional[str] = None,
219
+ email: Optional[str] = None,
220
+ location: Optional[str] = None,
221
+ description: Optional[str] = None,
222
+ html_url: Optional[str] = None,
223
+ **kwargs,
224
+ ) -> Organization:
188
225
  """Update organization metadata.
189
226
 
190
227
  :param org: Organization path or login.
191
- :param payload: Updatable fields such as ``name``, ``email``, or ``description``.
228
+ :param name: Organization name.
229
+ :param email: Organization email.
230
+ :param location: Organization location.
231
+ :param description: Organization description.
232
+ :param html_url: Organization site URL.
233
+ :param kwargs: Additional arguments forwarded directly in request.
192
234
  :returns: Updated organization details.
193
235
  """
194
236
 
@@ -239,9 +281,46 @@ class OrgsResource(SyncResource, AbstractOrgsResource):
239
281
  params={"type": type, "page": page, "per_page": per_page},
240
282
  )
241
283
 
242
- def create_repo(self, *, org: str, name: str, **payload) -> Repository:
243
- payload["name"] = name
244
- return self._model("POST", self._client._path("orgs", org, "repos"), Repository, json=payload)
284
+ def create_repo(
285
+ self,
286
+ *,
287
+ org: str,
288
+ name: str,
289
+ description: Optional[str] = None,
290
+ homepage: Optional[str] = None,
291
+ has_issues: Optional[bool] = None,
292
+ has_wiki: Optional[bool] = None,
293
+ can_comment: Optional[bool] = None,
294
+ public: Optional[int] = None,
295
+ private: Optional[bool] = None,
296
+ auto_init: Optional[bool] = None,
297
+ gitignore_template: Optional[str] = None,
298
+ license_template: Optional[str] = None,
299
+ path: Optional[str] = None,
300
+ default_branch: Optional[str] = None,
301
+ **kwargs,
302
+ ) -> Repository:
303
+ return self._model(
304
+ "POST",
305
+ self._client._path("orgs", org, "repos"),
306
+ Repository,
307
+ json={
308
+ "name": name,
309
+ "description": description,
310
+ "homepage": homepage,
311
+ "has_issues": has_issues,
312
+ "has_wiki": has_wiki,
313
+ "can_comment": can_comment,
314
+ "public": public,
315
+ "private": private,
316
+ "auto_init": auto_init,
317
+ "gitignore_template": gitignore_template,
318
+ "license_template": license_template,
319
+ "path": path,
320
+ "default_branch": default_branch,
321
+ **kwargs,
322
+ },
323
+ )
245
324
 
246
325
  def get_enterprise_member(self, *, enterprise: str, username: str) -> EnterpriseMember:
247
326
  return self._model("GET", self._client._path("enterprises", enterprise, "members", username), EnterpriseMember)
@@ -302,8 +381,30 @@ class OrgsResource(SyncResource, AbstractOrgsResource):
302
381
  json={"role": role},
303
382
  )
304
383
 
305
- def update(self, *, org: str, **payload) -> Organization:
306
- return self._model("PATCH", self._client._path("orgs", org), Organization, json=payload)
384
+ def update(
385
+ self,
386
+ *,
387
+ org: str,
388
+ name: Optional[str] = None,
389
+ email: Optional[str] = None,
390
+ location: Optional[str] = None,
391
+ description: Optional[str] = None,
392
+ html_url: Optional[str] = None,
393
+ **kwargs,
394
+ ) -> Organization:
395
+ return self._model(
396
+ "PATCH",
397
+ self._client._path("orgs", org),
398
+ Organization,
399
+ json={
400
+ "name": name,
401
+ "email": email,
402
+ "location": location,
403
+ "description": description,
404
+ "html_url": html_url,
405
+ **kwargs,
406
+ },
407
+ )
307
408
 
308
409
  def leave(self, *, org: str) -> None:
309
410
  self._request("DELETE", self._client._path("user", "memberships", "orgs", org))
@@ -351,9 +452,46 @@ class AsyncOrgsResource(AsyncResource, AbstractOrgsResource):
351
452
  params={"type": type, "page": page, "per_page": per_page},
352
453
  )
353
454
 
354
- async def create_repo(self, *, org: str, name: str, **payload) -> Repository:
355
- payload["name"] = name
356
- return await self._model("POST", self._client._path("orgs", org, "repos"), Repository, json=payload)
455
+ async def create_repo(
456
+ self,
457
+ *,
458
+ org: str,
459
+ name: str,
460
+ description: Optional[str] = None,
461
+ homepage: Optional[str] = None,
462
+ has_issues: Optional[bool] = None,
463
+ has_wiki: Optional[bool] = None,
464
+ can_comment: Optional[bool] = None,
465
+ public: Optional[int] = None,
466
+ private: Optional[bool] = None,
467
+ auto_init: Optional[bool] = None,
468
+ gitignore_template: Optional[str] = None,
469
+ license_template: Optional[str] = None,
470
+ path: Optional[str] = None,
471
+ default_branch: Optional[str] = None,
472
+ **kwargs,
473
+ ) -> Repository:
474
+ return await self._model(
475
+ "POST",
476
+ self._client._path("orgs", org, "repos"),
477
+ Repository,
478
+ json={
479
+ "name": name,
480
+ "description": description,
481
+ "homepage": homepage,
482
+ "has_issues": has_issues,
483
+ "has_wiki": has_wiki,
484
+ "can_comment": can_comment,
485
+ "public": public,
486
+ "private": private,
487
+ "auto_init": auto_init,
488
+ "gitignore_template": gitignore_template,
489
+ "license_template": license_template,
490
+ "path": path,
491
+ "default_branch": default_branch,
492
+ **kwargs,
493
+ },
494
+ )
357
495
 
358
496
  async def get_enterprise_member(self, *, enterprise: str, username: str) -> EnterpriseMember:
359
497
  return await self._model(
@@ -415,8 +553,30 @@ class AsyncOrgsResource(AsyncResource, AbstractOrgsResource):
415
553
  json={"role": role},
416
554
  )
417
555
 
418
- async def update(self, *, org: str, **payload) -> Organization:
419
- return await self._model("PATCH", self._client._path("orgs", org), Organization, json=payload)
556
+ async def update(
557
+ self,
558
+ *,
559
+ org: str,
560
+ name: Optional[str] = None,
561
+ email: Optional[str] = None,
562
+ location: Optional[str] = None,
563
+ description: Optional[str] = None,
564
+ html_url: Optional[str] = None,
565
+ **kwargs,
566
+ ) -> Organization:
567
+ return await self._model(
568
+ "PATCH",
569
+ self._client._path("orgs", org),
570
+ Organization,
571
+ json={
572
+ "name": name,
573
+ "email": email,
574
+ "location": location,
575
+ "description": description,
576
+ "html_url": html_url,
577
+ **kwargs,
578
+ },
579
+ )
420
580
 
421
581
  async def leave(self, *, org: str) -> None:
422
582
  await self._request("DELETE", self._client._path("user", "memberships", "orgs", org))
@@ -56,14 +56,26 @@ class AbstractUsersResource(ABC):
56
56
  """
57
57
 
58
58
  @abstractmethod
59
- def list_repos(self, *, username: str, **params) -> List[Repository]:
59
+ def list_repos(
60
+ self,
61
+ *,
62
+ username: str,
63
+ type: Optional[str] = None,
64
+ sort: Optional[str] = None,
65
+ direction: Optional[str] = None,
66
+ page: Optional[int] = None,
67
+ per_page: Optional[int] = None,
68
+ **kwargs,
69
+ ) -> List[Repository]:
60
70
  """List public repositories owned by a user.
61
71
 
62
- Supported filters follow the user repository API documentation, such as
63
- ``type``, ``sort``, ``direction``, ``page``, and ``per_page``.
64
-
65
72
  :param username: GitCode username or login.
66
- :param params: Query parameters accepted by the REST endpoint.
73
+ :param type: Ownership filter: ``owner``, ``personal``, ``member``, or ``all``. Default: ``all``.
74
+ :param sort: Sort field: ``created``, ``updated``, ``pushed``, or ``full_name``. Default: ``full_name``.
75
+ :param direction: ``asc`` or ``desc``.
76
+ :param page: Page number.
77
+ :param per_page: Page size.
78
+ :param kwargs: Additional arguments forwarded directly in request.
67
79
  :returns: Matching repositories.
68
80
  """
69
81
 
@@ -149,8 +161,30 @@ class UsersResource(SyncResource, AbstractUsersResource):
149
161
  params={"year": year, "next": next},
150
162
  )
151
163
 
152
- def list_repos(self, *, username: str, **params) -> List[Repository]:
153
- return self._models("GET", self._client._path("users", username, "repos"), Repository, params=params)
164
+ def list_repos(
165
+ self,
166
+ *,
167
+ username: str,
168
+ type: Optional[str] = None,
169
+ sort: Optional[str] = None,
170
+ direction: Optional[str] = None,
171
+ page: Optional[int] = None,
172
+ per_page: Optional[int] = None,
173
+ **kwargs,
174
+ ) -> List[Repository]:
175
+ return self._models(
176
+ "GET",
177
+ self._client._path("users", username, "repos"),
178
+ Repository,
179
+ params={
180
+ "type": type,
181
+ "sort": sort,
182
+ "direction": direction,
183
+ "page": page,
184
+ "per_page": per_page,
185
+ **kwargs,
186
+ },
187
+ )
154
188
 
155
189
  def create_key(self, *, key: str, title: str) -> PublicKey:
156
190
  return self._model("POST", self._client._path("user", "keys"), PublicKey, json={"key": key, "title": title})
@@ -210,8 +244,30 @@ class AsyncUsersResource(AsyncResource, AbstractUsersResource):
210
244
  params={"year": year, "next": next},
211
245
  )
212
246
 
213
- async def list_repos(self, *, username: str, **params) -> List[Repository]:
214
- return await self._models("GET", self._client._path("users", username, "repos"), Repository, params=params)
247
+ async def list_repos(
248
+ self,
249
+ *,
250
+ username: str,
251
+ type: Optional[str] = None,
252
+ sort: Optional[str] = None,
253
+ direction: Optional[str] = None,
254
+ page: Optional[int] = None,
255
+ per_page: Optional[int] = None,
256
+ **kwargs,
257
+ ) -> List[Repository]:
258
+ return await self._models(
259
+ "GET",
260
+ self._client._path("users", username, "repos"),
261
+ Repository,
262
+ params={
263
+ "type": type,
264
+ "sort": sort,
265
+ "direction": direction,
266
+ "page": page,
267
+ "per_page": per_page,
268
+ **kwargs,
269
+ },
270
+ )
215
271
 
216
272
  async def create_key(self, *, key: str, title: str) -> PublicKey:
217
273
  return await self._model(