Sync GitHub metadata

jaraco/develop/add-github-secret.py

@@ -1,8 +1,10 @@
+from __future__ import annotations
+
 import autocommand
 
 from . import github
 
 
 @autocommand.autocommand(__name__)
-def run(name, value, project: github.Repo = github.Repo.detect()):
- project.add_secret(name, value)
+def run(name, value, project: github.Repo | None = None):
+ (project or github.Repo.detect()).add_secret(name, value)

jaraco/develop/add-github-secrets.py

@@ -1,3 +1,5 @@
+from __future__ import annotations
+
 import autocommand
 import keyring
 import getpass
@@ -32,7 +34,8 @@ def _safe_getuser():
 
 
 @autocommand.autocommand(__name__)
-def run(project: github.Repo = github.Repo.detect()):
+def run(project: github.Repo | None = None):
+ project = project or github.Repo.detect()
  for name in project.find_needed_secrets():
  source = secret_sources[name]
  value = keyring.get_password(**source)

jaraco/develop/create-github-release.py

@@ -1,10 +1,12 @@
+from __future__ import annotations
+
 import autocommand
 
 from . import github
 from . import repo
 
 
 @autocommand.autocommand(__name__)
-def run(project: github.Repo = github.Repo.detect()):
+def run(project: github.Repo | None = None):
  md = repo.get_project_metadata()
- project.create_release(tag=f'v{md.version}')
+ (project or github.Repo.detect()).create_release(tag=f'v{md.version}')

jaraco/develop/git.py

@@ -7,6 +7,7 @@
 import posixpath
 import re
 import subprocess
+import sys
 import types
 import urllib.parse
 
@@ -15,12 +16,9 @@
 import path
 from more_itertools import flatten
 
-from . import github
-
 
 class URLScheme:
  """
- >>> getfixture('git_url_substitutions')
  >>> scheme = URLScheme.lookup('gh://foo/bar')
  >>> scheme.resolve('gh://foo/bar')
  'https://github.com/foo/bar'
@@ -109,29 +107,68 @@ def path(self):
 
 class Project(str):
  """
- >>> p = Project.parse('foo-project [tag1] [tag2]')
+ >>> p = Project.parse('foo-project [tag1] [tag2] (zero defect, coherent software)')
  >>> p
  'foo-project'
  >>> p.tags
  ['tag1', 'tag2']
  >>> p.spec
  'foo-project [tag1] [tag2]'
+ >>> p.topics
+ ['zero defect', 'coherent software']
  """
 
  pattern = re.compile(r'(?P<name>\S+)\s*(?P<rest>.*)$')
  tags: list[str] = []
 
- def __new__(self, value, **kwargs):
- return super().__new__(self, value)
+ @functools.lru_cache
+ def __new__(cls, value, **kwargs):
+ return super().__new__(cls, value)
 
  def __init__(self, value, **kwargs):
- vars(self).update(kwargs)
+ vars(self).update({'topics': [], **kwargs})
 
  @classmethod
  def parse(cls, line):
  match = types.SimpleNamespace(**cls.pattern.match(line).groupdict())
- tags = list(re.findall(r'\[(.*?)\]', match.rest))
- return cls(match.name, tags=tags)
+ tags = list(re.findall(r'\[(.*?)\]', rest := match.rest.rstrip()))
+ topics_assigned = re.match(r'[^\(\)]*\((.+)\)$', rest)
+ topics = topics_assigned and map(str.strip, topics_assigned.group(1).split(','))
+ return cls(match.name, tags=tags, topics=list(filter(None, topics or ())))
+
+ @classmethod
+ def from_path(self, path):
+ """
+ >>> Project.from_path('pypa/setuptools')
+ '/pypa/setuptools'
+ >>> Project.from_path('jaraco/jaraco.functools')
+ 'jaraco.functools'
+ """
+ from . import github
+ local = f'{github.username()}/'
+ if path.startswith(local):
+ return self(path.removeprefix(local))
+ return self(f'/{path.removeprefix("/")}')
+
+ @property
+ def rtd_slug(self):
+ """
+ >>> Project('jaraco.functools').rtd_slug
+ 'jaracofunctools'
+ >>> Project('/pypa/setuptools_scm').rtd_slug
+ 'setuptools-scm'
+ """
+ return posixpath.basename(self).replace('.', '').replace('_', '-')
+
+ @property
+ def rtd_url(self):
+ """
+ >>> Project('jaraco.functools').rtd_url
+ 'https://jaracofunctools.readthedocs.io/'
+ >>> Project('/pypa/setuptools_scm').rtd_url
+ 'https://setuptools-scm.readthedocs.io/'
+ """
+ return f'https://{self.rtd_slug}.readthedocs.io/'
 
  @property
  def spec(self):
@@ -146,10 +183,21 @@ def resolve(name):
  >>> 'gh://pmxbot/pmxbot.nsfw' in projects
  True
  """
+ from . import github
  default = URL(f'https://github.com/{github.username()}/')
  return default.join(name)
 
 
+def resolve_repo_name(name):
+ """
+ >>> resolve_repo_name('keyring')
+ 'jaraco/keyring'
+ >>> resolve_repo_name('/pypa/setuptools')
+ 'pypa/setuptools'
+ """
+ return resolve(name).path.removeprefix(posixpath.sep)
+
+
 def target_for_root(project, root: path.Path = path.Path()):
  """
  Append the prefix of the resolved project name to the target
@@ -239,7 +287,8 @@ def checkout_missing(project, root):
 
 @contextlib.contextmanager
 def temp_checkout(project, **kwargs):
+ kwargs.setdefault("depth", 50)
  with path.TempDir() as dir:
- repo = checkout(project, dir, depth=50, **kwargs)
+ repo = checkout(project, dir, **kwargs)
  with repo:
  yield

jaraco/develop/github.py

@@ -4,13 +4,15 @@
 import functools
 import re
 import pathlib
+import posixpath
 import itertools
 
 import keyring
 import nacl.public
 import nacl.encoding
 from requests_toolbelt import sessions
 
+from . import git
 from . import repo
 
 
@@ -22,6 +24,10 @@ class Repo(str):
  def __init__(self, name):
  self.session = self.get_session()
 
+ @property
+ def url(self):
+ return f'https://github.com/{self}'
+
  @classmethod
  @functools.lru_cache()
  def get_session(cls):
@@ -42,8 +48,15 @@ def load_token():
  return token
 
  @classmethod
- def detect(cls):
- return cls(repo.get_project_metadata().project)
+ def from_project(cls, project, *, upstream=False):
+ if 'fork' in project.tags and not upstream:
+ return cls(posixpath.sep.join((username(), posixpath.basename(project))))
+ return cls(git.resolve_repo_name(project))
+
+ @classmethod
+ def detect(cls, *, upstream=False):
+ project = git.Project.from_path(repo.get_project_metadata().project)
+ return cls.from_project(project, upstream=upstream)
 
  @functools.lru_cache()
  def get_public_key(self):
@@ -94,6 +107,67 @@ def find_secrets(file):
  )
  )
 
+ def get_metadata(self):
+ """
+ Get repository metadata.
+
+ https://docs.github.com/en/rest/repos/repos?apiVersion=2022-11-28#get-a-repository
+
+ >>> Repo('jaraco/pip-run').get_metadata()['description']
+ 'pip-run - dynamic dependency loader for Python'
+ """
+ resp = self.session.get(self)
+ resp.raise_for_status()
+ return resp.json()
+
+ def update_metadata(self, **kwargs):
+ """
+ Update repository metadata (without overwriting existing keys).
+
+ Some useful metadata keys:
+ - name (str)
+ - description (str)
+ - homepage (str)
+ - visibility ("public" or "private")
+ - has_issues (bool)
+ - default_branch (str)
+ - archived (bool)
+ - allow_forking (bool)
+
+ See docs for all of them: https://docs.github.com/en/rest/repos/repos?apiVersion=2022-11-28#update-a-repository--parameters
+
+ >>> Repo('jaraco/dead-parrot').update_metadata( # doctest: +SKIP
+ ... description="It's no more",
+ ... homepage='https://youtu.be/4vuW6tQ0218',
+ ... )
+ <Response [200]>
+ """
+ resp = self.session.patch(self, json=kwargs)
+ resp.raise_for_status()
+ return resp
+
+ def get_topics(self):
+ """
+ Get topics for the repository.
+
+ >>> Repo('jaraco/irc').get_topics()
+ ['irc', 'python']
+ """
+ resp = self.session.get(f'{self}/topics')
+ resp.raise_for_status()
+ return resp.json()['names']
+
+ def set_topics(self, *topics):
+ """Completely replace the existing topics with only the given ones."""
+ names = list(map(str.lower, (topic.replace(' ', '-') for topic in topics)))
+ resp = self.session.put(f'{self}/topics', json=dict(names=names))
+ resp.raise_for_status()
+ return resp
+
+ def add_topics(self, *topics):
+ """Add new topics to the repository, without removing existing ones."""
+ return self.set_topics(*self.get_topics(), *topics)
+
 
 def username():
  return os.environ.get('GITHUB_USERNAME') or getpass.getuser()

jaraco/develop/repo.py

@@ -12,6 +12,7 @@ def get_project_metadata():
  version = _md['Version']
  project = urllib.parse.urlparse(url).path.strip('/')
  name = _md['Name']
+ summary = _md.get('Summary')
  return types.SimpleNamespace(**locals())
 
 

jaraco/develop/rtd.py

@@ -15,6 +15,12 @@ def session():
  return session
 
 
+def rtd_exists(project):
+ return session().head(f'projects/{project.rtd_slug}/').ok
+
+
 def enable_pr_build(project):
- slug = project.replace('.', '').replace('_', '-')
- session().patch(f'projects/{slug}/', data=dict(external_builds_enabled=True))
+ session().patch(
+ f'projects/{project.rtd_slug}/',
+ data=dict(external_builds_enabled=True),
+ )

jaraco/develop/sync-github.py

@@ -0,0 +1,44 @@
+"""
+Sync GitHub metadata repo across all projects.
+
+Metadata includes description, homepage (RTD docs if available) and topics.
+"""
+
+import autocommand
+
+from . import filters
+from . import git
+from . import github
+from . import repo
+from . import rtd
+
+
+@autocommand.autocommand(__name__)
+def main(
+ keyword: filters.Keyword = None, # type: ignore
+ tag: filters.Tag = None, # type: ignore
+):
+ for project in filter(tag, filter(keyword, git.projects())):
+ with git.temp_checkout(project, depth=1):
+ md = repo.get_project_metadata()
+ gh = github.Repo.from_project(project)
+ gh_metadata = gh.get_metadata()
+ # https://github.com/jaraco/pytest-perf/issues/10#issuecomment-1913669951
+ # homepage = md.homepage
+ homepage = (
+ gh_metadata.get('homepage')
+ or (project.rtd_url if rtd.rtd_exists(project) else None)
+ )
+ description = gh_metadata.get('description') or md.summary
+ print(f'\n[Metadata for {gh}]')
+ print('Homepage:', homepage)
+ print('Description:', description)
+ print('Topics:', ', '.join(project.topics))
+ gh.update_metadata(
+ homepage=homepage,
+ description=description,
+ )
+ print('\nUpdated metadata.')
+ gh.add_topics(*project.topics)
+ print('Added topics.\n')
+ print(gh.url)