baldwin 0.0.3__py3-none-any.whl → 0.0.5__py3-none-any.whl

baldwin/__init__.py

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

baldwin/lib.py

@@ -0,0 +1,193 @@
+"""Baldwin library."""
+from collections.abc import Iterable
+from dataclasses import dataclass
+from datetime import UTC, datetime
+from importlib import resources
+from itertools import chain
+from pathlib import Path
+from shlex import quote
+from shutil import which
+from typing import Literal
+import logging
+import os
+import subprocess as sp
+
+from binaryornot.check import is_binary
+from git import Actor, Repo
+import platformdirs
+
+log = logging.getLogger(__name__)
+
+
+def git(args: Iterable[str]) -> None:
+    """Front-end to git with git-dir and work-tree passed."""
+    # 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
+
+
+def init() -> None:
+    """
+    Start tracking a home directory.
+
+    Does nothing if the Git directory already exists.
+    """
+    if (git_path := get_git_path()).exists():
+        return
+    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 jq := which('jq'):
+        repo.git.execute(('git', 'config', 'diff.json.textconv', f'"{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',
+                f'"{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',
+                          f'"{prettier}" --no-editorconfig --parser yaml'))
+        repo.git.execute(('git', 'config', 'diff.yaml.cachetextconv', 'true'))
+
+
+def auto_commit() -> None:
+    """Automated commit of changed and untracked files."""
+    repo = get_repo()
+    diff_items = [Path.home() / e.a_path for e in repo.index.diff(None)]  # pragma: no cover
+    items_to_add = [
+        *[p for p in diff_items if p.exists()], *[
+            x for x in (Path.home() / y
+                        for y in repo.untracked_files) if x.is_file() and not is_binary(str(x))
+        ]
+    ]
+    items_to_remove = [p for p in diff_items if not p.exists()]  # pragma: no cover
+    if items_to_add:
+        format_(items_to_add)
+        repo.index.add(items_to_add)
+    if items_to_remove:
+        repo.index.remove(items_to_remove)
+    if items_to_add or items_to_remove:
+        repo.index.commit(f'Automatic commit @ {datetime.now(tz=UTC).isoformat()}',
+                          committer=Actor('Auto-commiter', 'hgit@tat.sh'))
+
+
+@dataclass
+class RepoInfo:
+    """General repository information."""
+    git_dir_path: Path
+    """Git directory."""
+    work_tree_path: Path
+    """Work tree."""
+
+
+def repo_info() -> RepoInfo:
+    """Get general repository information."""
+    return RepoInfo(git_dir_path=get_git_path(), work_tree_path=Path.home())
+
+
+def install_units() -> None:
+    """Install systemd units for automatic committing."""
+    bw = which('bw')
+    if not bw:
+        raise FileNotFoundError
+    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} 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)
+
+
+def get_git_path() -> Path:
+    """
+    Get the 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] | None = None,
+            log_level: Literal['silent', 'error', 'warn', 'log', 'debug'] = '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 filenames is None:
+        repo = get_repo()
+        filenames = (*(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))))
+    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_prefix = (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())))
+        for filename in filenames:
+            cmd = (*cmd_prefix, str(filename))
+            log.debug('Running: %s', ' '.join(quote(x) for x in cmd))
+            sp.run(cmd, check=False)
+
+
+def set_git_env_vars() -> None:
+    """Set environment variables for Git."""
+    os.environ['GIT_DIR'] = str(get_git_path())
+    os.environ['GIT_WORK_TREE'] = str(Path.home())

baldwin/main.py

@@ -1,29 +1,27 @@
-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
+from .lib import (
+    auto_commit,
+    format_,
+    git,
+    init,
+    install_units,
+    repo_info,
+    set_git_env_vars,
+)
 
 log = logging.getLogger(__name__)
 
-__all__ = ('baldwin_main', 'git')
+__all__ = ('baldwin_main', 'git_main')
 
 
 @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())
+    set_git_env_vars()
     logging.basicConfig(level=logging.DEBUG if debug else logging.ERROR)
 
 
@@ -32,113 +30,46 @@ def baldwin_main(*, debug: bool = False) -> None:
     '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
+def git_main(args: tuple[str, ...]) -> None:
+    """Wrap git with git-dir and work-tree passed."""
+    git(args)
 
 
 @click.command(context_settings={'help_option_names': ('-h', '--help')})
-def init() -> None:
+def init_main() -> 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'))
+    init()
 
 
 @click.command(context_settings={'help_option_names': ('-h', '--help')})
-def auto_commit() -> None:
-    """Automatic commit of changed and untracked files."""
-    repo = get_repo()
-    diff_items = repo.index.diff(None)
-    items_to_add = [
-        *[p for e in diff_items if (p := Path.home() / e.a_path).exists()], *[
-            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.remove([p for e in diff_items if not (p := Path.home() / e.a_path).exists()])
-    repo.index.commit(f'Automatic commit @ {datetime.now(tz=UTC).isoformat()}',
-                      committer=Actor('Auto-commiter', 'hgit@tat.sh'))
+def auto_commit_main() -> None:
+    """Automated commit of changed and untracked files."""
+    auto_commit()
 
 
 @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)))))
+    format_()
 
 
 @click.command(context_settings={'help_option_names': ('-h', '--help')})
-def info() -> None:
+def info_main() -> None:
     """Get basic information about the repository."""
-    click.echo(f'git-dir path: {get_git_path()}')
-    click.echo(f'work-tree path: {Path.home()}')
+    data = repo_info()
+    click.echo(f'git-dir path: {data.git_dir_path}')
+    click.echo(f'work-tree path: {data.work_tree_path}')
 
 
 @click.command(context_settings={'help_option_names': ('-h', '--help')})
-def install_units() -> None:
+def install_units_main() -> None:
     """Install systemd units for automatic committing."""
-    bw = which('bw')
-    assert bw is not None
-    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} 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')
+    install_units()
+
+
+baldwin_main.add_command(auto_commit_main, '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_main.add_command(git_main, 'git')
+baldwin_main.add_command(info_main, 'info')
+baldwin_main.add_command(init_main, 'init')
+baldwin_main.add_command(install_units_main, 'install-units')

baldwin-0.0.5.dist-info/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2023 baldwin authors
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

{baldwin-0.0.3.dist-info → baldwin-0.0.5.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: baldwin
-Version: 0.0.3
+Version: 0.0.5
 Summary: Simple tracking of your home directory with easy-to-read diffs.
 Home-page: https://github.com/Tatsh/baldwin
 License: MIT
@@ -27,6 +27,15 @@ Description-Content-Type: text/markdown
 
 # Simple home directory versioning
 
+[![QA](https://github.com/Tatsh/baldwin/actions/workflows/qa.yml/badge.svg)](https://github.com/Tatsh/baldwin/actions/workflows/qa.yml)
+[![Tests](https://github.com/Tatsh/baldwin/actions/workflows/tests.yml/badge.svg)](https://github.com/Tatsh/baldwin/actions/workflows/tests.yml)
+[![Coverage Status](https://coveralls.io/repos/github/Tatsh/baldwin/badge.svg?branch=master)](https://coveralls.io/github/Tatsh/baldwin?branch=master)
+[![Documentation Status](https://readthedocs.org/projects/baldwin/badge/?version=latest)](https://baldwin.readthedocs.io/en/latest/?badge=latest)
+![PyPI - Version](https://img.shields.io/pypi/v/baldwin)
+![GitHub tag (with filter)](https://img.shields.io/github/v/tag/Tatsh/baldwin)
+![GitHub](https://img.shields.io/github/license/Tatsh/baldwin)
+![GitHub commits since latest release (by SemVer including pre-releases)](https://img.shields.io/github/commits-since/Tatsh/baldwin/v0.0.5/master)
+
 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.
 
@@ -65,8 +74,8 @@ In addition to the `bw` command, `hgit` is a shortcut for `bw git`.
 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.
+Find out where the Git directory is by running `bw info`. This can be done even if `init` has not
+been run.
 
 ### Automation
 

baldwin-0.0.5.dist-info/RECORD

@@ -0,0 +1,11 @@
+baldwin/__init__.py,sha256=zRCtDd8b2My-634tBj2VBVvjruhFu212tMF5HMQ3T8s,62
+baldwin/lib.py,sha256=O880lZ-cJGPMDF2ypg5iOyZy9tgBWO28yMJ7pL7wN0k,7369
+baldwin/main.py,sha256=08a70OZLyRBamntbCdhhBNKSk9mywu_2M085I_mDa-s,2131
+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-0.0.5.dist-info/LICENSE.txt,sha256=TDfksi5bdmmL5cu6tAiN1iL7k38hWR2KbUg0JkASPO4,1082
+baldwin-0.0.5.dist-info/METADATA,sha256=CRhbusv0AF5culT23DmwDS7qTsl2v1P7tXK4blRWaIY,4579
+baldwin-0.0.5.dist-info/WHEEL,sha256=Nq82e9rUAnEjt98J6MlVmMCZb-t9cYE2Ir1kpBmnWfs,88
+baldwin-0.0.5.dist-info/entry_points.txt,sha256=Whfij6CPUG0wuXRYWf3VGkluV1jV32ysrGFdlWjFy9o,70
+baldwin-0.0.5.dist-info/RECORD,,

baldwin/utils.py

@@ -1,67 +0,0 @@
-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.3.dist-info/RECORD

@@ -1,10 +0,0 @@
-baldwin/__init__.py,sha256=3dgZd5iHZ-JqICxPLaJt0GhIkmxPNpiRkebG6wafnXM,62
-baldwin/main.py,sha256=kWnkz91_tTZWbQdWKzmlvdrzg5SY7b9Mu9XKsgQKDOE,5718
-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.3.dist-info/METADATA,sha256=1SiNS_zOqSKb8H2HKXi39MhCT_l_eAAW4fnnww4mLaw,3659
-baldwin-0.0.3.dist-info/WHEEL,sha256=Nq82e9rUAnEjt98J6MlVmMCZb-t9cYE2Ir1kpBmnWfs,88
-baldwin-0.0.3.dist-info/entry_points.txt,sha256=Whfij6CPUG0wuXRYWf3VGkluV1jV32ysrGFdlWjFy9o,70
-baldwin-0.0.3.dist-info/RECORD,,