baldwin 0.0.1__py3-none-any.whl

baldwin/__init__.py

@@ -0,0 +1,2 @@
+"""Manage a home directory with Git."""
+__version__ = '0.0.1'

baldwin/main.py

@@ -0,0 +1,143 @@
+from datetime import UTC, datetime
+from importlib import resources
+from pathlib import Path
+from shlex import quote
+from shutil import which
+import logging
+import os
+import subprocess as sp
+
+from binaryornot.check import is_binary
+from git import Actor, Repo
+import click
+
+from .utils import format_, get_git_path, get_repo
+
+log = logging.getLogger(__name__)
+
+__all__ = ('baldwin_main', 'git')
+
+
+@click.group(context_settings={'help_option_names': ('-h', '--help')})
+@click.option('-d', '--debug', help='Enable debug logging.', is_flag=True)
+def baldwin_main(*, debug: bool = False) -> None:
+    """Manage a home directory with Git."""
+    os.environ['GIT_DIR'] = str(get_git_path())
+    os.environ['GIT_WORK_TREE'] = str(Path.home())
+    logging.basicConfig(level=logging.DEBUG if debug else logging.ERROR)
+
+
+@click.command(context_settings={
+    'help_option_names': ('-h', '--help'),
+    'ignore_unknown_options': True
+})
+@click.argument('args', nargs=-1, type=click.UNPROCESSED)
+def git(args: tuple[str, ...]) -> None:
+    # Pass these arguments because of the hgit shortcut
+    cmd = ('git', f'--git-dir={get_git_path()}', f'--work-tree={Path.home()}', *args)
+    log.debug('Running: %s', ' '.join(quote(x) for x in cmd))
+    sp.run(cmd, check=False)  # do not use env= because env vars controlling colour will be lost
+
+
+@click.command(context_settings={'help_option_names': ('-h', '--help')})
+def init() -> None:
+    """Start tracking a home directory."""
+    git_path = get_git_path()
+    if not git_path.exists():
+        repo = Repo.init(git_path, expand_vars=False)
+        repo.git.execute(('git', 'config', 'commit.gpgsign', 'false'))
+        gitattributes = Path.home() / '.gitattributes'
+        gitattributes.write_text(
+            resources.read_text('baldwin.resources', 'default_gitattributes.txt'))
+        gitignore = Path.home() / '.gitignore'
+        gitignore.write_text(resources.read_text('baldwin.resources', 'default_gitignore.txt'))
+        repo.index.add([gitattributes, gitignore])
+        if which('jq'):
+            repo.git.execute(('git', 'config', 'diff.json.textconv', 'jq -MS .'))
+            repo.git.execute(('git', 'config', 'diff.json.cachetextconv', 'true'))
+        if (prettier := which('prettier')):
+            node_modules_path = (Path(prettier).resolve(strict=True).parent / '..' /
+                                 '..').resolve(strict=True)
+            if (node_modules_path / '@prettier/plugin-xml/src/plugin.js').exists():
+                repo.git.execute(
+                    ('git', 'config', 'diff.xml.textconv',
+                     'prettier --no-editorconfig --parser xml --xml-whitespace-sensitivity ignore'))
+                repo.git.execute(('git', 'config', 'diff.xml.cachetextconv', 'true'))
+            repo.git.execute(
+                ('git', 'config', 'diff.yaml.textconv', 'prettier --no-editorconfig --parser yaml'))
+            repo.git.execute(('git', 'config', 'diff.yaml.cachetextconv', 'true'))
+
+
+@click.command(context_settings={'help_option_names': ('-h', '--help')})
+def auto_commit() -> None:
+    """Automatic commit of changed and untracked files."""
+    repo = get_repo()
+    items_to_add = [
+        *[Path.home() / e.a_path for e in repo.index.diff(None)], *[
+            x for x in (Path.home() / y
+                        for y in repo.untracked_files) if x.is_file() and not is_binary(str(x))
+        ]
+    ]
+    format_(items_to_add)
+    repo.index.add(items_to_add)
+    repo.index.commit(f'Automatic commit @ {datetime.now(tz=UTC).isoformat()}',
+                      committer=Actor('Auto-commiter', 'hgit@tat.sh'))
+
+
+@click.command(context_settings={'help_option_names': ('-h', '--help')})
+def format_main() -> None:
+    """Format changed and untracked files."""
+    repo = get_repo()
+    format_(
+        (*(Path.home() / d.a_path for d in repo.index.diff(None)),
+         *(x for x in (Path.home() / y
+                       for y in repo.untracked_files) if x.is_file() and not is_binary(str(x)))))
+
+
+@click.command(context_settings={'help_option_names': ('-h', '--help')})
+def info() -> None:
+    """Get basic information about the repository."""
+    click.echo(f'git-dir path: {get_git_path()}')
+    click.echo(f'work-tree path: {Path.home()}')
+
+
+@click.command(context_settings={'help_option_names': ('-h', '--help')})
+def install_units() -> None:
+    """Install systemd units for automatic committing."""
+    bw = which('bw')
+    assert bw is not None
+    bw_p = Path(bw).resolve(strict=True)
+    service_file = Path('~/.config/systemd/user/home-vcs.service').expanduser()
+    service_file.write_text(f"""[Unit]
+Description=Home directory VCS commit
+
+[Service]
+Type=oneshot
+ExecStart={bw_p} auto-commit
+""")
+    log.debug('Wrote to `%s`.', service_file)
+    timer_file = Path('~/.config/systemd/user/home-vcs.timer').expanduser()
+    timer_file.write_text("""[Unit]
+Description=Hexahourly trigger for Home directory VCS
+
+[Timer]
+OnCalendar=0/6:0:00
+
+[Install]
+WantedBy=timers.target
+""")
+    log.debug('Wrote to `%s`.', timer_file)
+    cmd: tuple[str, ...] = ('systemctl', '--user', 'enable', '--now', 'home-vcs.timer')
+    log.debug('Running: %s', ' '.join(quote(x) for x in cmd))
+    sp.run(cmd, check=True)
+    cmd = ('systemctl', '--user', 'daemon-reload')
+    log.debug('Running: %s', ' '.join(quote(x) for x in cmd))
+    sp.run(('systemctl', '--user', 'daemon-reload'), check=True)
+
+
+baldwin_main.add_command(auto_commit, 'auto-commit')
+baldwin_main.add_command(format_main, 'format')
+baldwin_main.add_command(git)
+baldwin_main.add_command(info)
+baldwin_main.add_command(init)
+baldwin_main.add_command(install_units)

baldwin/resources/default_gitattributes.txt

@@ -0,0 +1,30 @@
+*.json diff=json
+*.knsregistry diff=xml
+*.rdf diff=xml
+*.sgrd diff=xml
+*.xml diff=xml
+*.xml-prev diff=xml
+*.yaml diff=yaml
+*.yml diff=yaml
+.charles.config diff=xml
+.config/**/Bookmarks diff=json
+.config/**/Local*State diff=json
+.config/**/Network*State diff=json
+.config/**/Preferences diff=json
+.config/**/Secure*Preferences diff=json
+.config/**/TransportSecurity diff=json
+.config/fontconfig/conf.*/*.conf diff=xml
+.config/libreoffice/**/*.so* diff=xml
+.config/libreoffice/**/*.xba diff=xml
+.config/libreoffice/**/*.xcu diff=xml
+.config/libreoffice/**/*.xl* diff=xml
+.config/menus/applications-merged/**/*.menu diff=xml
+.config/skypeforlinux/**/*.conf diff=json
+.config/skypeforlinux/SkypeRT/ul.conf diff=txt
+.config/unity3d/**/prefs diff=xml
+.config/unity3d/global.prefs diff=xml
+.designer/**/*.br diff=xml
+.local/share/DBeaverData/**/*.xmi diff=xml
+.local/share/DBeaverData/**/.project diff=xml
+.local/share/kxmlgui5/**/*.rc diff=xml
+.mozilla/firefox/**/sessionstore.js diff=json

baldwin/resources/default_gitignore.txt

@@ -0,0 +1,166 @@
+
+!/.dosbox/*.conf
+!/.eclipse/org.jkiss.dbeaver.product*/config.ini
+!/.vscode/argv.json
+!/.vscode/extensions/.init-default-profile-extensions
+!/.vscode/extensions/.obsolete
+!/.vscode/extensions/extensions.json
+*-shm
+*-wal
+*.DLL
+*.EXE
+*.apk
+*.bak
+*.bdic
+*.bin
+*.bmp
+*.corrupt
+*.db
+*.dll
+*.dylib
+*.egg
+*.exe
+*.gif
+*.ics
+*.jar
+*.jsonlz4
+*.kwl
+*.localstorage*
+*.lock
+*.lockfile
+*.log
+*.lz4
+*.mcd
+*.mdf
+*.mscz
+*.msf
+*.odt
+*.old
+*.ovpn
+*.pem
+*.pickle
+*.pid
+*.pmap
+*.pyc
+*.pyd
+*.qch*
+*.qhc
+*.retry
+*.ripdb*
+*.so
+*.sqlite*
+*.sqlite-journal
+*.srm
+*.tar.gz
+*.tga
+*.tmp
+*.ttf
+*.zip
+.directory
+.lock
+.parentlock
+/.F5Networks/*.log
+/.MakeMKV/**/*.svq
+/.MakeMKV/**/*.tgz
+/.MakeMKV/*.tar
+/.Trash-*
+/.VirtualBox/**/*.dat
+/.VirtualBox/**/*.log*
+/.VirtualBox/**/*.xml-prev
+/.VirtualBox/Machines/
+/.acetoneiso/poweriso
+/.android/adb.*
+/.android/adbkey*
+/.android/avd/
+/.android/cache/
+/.android/debug.*
+/.audacity-data/AutoSave/
+/.audacity-data/lastlog.txt
+/.aws/credentials
+/.bitcoin/**/*.dat
+/.bitcoin/**/*lock
+/.bitcoin/blocks/
+/.bitcoin/chainstate/
+/.bitcoin/database/
+/.bitcoin/wallets/
+/.cabal/bin/
+/.cabal/packages/
+/.cabal/store/
+/.cargo/
+/.charles/ca/
+/.charles/certs/
+/.charles/passwords.keystore
+/.cmake/packages/
+/.composer
+/.conan2/extensions/
+/.conan2/p/
+/.conan2/profiles/
+/.conan2/remotes.json
+/.conan2/version.txt
+/.config/**/*.lock
+/.config/**/.org.chromium*
+/.config/**/GPUCache/
+/.config/**/buildid
+/.config/*/*-journal
+/.config/*/Cookies*
+/.config/*/QuotaManager
+/.config/*/SS
+/.config/*/Singleton*
+/.config/*/databases/
+/.config/*cli/history
+/.config/*cli/log
+/.config/Code*/**/meta.json
+/.config/Code*/*Crash Reports/
+/.config/Code*/Backups/
+/.config/Code*/Cache*/
+/.config/Code*/Code Cache/
+/.config/Code*/Cookies*
+/.config/Code*/IndexedDB/
+/.config/Code*/Local Storage/
+/.config/Code*/Network Persistent State
+/.config/Code*/QuotaManager*
+/.config/Code*/Session Storage/
+/.config/Code*/Session Storage/LOG
+/.config/Code*/User/globalStorage/
+/.config/Code*/User/sync/**/20*.json
+/.config/Code*/User/workspaceStorage/
+/.config/Code*/databases/
+/.config/Code*/languagepacks.json
+/.config/Code*/machineid
+/.config/Code*/storage.json
+/.config/Code/Crashpad/
+/.config/Code/DawnCache/
+/.config/Code/DawnGraphiteCache/
+/.config/Code/DawnWebGPUCache/
+/.config/Code/Service Worker/
+/.config/Code/Shared Dictionary/
+/.config/Code/SharedStorage
+/.config/Code/Trust Tokens
+/.config/Code/Trust Tokenss
+/.config/Code/User/History/
+/.config/Code/User/profiles/*/globalStorage/
+/.config/Code/User/sync/
+/.config/Code/WebStorage/
+/.config/Code/fileWatcher/
+/.config/Code/logs/
+/.config/Code/watcherServiceParcelSharedProcess/
+/.config/OpenRCT2/*logs/
+/.config/OpenRCT2/chatlogs/
+/.config/OpenRCT2/object/
+/.config/OpenRCT2/serverlogs/
+/.config/PCSX2/bios/
+/.config/PCSX2/covers/
+/.config/PCSX2/logs/
+/.config/PCSX2/snaps/
+/.config/PCSX2/sstates/*.p2s
+/.config/Ryujinx/bis/
+/.config/Ryujinx/games/
+/.config/Ryujinx/mods/
+/.config/Ryujinx/sdcard/
+/.config/VirtualBox/**.log*
+/.viminfo
+/Desktop/
+/Documents/
+/Downloads/
+/go/
+node_modules

baldwin/resources/prettier.config.json

@@ -0,0 +1,22 @@
+{
+  "endOfLine": "lf",
+  "iniSpaceAroundEquals": true,
+  "jsonRecursiveSort": true,
+  "overrides": [
+    {
+      "files": ["Local State"],
+      "options": {
+        "parser": "json"
+      }
+    },
+    {
+      "files": [".config/k*rc", ".local/state/*rc"],
+      "options": {
+        "parser": "ini"
+      }
+    }
+  ],
+  "printWidth": 100,
+  "reorderKeys": true,
+  "singleQuote": true
+}

baldwin/utils.py

@@ -0,0 +1,67 @@
+from collections.abc import Iterable
+from importlib import resources
+from itertools import chain
+from pathlib import Path
+from shlex import quote
+from shutil import which
+import logging
+import subprocess as sp
+
+from git import Repo
+import platformdirs
+
+__all__ = ('format_', 'get_git_path', 'get_repo')
+
+log = logging.getLogger(__name__)
+
+
+def get_git_path() -> Path:
+    """
+    Get the bare Git directory (``GIT_DIR``).
+    
+    This path is platform-specific. On Windows, the Roaming AppData directory will be used.
+    """
+    return platformdirs.user_data_path('home-git', roaming=True)
+
+
+def get_repo() -> Repo:
+    """
+    Get a :py:class:`git.Repo` object.
+    
+    Also disables GPG signing for the repository.
+    """
+    repo = Repo(get_git_path(), expand_vars=False)
+    repo.git.execute(('git', 'config', 'commit.gpgsign', 'false'))
+    return repo
+
+
+def format_(filenames: Iterable[Path | str], log_level: str = 'error') -> None:
+    """
+    Format untracked and modified files in the repository.
+    
+    Does nothing if Prettier is not in ``PATH``.
+
+    The following plugins will be detected and enabled if found:
+    
+    * @prettier/plugin-xml
+    * prettier-plugin-ini
+    * prettier-plugin-sort-json
+    * prettier-plugin-toml
+    """
+    if not (filenames := list(filenames)):
+        return
+    with resources.path('baldwin.resources', 'prettier.config.json') as config_file:
+        if not (prettier := which('prettier')):
+            return
+        # Detect plugins
+        node_modules_path = (Path(prettier).resolve(strict=True).parent / '..' /
+                             '..').resolve(strict=True)
+        cmd = ('prettier', '--config', str(config_file), '--write',
+               '--no-error-on-unmatched-pattern', '--ignore-unknown', '--log-level', log_level,
+               *chain(*(('--plugin', str(fp)) for module in (
+                   '@prettier/plugin-xml/src/plugin.js', 'prettier-plugin-ini/src/plugin.js',
+                   'prettier-plugin-sort-json/dist/index.js', 'prettier-plugin-toml/lib/index.cjs')
+                        if (fp := (node_modules_path / module)).exists())), *(str(x)
+                                                                              for x in filenames))
+        log.debug('Running: %s', ' '.join(quote(x) for x in cmd))
+        sp.run(cmd, check=True)

baldwin-0.0.1.dist-info/METADATA

@@ -0,0 +1,134 @@
+Metadata-Version: 2.1
+Name: baldwin
+Version: 0.0.1
+Summary: Simple tracking of your home directory with easy-to-read diffs.
+Home-page: https://github.com/Tatsh/baldwin
+License: MIT
+Keywords: command line,file management,git,version control
+Author: Andrew Udvare
+Author-email: audvare@gmail.com
+Requires-Python: >=3.12,<4
+Classifier: Development Status :: 2 - Pre-Alpha
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Programming Language :: Python
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Typing :: Typed
+Requires-Dist: binaryornot (>=0.4.4,<0.5.0)
+Requires-Dist: click (>=8.1.7,<9.0.0)
+Requires-Dist: gitpython (>=3.1.43,<4.0.0)
+Requires-Dist: platformdirs (>=4.3.6,<5.0.0)
+Project-URL: Documentation, https://baldwin.readthedocs.org
+Project-URL: Issues, https://github.com/Tatsh/baldwin/issues
+Project-URL: Repository, https://github.com/Tatsh/baldwin
+Description-Content-Type: text/markdown
+
+# Simple home directory versioning
+
+This is a conversion of my simple scripts to version my home directory with very specific excludes
+and formatting every file upon commit so that readable diffs can be generated.
+
+## Installation
+
+```shell
+pip install baldwin
+```
+
+## Usage
+
+```plain
+ $ bw -h
+Usage: bw [OPTIONS] COMMAND [ARGS]...
+
+  Manage a home directory with Git.
+
+Options:
+  -d, --debug  Enable debug logging.
+  -h, --help   Show this message and exit.
+
+Commands:
+  auto-commit
+  format
+  git
+  info
+  init
+  install-units
+```
+
+In addition to the `bw` command, `hgit` is a shortcut for `bw git`.
+
+### Start a new repository
+
+```shell
+bw init
+```
+
+Find out where the bare Git directory is by running `bw info`. This can be done even if `init` has
+not been run.
+
+### Automation
+
+#### systemd
+
+```shell
+bw install-units
+```
+
+This will install a timer that will automatically make a new commit every 6 hours. It does not push.
+
+Keep in mind that systemd units require a full path to the executable, so you must keep the unit
+up-to-date if you move where you install this package. Simply run `bw install-units` again.
+
+Note that user systemd units only run while logged in.
+
+To disable and remove the units, use the following commands:
+
+```shell
+systemctl disable --now home-vcs.timer
+rm ~/.config/systemd/user/home-vcs.*
+```
+
+### Pushing
+
+To push, use either of the following:
+
+- `bw git push`
+- `hgit push`
+
+The above also demonstrates that `bw git`/`hgit` are just frontends to `git` with the correct
+environment applied.
+
+## Formatting
+
+If Prettier is installed, it will be used to format files. The configuration used comes with this
+package. Having consistent formatting allows for nice diffs to be generated.
+
+If you have initialised a repository without having `prettier` or `jq` in `PATH`, you need to run the
+following commands to enable readable diffs:
+
+```shell
+hgit config diff.json.textconv 'jq -MS .'
+hgit config diff.json.cachetextconv true
+hgit config diff.yaml.textconv 'prettier --no-editorconfig --parser yaml'
+hgit config diff.yaml.cachetextconv true
+```
+
+If you have the XML plugin installed:
+
+```shell
+hgit config diff.xml.textconv 'prettier --no-editorconfig --parser xml --xml-whitespace-sensitivity ignore'
+hgit config diff.xml.cachetextconv true
+```
+
+## Binary files
+
+Any file that is untracked and detected to be binary will not be added. Use `hgit add` to add a
+binary file manually.
+
+## Other details
+
+Default `.gitignore` and `.gitattributes` files are installed on initialisation. They are never
+modified by this tool. Please customise as necessary.
+

baldwin-0.0.1.dist-info/RECORD

@@ -0,0 +1,10 @@
+baldwin/__init__.py,sha256=paQL6NkltnuTQieOUMgQnzOOWTuxSXo5ztGywTkWvA8,62
+baldwin/main.py,sha256=AeDKsoVMVXzcyoCBx0vSVRsDZbcmwHY-iLCGZaeGMIo,5619
+baldwin/resources/default_gitattributes.txt,sha256=uGoWTSVgPmdGB2EUIROkTz3FikGpNGhdS95SuuvoCRo,984
+baldwin/resources/default_gitignore.txt,sha256=oyxukNyK6F778C2jc7oIwosP7ou1WTdbuWwkpgGZtJA,3022
+baldwin/resources/prettier.config.json,sha256=-Hher3B02YflULYn0IYOG_a-rDxpaaaQ0QXD30-5IgQ,387
+baldwin/utils.py,sha256=gOtDvylunSQoZ8QN8RvEeafPCw8Xn42vOflTMxciHtg,2330
+baldwin-0.0.1.dist-info/METADATA,sha256=bZyV63vjrEvAgEctu6edftMqO5fsUFNCCG8Nuan5TJg,3659
+baldwin-0.0.1.dist-info/WHEEL,sha256=Nq82e9rUAnEjt98J6MlVmMCZb-t9cYE2Ir1kpBmnWfs,88
+baldwin-0.0.1.dist-info/entry_points.txt,sha256=Whfij6CPUG0wuXRYWf3VGkluV1jV32ysrGFdlWjFy9o,70
+baldwin-0.0.1.dist-info/RECORD,,

baldwin-0.0.1.dist-info/WHEEL

@@ -0,0 +1,4 @@
+Wheel-Version: 1.0
+Generator: poetry-core 1.9.1
+Root-Is-Purelib: true
+Tag: py3-none-any

baldwin-0.0.1.dist-info/entry_points.txt

@@ -0,0 +1,4 @@
+[console_scripts]
+bw=baldwin.main:baldwin_main
+hgit=baldwin.main:git
+