pygitpub 0.0.58__tar.gz → 0.0.59__tar.gz

{pygitpub-0.0.58 → pygitpub-0.0.59}/.gitignore

@@ -4,11 +4,16 @@
 /dist/
 /target/
 /out/
+/debug/
+/download/
 *.out
 /.mypy_cache/
+/.ruff_cache/
+/.rumdl_cache/
 
 # folders to git ignore
 /*.gi
+/gi/
 
 # gems
 /gems/
@@ -33,6 +38,8 @@ lib*.so.*
 *.gch
 *.pchi
 *.gcda
+*.map
+*.bin
 
 # kernel stuff
 *.ko
@@ -59,6 +66,9 @@ modules.order
 /docs/_build/
 /docs/.doctrees/environment.pickle
 
+# mdBook build output
+/docs/book/
+
 # installations
 /external/
 /install/
@@ -67,6 +77,8 @@ modules.order
 # python
 __pycache__/
 *.py[oc]
+*.pyc
+*.pyo
 /wheel/
 /.venv/
 .coverage
@@ -110,11 +122,15 @@ node_modules/
 # haskell
 *.hi
 
+# clojure
+.cpcache/
+
 # repositries of deb packages
 /deb/mypackage/DEBIAN/control
 
 # generic
 *.log
+*.swp
 
 # scons
 .sconsign.dblite
@@ -133,6 +149,16 @@ build/
 # c#
 **/obj/
 **/bin/
+[Oo]bj/
+[Bb]in/
+
+# flash/air
+*.swf
+*.air
+*.apk
+*.ipa
+bin-debug/
+bin-release/
 
 # vscode
 .vscode/
@@ -144,10 +170,12 @@ build/
 # jetbrains and eclipse
 .cache
 .settings
+.settings/
 .classpath
 .project
 .project.xml
 .idea/
+/.idea/
 build.properties
 
 # spark
@@ -155,9 +183,62 @@ spark-warehouse/
 
 # terraform
 .terraform*
+/.terraform/
 terraform.tfstate
 terraform.tfstate.backup
+/terraform.tfstate
+/terraform.tfstate.backup
+/terraform.lock.hcl
 
 # scala
 target/
 project/
+
+# rust
+**/*.rs.bk
+**/mutants.out*/
+*.pdb
+debug
+/.rsconstruct_cache.json
+
+# claude
+/.claude/
+claude/
+.claude/projects/
+.claude/settings.local.json
+
+# static sites
+/_site/
+/public/
+/media/
+/static/build_info.toml
+/static/shared-themes/
+/build_info.json
+
+# manim
+/.manim_scratch/
+
+# terms
+/terms.ambiguous/
+/terms.single_meaning/
+
+# stm32 demos
+/STM32CubeWL/
+/exercises/*/*/.obj/
+/exercises/*/*/app*.elf
+/exercises/*/*/app*.map
+/exercises/*/*/firmware*.bin
+/exercises/common/.hal_obj_cm0/
+/exercises/common/.hal_obj_cm4/
+/exercises/common/.rsc_hal_obj_cm0/
+/exercises/common/.rsc_hal_obj_cm4/
+/exercises/common/libhal_cm0.a
+/exercises/common/libhal_cm4.a
+/exercises/common/libhal_rsc_cm0.a
+/exercises/common/libhal_rsc_cm4.a
+
+# secrets
+creds.txt
+
+# rsconstruct
+/.rsconstruct/

{pygitpub-0.0.58 → pygitpub-0.0.59}/LICENSE

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2022 Mark Veltzer
+Copyright (c) 2026 Mark Veltzer <mark.veltzer@gmail.com>
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

{pygitpub-0.0.58 → pygitpub-0.0.59}/PKG-INFO

@@ -1,6 +1,6 @@
-Metadata-Version: 2.4
+Metadata-Version: 2.5
 Name: pygitpub
-Version: 0.0.58
+Version: 0.0.59
 Summary: Pygitpub will help you work with github
 Project-URL: Homepage, https://github.com/veltzer/pygitpub
 Project-URL: Bug Tracker, https://github.com/veltzer/pygitpub/issues
@@ -37,7 +37,7 @@ project website: https://veltzer.github.io/pygitpub
 
 author: Mark Veltzer
 
-version: 0.0.58
+version: 0.0.59
 
 ![Code style: black](https://img.shields.io/badge/code%20style-black-000000.svg)
 
@@ -63,12 +63,11 @@ version: 0.0.58
 ![PyPI - Downloads](https://img.shields.io/pypi/dw/pygitpub)
 ![PyPI - Downloads](https://img.shields.io/pypi/dm/pygitpub)
 
-
-
 ## contact me
+
 [mailto](mailto:mark.veltzer@gmail.com)
 ![gitter](https://img.shields.io/gitter/room/veltzer/mark.veltzer)
 ![discord](https://img.shields.io/discord/719336281624281119)
 ![discord](https://img.shields.io/discord/719336282194444302)
 
-Mark Veltzer, Copyright © 2022, 2023, 2024, 2025
+Mark Veltzer, Copyright © 2022, 2023, 2024, 2025, 2026

{pygitpub-0.0.58 → pygitpub-0.0.59}/README.md

@@ -6,7 +6,7 @@ project website: https://veltzer.github.io/pygitpub
 
 author: Mark Veltzer
 
-version: 0.0.58
+version: 0.0.59
 
 ![Code style: black](https://img.shields.io/badge/code%20style-black-000000.svg)
 
@@ -32,12 +32,11 @@ version: 0.0.58
 ![PyPI - Downloads](https://img.shields.io/pypi/dw/pygitpub)
 ![PyPI - Downloads](https://img.shields.io/pypi/dm/pygitpub)
 
-
-
 ## contact me
+
 [mailto](mailto:mark.veltzer@gmail.com)
 ![gitter](https://img.shields.io/gitter/room/veltzer/mark.veltzer)
 ![discord](https://img.shields.io/discord/719336281624281119)
 ![discord](https://img.shields.io/discord/719336282194444302)
 
-Mark Veltzer, Copyright © 2022, 2023, 2024, 2025
+Mark Veltzer, Copyright © 2022, 2023, 2024, 2025, 2026

{pygitpub-0.0.58 → pygitpub-0.0.59}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "hatchling.build"
 
 [project]
 name = "pygitpub"
-version = "0.0.58"
+version = "0.0.59"
 requires-python = ">=3.12"
 authors = [
 	{ name = "Mark Veltzer", email = "mark.veltzer@gmail.com" }

{pygitpub-0.0.58 → pygitpub-0.0.59}/src/pygitpub/configs.py

@@ -3,6 +3,14 @@ All configurations for pygitpub
 """
 from pytconf import Config, ParamCreator
 
+# The values github accepts in the "affiliation" parameter of its
+# "list repositories" api. They are sent over the wire verbatim.
+AFFILIATIONS = [
+    "owner",
+    "collaborator",
+    "organization_member",
+]
+
 
 class ConfigGithub(Config):
     """
@@ -40,10 +48,19 @@ class ConfigAlgo(Config):
         help_string="Only include repos owned by this owner (None for dont mind)",
         default=None,
     )
+    affiliation = ParamCreator.create_str(
+        help_string="Comma separated list of how you are affiliated with the repos to work on"
+                    f" (any of {','.join(AFFILIATIONS)})",
+        default="owner",
+    )
     show_extra = ParamCreator.create_bool(
         help_string="Show extra git repos lying around?",
         default=True,
     )
+    base_dir = ParamCreator.create_str(
+        help_string="Base directory under which repos are cloned",
+        default="~/git",
+    )
 
 
 class ConfigOutput(Config):

{pygitpub-0.0.58 → pygitpub-0.0.59}/src/pygitpub/main.py

@@ -2,26 +2,51 @@
 main entry point to the program
 """
 
+import json
 import os
 import subprocess
 import sys
-import json
-
-import pylogconf.core
-from pytconf import register_main, config_arg_parse_and_launch, register_endpoint
 
 import github
 import pyapikey
-from pygitpub.configs import ConfigGithub, ConfigOutput, ConfigAlgo
+import pylogconf.core
+from pytconf import config_arg_parse_and_launch, register_endpoint, register_main
+from pytconf.pydoc import get_first_line
+from pytconf.registry import the_registry
+
 import pygitpub.static
-from pygitpub.utils.misc import delete, get_all_git_repos
+from pygitpub.configs import AFFILIATIONS, ConfigAlgo, ConfigGithub, ConfigOutput
 from pygitpub.utils.importlib import import_file
+from pygitpub.utils.misc import delete, get_all_git_repos
+
+
+def get_base_dir() -> str:
+    return os.path.expanduser(ConfigAlgo.base_dir)
+
+
+def get_repo_folder(repo) -> str:
+    return os.path.join(get_base_dir(), repo.name)
+
+
+def get_affiliation() -> str:
+    """ validate the affiliation parameter and return it in the form github wants """
+    values = [x.strip() for x in ConfigAlgo.affiliation.split(",")]
+    values = [x for x in values if x != ""]
+    if not values:
+        raise ValueError("affiliation must not be empty")
+    for value in values:
+        if value not in AFFILIATIONS:
+            raise ValueError(f"bad affiliation [{value}], must be one of [{','.join(AFFILIATIONS)}]")
+    return ",".join(values)
 
 
 def yield_repos():
     apikey = pyapikey.get_key(ConfigGithub.apikey)
     g = github.Github(login_or_token=apikey)
-    for repo in g.get_user().get_repos():
+    # github filters by affiliation server side, so repos we are not interested
+    # in (org repos, by default) are never fetched in the first place
+    affiliation = get_affiliation()
+    for repo in g.get_user().get_repos(affiliation=affiliation):
         reason = "no reason set"
         skip = False
         if not ConfigAlgo.fork and repo.fork:
@@ -53,8 +78,7 @@ def yield_repos():
 def fix_metadata() -> None:
     orig_folder = os.getcwd()
     for repo in yield_repos():
-        owner = repo.owner.login
-        folder = os.path.join(owner, repo.name)
+        folder = get_repo_folder(repo)
         if not os.path.isdir(folder):
             # print(f"folder [{folder}] does not exist, continuing...")
             continue
@@ -68,7 +92,7 @@ def fix_metadata() -> None:
         if not hasattr(mod, "description_short"):
             os.chdir(orig_folder)
             continue
-        description_short = getattr(mod, "description_short")
+        description_short = mod.description_short
         if description_short != repo.description:
             print(f"in {folder}...")
             print(f"description_short is [{description_short}]")
@@ -78,7 +102,7 @@ def fix_metadata() -> None:
             print(f"{folder} no keywords")
             os.chdir(orig_folder)
             continue
-        keywords = getattr(mod, "keywords")
+        keywords = mod.keywords
         if set(keywords) != set(repo.get_topics()):
             print(f"in {folder}...")
             print(f"keywords is [{keywords}]")
@@ -273,14 +297,15 @@ def runs_show_not_success() -> None:
     description="Pull all projects from github",
     configs=[
         ConfigGithub,
+        ConfigAlgo,
     ],
 )
 def pull_all() -> None:
     orig_folder = os.getcwd()
+    base_dir = get_base_dir()
     for repo in yield_repos():
-        owner = repo.owner.login
         project = repo.name
-        folder = os.path.join(owner, repo.name)
+        folder = get_repo_folder(repo)
         if os.path.isdir(folder):
             if not os.path.isfile(os.path.join(folder, ".skip")):
                 print(f"project [{project}] exists, pulling it...")
@@ -296,13 +321,15 @@ def pull_all() -> None:
             else:
                 print(f"project [{project}] exists, skipping it because of .skip file...")
         else:
-            print(f"project [{project}] does not exists, cloning it from [{repo.ssh_url}]...")
+            print(f"project [{project}] does not exists, cloning it from [{repo.ssh_url}] to [{folder}]...")
+            os.makedirs(base_dir, exist_ok=True)
             subprocess.check_call(
                 [
                     "git",
                     "clone",
                     repo.ssh_url,
-                ]
+                ],
+                cwd=base_dir,
             )
 
 
@@ -315,10 +342,10 @@ def pull_all() -> None:
 )
 def clone_all() -> None:
     all_repo_folders = set()
+    base_dir = get_base_dir()
     for repo in yield_repos():
-        owner = repo.owner.login
         project = repo.name
-        folder = os.path.join(owner, repo.name)
+        folder = get_repo_folder(repo)
         all_repo_folders.add(folder)
         # print(f"considering [{project}] from [{repo.ssh_url}]...")
         if os.path.isfile(folder):
@@ -329,21 +356,20 @@ def clone_all() -> None:
             continue
         if ConfigAlgo.dryrun:
             continue
-        print(f"cloning [{owner}:{project}] from [{repo.ssh_url}] to [{folder}]")
-        if not os.path.isdir(owner):
-            os.mkdir(owner)
+        print(f"cloning [{project}] from [{repo.ssh_url}] to [{folder}]")
+        os.makedirs(base_dir, exist_ok=True)
         subprocess.check_call(
             [
                 "git",
                 "clone",
                 repo.ssh_url,
             ],
-            cwd=owner,
+            cwd=base_dir,
             stdout=subprocess.DEVNULL,
             stderr=subprocess.DEVNULL,
         )
     if ConfigAlgo.show_extra:
-        disk_repos = get_all_git_repos()
+        disk_repos = get_all_git_repos(base_dir)
         extra_repos = disk_repos - all_repo_folders
         if extra_repos:
             print("extra repos follow:")
@@ -368,6 +394,34 @@ def workflows_run() -> None:
             print(f"{ret}")
 
 
+@register_endpoint(
+    description="Show all configuration options and their current values",
+    configs=[
+        ConfigGithub,
+        ConfigAlgo,
+        ConfigOutput,
+    ],
+)
+def config() -> None:
+    for config_class in [ConfigGithub, ConfigAlgo, ConfigOutput]:
+        print(f"{config_class.__name__}: {get_first_line(config_class, 'undocumented')}")
+        for name, param in the_registry.yield_name_data_for_config(config_class):
+            value = getattr(config_class, name)
+            if param.required and value is param.default:
+                value_str = "MANDATORY (not set)"
+            else:
+                value_str = param.t2s(value)
+            print(f"    {name} [{param.get_type_name()}]: {value_str}")
+            print(f"        {param.help_string}")
+            if not param.required:
+                print(f"        default: {param.t2s(param.default)}")
+            more_help = param.more_help()
+            if more_help is not None:
+                print(f"        {more_help}")
+        print()
+    print(f"repos are cloned to and pulled from: {get_base_dir()}/<repo-name>")
+
+
 @register_main(
     main_description=pygitpub.static.DESCRIPTION,
     app_name=pygitpub.static.APP_NAME,

{pygitpub-0.0.58 → pygitpub-0.0.59}/src/pygitpub/static.py

@@ -1,5 +1,5 @@
 """ version which can be consumed from within the module """
-VERSION_STR = "0.0.58"
+VERSION_STR = "0.0.59"
 DESCRIPTION = "Pygitpub will help you work with github"
 APP_NAME = "pygitpub"
 LOGGER_NAME = "pygitpub"

{pygitpub-0.0.58 → pygitpub-0.0.59}/src/pygitpub/utils/misc.py

@@ -1,9 +1,9 @@
 """ misc.py """
 
+import glob
 import logging
 import os
 import os.path
-import glob
 
 from pygitpub import LOGGER_NAME
 
@@ -28,8 +28,8 @@ def delete(workflow_run):
     return status == 204
 
 
-def get_all_git_repos() -> set[str]:
-    """ we use */*/.git here with recursive=False (which is the default)
+def get_all_git_repos(base_dir: str) -> set[str]:
+    """ we use */.git under base_dir with recursive=False (which is the default)
     because otherwise we would find submodules too
     """
-    return {os.path.dirname(x) for x in glob.glob("*/*/.git")}
+    return {os.path.dirname(x) for x in glob.glob(os.path.join(base_dir, "*/.git"))}