borg-space 2.1__tar.gz → 2.3__tar.gz

borg_space-2.1/README.rst → borg_space-2.3/PKG-INFO

@@ -1,3 +1,31 @@
+Metadata-Version: 2.4
+Name: borg_space
+Version: 2.3
+Summary: Accessory for Emborg used to report and track the size of your Borg repositories
+Keywords: emborg,borg,backups
+Author-email: Ken Kundert <borg-space@nurdletech.com>
+Requires-Python: >=3.6
+Description-Content-Type: text/x-rst
+Classifier: License :: OSI Approved :: GNU General Public License v3 or later (GPLv3+)
+Classifier: Natural Language :: English
+Classifier: Operating System :: POSIX :: Linux
+Classifier: Programming Language :: Python :: 3
+Classifier: Topic :: Utilities
+License-File: LICENSE
+Requires-Dist: appdirs
+Requires-Dist: arrow
+Requires-Dist: docopt
+Requires-Dist: inform>=1.34
+Requires-Dist: matplotlib
+Requires-Dist: nestedtext
+Requires-Dist: quantiphy
+Requires-Dist: shlib
+Requires-Dist: voluptuous>=0.14
+Project-URL: changelog, https://github.com/KenKundert/ntlog/blob/master/CHANGELOG.rst
+Project-URL: documentation, https://github.com/KenKundert/borg-space/blob/master/README.rst
+Project-URL: homepage, https://github.com/kenkundert/borg-space
+Project-URL: repository, https://github.com/kenkundert/borg-space
+
 Borg-Space — Report and track the size of your Emborg repositories
 ==================================================================
 
@@ -11,8 +39,8 @@ Borg-Space — Report and track the size of your Emborg repositories
     :target: https://pypi.python.org/pypi/borg-space/
 
 :Author: Ken Kundert
-:Version: 2.1
-:Released: 2023-06-09
+:Version: 2.3
+:Released: 2025-05-11
 
 *Borg-Space* is an accessory for Emborg_.  It reports on the space consumed by 
 your *BorgBackup* repositories.  You can get this information using the
@@ -32,6 +60,10 @@ To show the size of one or more repositories, simply run::
     # borg-space home
     home: 12.81 GB
 
+This reports on the latest repository size and, of course, assumes that you have 
+already run *emborg create*.  You must not use the ``--fast`` command line 
+option when running *create*.
+
 You can specify any number of repositories, and they can be composites.  In the 
 following example, *home* is an alias that expands to *borgbase* and *rsync*::
 
@@ -317,7 +349,28 @@ Install with::
     > pip3 install borg-space
 
 
+Borg 2
+------
+
+Borg_ 2 will be released soon, and with it will come Assimilate_, the next 
+generation of Emborg_.  *Assimilate* is intended to be used with *Borg 2.0* and 
+beyond while *Emborg* would be used with older versions of *Borg*.  Currently 
+*Borg-Space* does not support *Assimilate* directly, but the *latest.nt* files 
+produced by *Assimilate* are compatible with *Borg-Space*, only their location 
+differs.  You can get the current version of *Borg-Space* to read *Assimilate* 
+*latest.nt* files by simply creating a symbolic link from the expected location 
+to the actual location.  For example, if you convert your *home* repository from 
+*Emborg* to *Assimilate*, you can use the following commands to get *Borg-Space* 
+to use the *latest.nt* file produced by *Assimilate*::
+
+    cd ~/.local/share/emborg
+    rm home.latest.nt
+    ln -s ../assimilate/home.latest.nt .
+
+.. _assimilate: https://assimilate.readthedocs.io
+.. _borg: https://borgbackup.readthedocs.io
 .. _emborg: https://emborg.readthedocs.io
 .. _nestedtext: https://nestedtext.org
 .. _arrow: https://arrow.readthedocs.io/en/latest/guide.html#supported-tokens
 .. _quantiphy: https://quantiphy.readthedocs.io/en/stable/api.html#quantiphy.Quantity.format
+

borg_space-2.1/PKG-INFO → borg_space-2.3/README.rst

@@ -1,30 +1,3 @@
-Metadata-Version: 2.1
-Name: borg_space
-Version: 2.1
-Summary: Accessory for Emborg used to report and track the size of your Borg repositories
-Keywords: emborg,borg,backups
-Author-email: Ken Kundert <emborg@nurdletech.com>
-Requires-Python: >=3.6
-Description-Content-Type: text/x-rst
-Classifier: License :: OSI Approved :: GNU General Public License v3 or later (GPLv3+)
-Classifier: Natural Language :: English
-Classifier: Operating System :: POSIX :: Linux
-Classifier: Programming Language :: Python :: 3
-Classifier: Topic :: Utilities
-Requires-Dist: appdirs
-Requires-Dist: arrow
-Requires-Dist: docopt
-Requires-Dist: inform
-Requires-Dist: matplotlib
-Requires-Dist: nestedtext
-Requires-Dist: quantiphy
-Requires-Dist: shlib
-Requires-Dist: voluptuous
-Project-URL: changelog, https://github.com/KenKundert/ntlog/blob/master/CHANGELOG.rst
-Project-URL: documentation, https://github.com/KenKundert/borg-space/blob/master/README.rst
-Project-URL: homepage, https://github.com/kenkundert/borg-space
-Project-URL: repository, https://github.com/kenkundert/borg-space
-
 Borg-Space — Report and track the size of your Emborg repositories
 ==================================================================
 
@@ -38,8 +11,8 @@ Borg-Space — Report and track the size of your Emborg repositories
     :target: https://pypi.python.org/pypi/borg-space/
 
 :Author: Ken Kundert
-:Version: 2.1
-:Released: 2023-06-09
+:Version: 2.3
+:Released: 2025-05-11
 
 *Borg-Space* is an accessory for Emborg_.  It reports on the space consumed by 
 your *BorgBackup* repositories.  You can get this information using the
@@ -59,6 +32,10 @@ To show the size of one or more repositories, simply run::
     # borg-space home
     home: 12.81 GB
 
+This reports on the latest repository size and, of course, assumes that you have 
+already run *emborg create*.  You must not use the ``--fast`` command line 
+option when running *create*.
+
 You can specify any number of repositories, and they can be composites.  In the 
 following example, *home* is an alias that expands to *borgbase* and *rsync*::
 
@@ -344,8 +321,27 @@ Install with::
     > pip3 install borg-space
 
 
+Borg 2
+------
+
+Borg_ 2 will be released soon, and with it will come Assimilate_, the next 
+generation of Emborg_.  *Assimilate* is intended to be used with *Borg 2.0* and 
+beyond while *Emborg* would be used with older versions of *Borg*.  Currently 
+*Borg-Space* does not support *Assimilate* directly, but the *latest.nt* files 
+produced by *Assimilate* are compatible with *Borg-Space*, only their location 
+differs.  You can get the current version of *Borg-Space* to read *Assimilate* 
+*latest.nt* files by simply creating a symbolic link from the expected location 
+to the actual location.  For example, if you convert your *home* repository from 
+*Emborg* to *Assimilate*, you can use the following commands to get *Borg-Space* 
+to use the *latest.nt* file produced by *Assimilate*::
+
+    cd ~/.local/share/emborg
+    rm home.latest.nt
+    ln -s ../assimilate/home.latest.nt .
+
+.. _assimilate: https://assimilate.readthedocs.io
+.. _borg: https://borgbackup.readthedocs.io
 .. _emborg: https://emborg.readthedocs.io
 .. _nestedtext: https://nestedtext.org
 .. _arrow: https://arrow.readthedocs.io/en/latest/guide.html#supported-tokens
 .. _quantiphy: https://quantiphy.readthedocs.io/en/stable/api.html#quantiphy.Quantity.format
-

{borg_space-2.1 → borg_space-2.3}/borg_space/config.py

@@ -3,8 +3,8 @@
 # IMPORTS {{{1
 from appdirs import user_config_dir
 from inform import (
-    Error, conjoin, error, fatal, full_stop,
-    is_str, is_mapping, is_collection, plural, os_error, terminate
+    Error, conjoin, error, full_stop,
+    is_str, is_mapping, is_collection, plural, os_error, terminate_if_errors
 )
 from quantiphy import Quantity
 from shlib import to_path, Run, set_prefs
@@ -37,6 +37,7 @@ voluptuous_error_msg_mappings = {
     "extra keys not allowed": ("unknown key", "key"),
     "expected a dictionary": ("expected key:value pair", "value"),
 }
+voluptuous_key_prefix = "key contains"
 hostname = socket.gethostname().split('.')[0]
     # version of the hostname (the hostname without any domain name)
 username = pwd.getpwuid(os.getuid()).pw_name
@@ -112,7 +113,7 @@ class Repository:
         raw_data = nt.loads(content)
         self.latest = data = {}
         if 'repository size' in raw_data:
-            data['size'] = Quantity(raw_data['repository size'], 'B')
+            data['size'] = Quantity(raw_data['repository size'], 'B', binary=True)
         if 'create last run' in raw_data:
             data['last_create'] = arrow.get(raw_data['create last run'])
         if 'prune last run' in raw_data:
@@ -167,21 +168,33 @@ def to_list(args):
     if is_str(args):
         args = args.split()
     if is_mapping(args):
-        raise Invalid(f"{args}: expected list or string")
+        raise Invalid(f"expected a list or string")
     return args
 
 # a_name() {{{2
-def a_name(arg):
+def a_name(arg, is_key=False):
     # names are expected to be identifiers except that dashes are allowed
+    # also allow names starting with a digit
     if not arg:
         return arg
     if not is_str(arg):
-        raise Invalid("expected string")
-    cleaned = arg.replace('-', '0')
+        raise Invalid("expected a string")
+    cleaned = '_' + arg.replace('-', '_')
+        # add prefix to allow leading digits, replace '-' to allow dashes
     if not cleaned.isidentifier():
-        raise Invalid(f"{arg}: expected a name")
+        from string import ascii_letters as letters, digits
+        invalid = ''.join(sorted(set(cleaned) - set(letters + digits + '-_')))
+        desc = f"{plural(invalid):/an invalid character/invalid characters}"
+        if is_key:
+            raise Invalid(f"key contains {desc}: ‘{invalid}’")
+        else:
+            raise Invalid(f"value contains {desc}: ‘{invalid}’")
     return arg
 
+# key_as_name() {{{2
+def key_as_name(arg):
+    return a_name(arg, is_key=True)
+
 # a_spec() {{{2
 def a_spec(arg):
     if is_str(arg):
@@ -215,7 +228,7 @@ def to_specs(arg):
 
 # validate_settings {{{2
 validate_settings = Schema({
-    'repositories': {a_name: to_specs},
+    'repositories': {key_as_name: to_specs},
     'default_repository': str,
     'report_style': str,
     'compact_format': str,
@@ -245,31 +258,38 @@ try:
 
     # convert from specifications to Repository objects
     repositories = {}
-    for name, specs in specifications.items():
-        if specs:
-            repositories[name] = []
-            alias = name if len(specs) <= 1 else None
-            for spec in specs:
-                if spec in repositories and spec != name:
-                    # this is a known (previously defined) repository
-                    repositories[name].extend(repositories[spec])
-                else:
-                    repositories[name].append(Repository(spec, alias))
-        else:
-            repositories[name] = [Repository(name)]
+    try:
+        for name, specs in specifications.items():
+            if specs:
+                repositories[name] = []
+                alias = name if len(specs) <= 1 else None
+                for spec in specs:
+                    if spec in repositories and spec != name:
+                        # this is a known (previously defined) repository
+                        repositories[name].extend(repositories[spec])
+                    else:
+                        repositories[name].append(Repository(spec, alias))
+            else:
+                repositories[name] = [Repository(name)]
+    except Invalid as e:
+        raise Error(e, culprit=name)
 
 except nt.NestedTextError as e:
-    e.terminate()
+    e.report()
+except Error as e:
+    e.report(culprit=(settings_file,) + e.culprit)
 except FileNotFoundError:
     settings = {}
     repositories = {}
 except OSError as e:
-    fatal(os_error(e), culprit=settings_file)
+    error(os_error(e))
 except MultipleInvalid as e:  # report schema violations
     for err in e.errors:
         msg, flag = voluptuous_error_msg_mappings.get(
             err.msg, (err.msg, 'value')
         )
+        if msg.startswith(voluptuous_key_prefix):
+            flag = 'key'
         loc = keymap.get(tuple(err.path))
         codicil = loc.as_line(flag) if loc else None
         keys = nt.join_keys(err.path, keymap=keymap)
@@ -278,4 +298,4 @@ except MultipleInvalid as e:  # report schema violations
             culprit = (settings_file, keys),
             codicil = codicil
         )
-    terminate()
+terminate_if_errors()

{borg_space-2.1 → borg_space-2.3}/borg_space/main.py

@@ -32,11 +32,10 @@ Settings are held in ~/.config/borg-space/settings.nt.
 
 # imports {{{1
 from .config import settings, get_repos
-from .trees import tree
 import arrow
 from appdirs import user_data_dir
 from docopt import docopt
-from inform import Error, display, error, os_error, warn
+from inform import Error, display, error, os_error, terminate, warn, tree
 from pathlib import Path
 from quantiphy import Quantity
 import json
@@ -45,13 +44,15 @@ import matplotlib
 import matplotlib.pyplot as plt
 from matplotlib.dates import AutoDateFormatter, AutoDateLocator
 from matplotlib.ticker import FuncFormatter
+# from labellines import labelLines
+
 
 # globals {{{1
 data_dir = Path(user_data_dir('borg-space'))
 now = str(arrow.now())
 Quantity.set_prefs(prec='full')
-__version__ = "2.1"
-__released__ = "2023-06-09"
+__version__ = "2.3"
+__released__ = "2025-05-11"
 date_format = settings.get('date_format', 'D MMMM YYYY')
 size_format = settings.get('size_format', '.2b')
 nestedtext_size_format = settings.get('nestedtext_size_format', size_format)
@@ -151,6 +152,8 @@ def generate_graph(repos, svg_file, log_scale):
     ax.xaxis.set_major_locator(locator)
     ax.xaxis.set_major_formatter(AutoDateFormatter(locator))
 
+    fig.autofmt_xdate()
+
     # add traces in order of last size, largest to smallest {{{3
     largest = 0
     smallest = 1e100
@@ -163,7 +166,7 @@ def generate_graph(repos, svg_file, log_scale):
 
     # use SI scale factors on Y-axis
     def bytes(value, pos=None):
-        return Quantity(value, 'B').render()
+        return Quantity(value, 'B').render(prec=3)
     ax.yaxis.set_major_formatter(FuncFormatter(bytes))
     if largest / smallest > 10:
         ax.yaxis.set_minor_formatter("")
@@ -172,6 +175,7 @@ def generate_graph(repos, svg_file, log_scale):
 
     # draw the graph {{{3
     ax.legend(loc='upper left')
+    # labelLines(ax.get_lines())
     if svg_file:
         plt.savefig(svg_file)
     else:
@@ -267,7 +271,7 @@ def print_tree_report(repos):
                 fmt = formatter,
                 fields = fields,
                 missing = not_available,
-            )
+            ), squeeze=True
         )
     )
 
@@ -341,3 +345,4 @@ def main():
         error(os_error(e))
     except KeyboardInterrupt:
         pass
+    terminate()

{borg_space-2.1 → borg_space-2.3}/pyproject.toml

@@ -1,13 +1,13 @@
 [project]
 name = "borg_space"
 dist-name = "borg-space"
-version = "2.1"
+version = "2.3"
 description = "Accessory for Emborg used to report and track the size of your Borg repositories"
 readme = "README.rst"
 requires-python = ">=3.6"
 license = {file = "LICENSE"}
 keywords = ["emborg", "borg", "backups"]
-authors = [{name = "Ken Kundert", email = "emborg@nurdletech.com"}]
+authors = [{name = "Ken Kundert", email = "borg-space@nurdletech.com"}]
 classifiers = [
     "License :: OSI Approved :: GNU General Public License v3 or later (GPLv3+)",
     "Natural Language :: English",
@@ -19,12 +19,13 @@ dependencies = [
     "appdirs",
     "arrow",
     "docopt",
-    "inform",
+    "inform>=1.34",
     "matplotlib",
+    # "matplotlib-label-lines",
     "nestedtext",
     "quantiphy",
     "shlib",
-    "voluptuous",
+    "voluptuous>=0.14",
 ]
 
 [project.urls]

borg_space-2.1/borg_space/trees.py

@@ -1,94 +0,0 @@
-# Format a Tree
-# Description {{{1
-# Given a data hierarchy consisting of zero or more levels of dictionaries with 
-# lists as leaf values, where each dictionary key and list value is a string, 
-# this function creates a Unicode diagram of that tree.
-#
-# For example, here is a filesystem sub-hierarchy:
-#
-#     tests/
-#     ├── examples/
-#     │   ├── test_example_01.py
-#     │   ├── test_example_02.py
-#     │   └── test_example_03.py
-#     ├── foobar/
-#     │   ├── test_foobar_01.py
-#     │   ├── test_foobar_02.py
-#     │   └── test_foobar_03.py
-#     └── hello/
-#         └── world/
-#             ├── test_world_01.py
-#             ├── test_world_02.py
-#             └── test_world_03.py
-
-# Imports {{{1
-from inform import Info, conjoin, is_collection
-
-def gen_connectors(width):
-    space = " "     # This is a non-breaking space, needed with variable width fonts
-    line = "─"      # This is horizontal rule
-    connector_seeds = dict(
-        item = "├",
-        last_item = "└",
-        lead = "│",
-        last_lead = space,
-    )
-    pad = space if width > 1 else ''
-
-    def extend(seed):
-        fill = space if seed in [space, "│"] else line
-        return seed + (width - 2)*fill + pad
-
-    return Info(**{k: extend(v) for k, v in connector_seeds.items()})
-
-connectors = gen_connectors(4)
-
-def tree(data, key_suffix=''):
-    return _tree(data, key_suffix, top=True)
-
-def _tree(data, key_suffix, top=False, leader=''):
-    lines = []
-    if hasattr(data, 'items'):
-        last = len(data) - 1
-        for i, item in enumerate(data.items()):
-            key, value = item
-            # determine key-leader-supplement and item-leader-supplement
-            if top:
-                kls = ''
-                ils = ''
-            elif i < last:
-                kls = connectors.item
-                ils = connectors.lead
-            else:
-                kls = connectors.last_item
-                ils = connectors.last_lead
-
-            if is_collection(value):
-                # append dictionary to those already processed
-                lines += [
-                    leader + kls + key + key_suffix,
-                    _tree(value, key_suffix, leader = leader + ils) if value else None
-                ]
-            else:
-                # the value is a scalar, so squeeze key & value on one line
-                lines += [
-                    leader + kls + key + ': ' + value,
-                ]
-        return '\n'.join(l for l in lines if l)
-
-    elif not is_collection(data):
-        data = [str(data)]
-
-    if top:
-        joiner = '\n'
-        terminator = '\n'
-        items = conjoin(data, sep='\n', conj='\n')
-    else:
-        joiner = '\n' + leader + connectors.item
-        terminator = '\n' + leader + connectors.last_item
-        connector = connectors.item if len(data) > 1 else connectors.last_item
-        items = leader + connector + conjoin(data, sep=joiner, conj=terminator)
-
-    if items:
-        lines.append(items)
-    return '\n'.join(lines)