dvc-utils 0.2.0__tar.gz → 0.3.0__tar.gz

{dvc-utils-0.2.0/src/dvc_utils.egg-info → dvc_utils-0.3.0}/PKG-INFO

@@ -1,13 +1,22 @@
-Metadata-Version: 2.1
+Metadata-Version: 2.4
 Name: dvc-utils
-Version: 0.2.0
-Summary: CLI for diffing DVC files at two commits (or one commit vs. current worktree), optionally passing both through another command first
-Home-page: https://github.com/runsascoded/dvc-utils
-Author: Ryan Williams
-Author-email: ryan@runsascoded.com
+Version: 0.3.0
+Summary: CLI for diffing DVC-tracked files at two commits (or one commit vs. current worktree), optionally passing both through another command first
+Author-email: Ryan Williams <ryan@runsascoded.com>
 License: MIT
+Project-URL: Homepage, https://github.com/runsascoded/dvc-utils
+Project-URL: Author URL, https://github.com/ryan-williams
+Requires-Python: >=3.9
 Description-Content-Type: text/markdown
 License-File: LICENSE
+Requires-Dist: click
+Requires-Dist: dffs>=0.0.5
+Requires-Dist: pyyaml
+Requires-Dist: utz>=0.20.0
+Provides-Extra: ci
+Requires-Dist: bmdf==0.5.2; extra == "ci"
+Requires-Dist: dvc-s3; extra == "ci"
+Dynamic: license-file
 
 # dvc-utils
 Diff [DVC] files, optionally piping through other commands first.
@@ -32,25 +41,11 @@ pip install dvc-utils
 ```
 
 ## Usage <a id="usage"></a>
-<!-- `bmdf -- dvc-utils --help` -->
-```bash
-dvc-utils --help
-# Usage: dvc-utils [OPTIONS] COMMAND [ARGS]...
-#
-# Options:
-#   --help  Show this message and exit.
-#
-# Commands:
-#   diff  Diff a DVC-tracked file at two commits (or one commit vs. current
-#         worktree), optionally passing both through another command first
-```
-
-The single subcommand, `dvc-utils diff`, is also exposed directly as `dvc-dff`:
+Currently one command is exposed, `dvc-diff`:
 
-### `dvc-diff` <a id="dvc-diff"></a>
-<!-- `bmdf -- dvc-diff --help` -->
+<!-- `bmdf -- dvc-diff` -->
 ```bash
-dvc-diff --help
+dvc-diff
 # Usage: dvc-diff [OPTIONS] [exec_cmd...] <path>
 #
 #   Diff a file at two commits (or one commit vs. current worktree), optionally
@@ -87,9 +82,8 @@ dvc-diff --help
 ```
 
 ## Examples <a id="examples"></a>
-These examples are verified with [`mdcmd`] and `$BMDF_WORKDIR=test/data`
-
-([`test/data`] is a clone of [ryan-williams/dvc-helpers@test], which contains simple DVC-tracked files used for testing [`git-diff-dvc.sh`])
+- Examples below are verified with [`mdcmd`] and `$BMDF_WORKDIR=test/data` (see [.github/workflows/ci.yml](.github/workflows/ci.yml)).
+- [test/data] is a clone of [ryan-williams/dvc-helpers@test], which contains simple DVC-tracked files (used in that repo for testing [`git-diff-dvc.sh`]).
 
 [`8ec2060`] added a DVC-tracked text file, `test.txt`:
 
@@ -159,9 +153,9 @@ dvc-diff -R f92c1d2 pqa test.parquet
 
 [`f29e52a`] updated `test.parquet`:
 
-<!-- `bmdf -- dvc-diff -R f29e52a pqa test.parquet` -->
+<!-- `bmdf -E PQT_TXT_OPTS=-n2 -- dvc-diff -R f29e52a pqa test.parquet` -->
 ```bash
-dvc-diff -R f29e52a pqa test.parquet
+PQT_TXT_OPTS=-n2 dvc-diff -R f29e52a pqa test.parquet
 # 1,3c1,3
 # < MD5: 4379600b26647a50dfcd0daa824e8219
 # < 1635 bytes
@@ -174,17 +168,16 @@ dvc-diff -R f29e52a pqa test.parquet
 # <   OPTIONAL INT64 num;
 # ---
 # >   OPTIONAL INT32 num;
-# 26a27,38
-# > }
-# > {
-# >   "num": 666,
-# >   "str": "fff"
-# > }
-# > {
+# 19,20c19,20
+# <   "num": 444,
+# <   "str": "ddd"
+# ---
 # >   "num": 777,
 # >   "str": "ggg"
-# > }
-# > {
+# 23,24c23,24
+# <   "num": 555,
+# <   "str": "eee"
+# ---
 # >   "num": 888,
 # >   "str": "hhh"
 ```
@@ -458,6 +451,7 @@ This helped me see that the data update in question (`c0..c1`) dropped some fiel
 
 [`mdcmd`]: https://github.com/runsascoded/bash-markdown-fence?tab=readme-ov-file#bmdf
 [`test/data`]: test/data
+[test/data]: test/data
 [ryan-williams/dvc-helpers@test]: https://github.com/ryan-williams/dvc-helpers/tree/test
 [`git-diff-dvc.sh`]: https://github.com/ryan-williams/dvc-helpers/blob/main/git-diff-dvc.sh
 

{dvc-utils-0.2.0 → dvc_utils-0.3.0}/README.md

@@ -21,25 +21,11 @@ pip install dvc-utils
 ```
 
 ## Usage <a id="usage"></a>
-<!-- `bmdf -- dvc-utils --help` -->
-```bash
-dvc-utils --help
-# Usage: dvc-utils [OPTIONS] COMMAND [ARGS]...
-#
-# Options:
-#   --help  Show this message and exit.
-#
-# Commands:
-#   diff  Diff a DVC-tracked file at two commits (or one commit vs. current
-#         worktree), optionally passing both through another command first
-```
-
-The single subcommand, `dvc-utils diff`, is also exposed directly as `dvc-dff`:
+Currently one command is exposed, `dvc-diff`:
 
-### `dvc-diff` <a id="dvc-diff"></a>
-<!-- `bmdf -- dvc-diff --help` -->
+<!-- `bmdf -- dvc-diff` -->
 ```bash
-dvc-diff --help
+dvc-diff
 # Usage: dvc-diff [OPTIONS] [exec_cmd...] <path>
 #
 #   Diff a file at two commits (or one commit vs. current worktree), optionally
@@ -76,9 +62,8 @@ dvc-diff --help
 ```
 
 ## Examples <a id="examples"></a>
-These examples are verified with [`mdcmd`] and `$BMDF_WORKDIR=test/data`
-
-([`test/data`] is a clone of [ryan-williams/dvc-helpers@test], which contains simple DVC-tracked files used for testing [`git-diff-dvc.sh`])
+- Examples below are verified with [`mdcmd`] and `$BMDF_WORKDIR=test/data` (see [.github/workflows/ci.yml](.github/workflows/ci.yml)).
+- [test/data] is a clone of [ryan-williams/dvc-helpers@test], which contains simple DVC-tracked files (used in that repo for testing [`git-diff-dvc.sh`]).
 
 [`8ec2060`] added a DVC-tracked text file, `test.txt`:
 
@@ -148,9 +133,9 @@ dvc-diff -R f92c1d2 pqa test.parquet
 
 [`f29e52a`] updated `test.parquet`:
 
-<!-- `bmdf -- dvc-diff -R f29e52a pqa test.parquet` -->
+<!-- `bmdf -E PQT_TXT_OPTS=-n2 -- dvc-diff -R f29e52a pqa test.parquet` -->
 ```bash
-dvc-diff -R f29e52a pqa test.parquet
+PQT_TXT_OPTS=-n2 dvc-diff -R f29e52a pqa test.parquet
 # 1,3c1,3
 # < MD5: 4379600b26647a50dfcd0daa824e8219
 # < 1635 bytes
@@ -163,17 +148,16 @@ dvc-diff -R f29e52a pqa test.parquet
 # <   OPTIONAL INT64 num;
 # ---
 # >   OPTIONAL INT32 num;
-# 26a27,38
-# > }
-# > {
-# >   "num": 666,
-# >   "str": "fff"
-# > }
-# > {
+# 19,20c19,20
+# <   "num": 444,
+# <   "str": "ddd"
+# ---
 # >   "num": 777,
 # >   "str": "ggg"
-# > }
-# > {
+# 23,24c23,24
+# <   "num": 555,
+# <   "str": "eee"
+# ---
 # >   "num": 888,
 # >   "str": "hhh"
 ```
@@ -447,6 +431,7 @@ This helped me see that the data update in question (`c0..c1`) dropped some fiel
 
 [`mdcmd`]: https://github.com/runsascoded/bash-markdown-fence?tab=readme-ov-file#bmdf
 [`test/data`]: test/data
+[test/data]: test/data
 [ryan-williams/dvc-helpers@test]: https://github.com/ryan-williams/dvc-helpers/tree/test
 [`git-diff-dvc.sh`]: https://github.com/ryan-williams/dvc-helpers/blob/main/git-diff-dvc.sh
 

dvc_utils-0.3.0/pyproject.toml

@@ -0,0 +1,40 @@
+[build-system]
+requires = ["setuptools>=75"]
+build-backend = "setuptools.build_meta"
+
+[project]
+name = "dvc-utils"
+version = "0.3.0"
+description = "CLI for diffing DVC-tracked files at two commits (or one commit vs. current worktree), optionally passing both through another command first"
+readme = "README.md"
+license = {text = "MIT"}
+authors = [
+    {name = "Ryan Williams", email = "ryan@runsascoded.com"}
+]
+requires-python = ">=3.9"
+dependencies = [
+    "click",
+    "dffs>=0.0.5",
+    "pyyaml",
+    "utz>=0.20.0",
+]
+
+[project.optional-dependencies]
+ci = [
+    "bmdf==0.5.2",
+    "dvc-s3",
+]
+
+[project.urls]
+Homepage = "https://github.com/runsascoded/dvc-utils"
+"Author URL" = "https://github.com/ryan-williams"
+
+[project.scripts]
+dvc-utils = "dvc_utils.main:main"
+dvc-diff = "dvc_utils.diff:dvc_diff"
+
+[tool.setuptools]
+package-dir = {"" = "src"}
+
+[tool.setuptools.packages.find]
+where = ["src"]

{dvc-utils-0.2.0 → dvc_utils-0.3.0}/src/dvc_utils/__init__.py

@@ -1,2 +1,2 @@
-from . import cli, path
+from . import cli, diff, path
 from .path import dvc_cache_dir, dvc_md5, dvc_paths, dvc_path

dvc_utils-0.3.0/src/dvc_utils/cli.py

@@ -0,0 +1,17 @@
+import json
+import shlex
+from os import listdir
+from os.path import isdir, join
+from typing import Tuple
+
+import click
+from click import option, argument, group
+from dffs import join_pipelines
+from utz import process, err, hash_file
+
+from dvc_utils.path import dvc_paths, dvc_cache_path
+
+
+@group()
+def cli():
+    pass

dvc-utils-0.2.0/src/dvc_utils/cli.py → dvc_utils-0.3.0/src/dvc_utils/diff.py

@@ -6,18 +6,18 @@ from typing import Tuple
 
 import click
 from click import option, argument, group
-from qmdx import join_pipelines
+from dffs import join_pipelines
 from utz import process, err, hash_file
 
+from dvc_utils.cli import cli
 from dvc_utils.path import dvc_paths, dvc_cache_path
 
 
-@group()
-def cli():
-    pass
-
-
-@cli.command('diff', short_help='Diff a DVC-tracked file at two commits (or one commit vs. current worktree), optionally passing both through another command first')
+@cli.command(
+    'diff',
+    short_help='Diff a DVC-tracked file at two commits (or one commit vs. current worktree), optionally passing both through another command first',
+    no_args_is_help=True,
+)
 @option('-c/-C', '--color/--no-color', default=None, help='Force or prevent colorized output')
 @option('-r', '--refspec', help='<commit 1>..<commit 2> (compare two commits) or <commit> (compare <commit> to the worktree)')
 @option('-R', '--ref', help='Shorthand for `-r <ref>^..<ref>`, i.e. inspect a specific commit (vs. its parent)')
@@ -28,7 +28,7 @@ def cli():
 @option('-w', '--ignore-whitespace', is_flag=True, help="Ignore whitespace differences (pass `-w` to `diff`)")
 @option('-x', '--exec-cmd', 'exec_cmds', multiple=True, help='Command(s) to execute before diffing; alternate syntax to passing commands as positional arguments')
 @argument('args', metavar='[exec_cmd...] <path>', nargs=-1)
-def dvc_utils_diff(
+def dvc_diff(
     color: bool | None,
     refspec: str | None,
     ref: str | None,
@@ -122,7 +122,3 @@ def dvc_utils_diff(
         else:
             res = process.run('diff', *diff_args, path1 or '/dev/null', path2 or '/dev/null', log=log, check=False)
             exit(res.returncode)
-
-
-if __name__ == '__main__':
-    cli()

dvc_utils-0.3.0/src/dvc_utils/main.py

@@ -0,0 +1,9 @@
+from dvc_utils.cli import cli
+from dvc_utils import diff
+
+def main():
+    cli()
+
+
+if __name__ == '__main__':
+    cli()

{dvc-utils-0.2.0 → dvc_utils-0.3.0}/src/dvc_utils/path.py

@@ -49,8 +49,13 @@ def dvc_md5(
     dir_path = get_dir_path()
     dir_path = '' if dir_path == '.' else f'{dir_path}{sep}'
     dvc_path = f"{dir_path}{dvc_path}"
-    dvc_spec = process.output('git', 'show', f'{git_ref}:{dvc_path}', log=err if log else None, err_ok=True, stderr=DEVNULL)
-    if dvc_spec is None:
+    dvc_spec = process.output(
+        'git', 'show', f'{git_ref}:{dvc_path}',
+        err_ok=True,
+        log=err if log else None,
+        stderr=None if log else DEVNULL,
+    )
+    if not dvc_spec:
         cur_dir = dirname(dvc_path)
         relpath = basename(dvc_path)
         if relpath.endswith(".dvc"):

dvc_utils-0.3.0/src/dvc_utils/sync.py

@@ -0,0 +1,13 @@
+from click import option
+
+from dvc_utils.cli import cli
+from git import Repo
+
+
+@cli.command('pull-x', short_help='Sync DVC cache files from an S3 remote')
+@option('-n', '--dry-run', is_flag=True, help='Print files that would be synced, don\'t actually perform sync')
+@option('-p', '--path', 'paths', multiple=True, help='Path globs to sync')
+@option('-r', '--ref', 'refs', multiple=True, help='Git refs to sync DVC files from')
+def pull_x(dry_run, paths, refs):
+    repo = Repo()
+

{dvc-utils-0.2.0 → dvc_utils-0.3.0/src/dvc_utils.egg-info}/PKG-INFO

@@ -1,13 +1,22 @@
-Metadata-Version: 2.1
+Metadata-Version: 2.4
 Name: dvc-utils
-Version: 0.2.0
-Summary: CLI for diffing DVC files at two commits (or one commit vs. current worktree), optionally passing both through another command first
-Home-page: https://github.com/runsascoded/dvc-utils
-Author: Ryan Williams
-Author-email: ryan@runsascoded.com
+Version: 0.3.0
+Summary: CLI for diffing DVC-tracked files at two commits (or one commit vs. current worktree), optionally passing both through another command first
+Author-email: Ryan Williams <ryan@runsascoded.com>
 License: MIT
+Project-URL: Homepage, https://github.com/runsascoded/dvc-utils
+Project-URL: Author URL, https://github.com/ryan-williams
+Requires-Python: >=3.9
 Description-Content-Type: text/markdown
 License-File: LICENSE
+Requires-Dist: click
+Requires-Dist: dffs>=0.0.5
+Requires-Dist: pyyaml
+Requires-Dist: utz>=0.20.0
+Provides-Extra: ci
+Requires-Dist: bmdf==0.5.2; extra == "ci"
+Requires-Dist: dvc-s3; extra == "ci"
+Dynamic: license-file
 
 # dvc-utils
 Diff [DVC] files, optionally piping through other commands first.
@@ -32,25 +41,11 @@ pip install dvc-utils
 ```
 
 ## Usage <a id="usage"></a>
-<!-- `bmdf -- dvc-utils --help` -->
-```bash
-dvc-utils --help
-# Usage: dvc-utils [OPTIONS] COMMAND [ARGS]...
-#
-# Options:
-#   --help  Show this message and exit.
-#
-# Commands:
-#   diff  Diff a DVC-tracked file at two commits (or one commit vs. current
-#         worktree), optionally passing both through another command first
-```
-
-The single subcommand, `dvc-utils diff`, is also exposed directly as `dvc-dff`:
+Currently one command is exposed, `dvc-diff`:
 
-### `dvc-diff` <a id="dvc-diff"></a>
-<!-- `bmdf -- dvc-diff --help` -->
+<!-- `bmdf -- dvc-diff` -->
 ```bash
-dvc-diff --help
+dvc-diff
 # Usage: dvc-diff [OPTIONS] [exec_cmd...] <path>
 #
 #   Diff a file at two commits (or one commit vs. current worktree), optionally
@@ -87,9 +82,8 @@ dvc-diff --help
 ```
 
 ## Examples <a id="examples"></a>
-These examples are verified with [`mdcmd`] and `$BMDF_WORKDIR=test/data`
-
-([`test/data`] is a clone of [ryan-williams/dvc-helpers@test], which contains simple DVC-tracked files used for testing [`git-diff-dvc.sh`])
+- Examples below are verified with [`mdcmd`] and `$BMDF_WORKDIR=test/data` (see [.github/workflows/ci.yml](.github/workflows/ci.yml)).
+- [test/data] is a clone of [ryan-williams/dvc-helpers@test], which contains simple DVC-tracked files (used in that repo for testing [`git-diff-dvc.sh`]).
 
 [`8ec2060`] added a DVC-tracked text file, `test.txt`:
 
@@ -159,9 +153,9 @@ dvc-diff -R f92c1d2 pqa test.parquet
 
 [`f29e52a`] updated `test.parquet`:
 
-<!-- `bmdf -- dvc-diff -R f29e52a pqa test.parquet` -->
+<!-- `bmdf -E PQT_TXT_OPTS=-n2 -- dvc-diff -R f29e52a pqa test.parquet` -->
 ```bash
-dvc-diff -R f29e52a pqa test.parquet
+PQT_TXT_OPTS=-n2 dvc-diff -R f29e52a pqa test.parquet
 # 1,3c1,3
 # < MD5: 4379600b26647a50dfcd0daa824e8219
 # < 1635 bytes
@@ -174,17 +168,16 @@ dvc-diff -R f29e52a pqa test.parquet
 # <   OPTIONAL INT64 num;
 # ---
 # >   OPTIONAL INT32 num;
-# 26a27,38
-# > }
-# > {
-# >   "num": 666,
-# >   "str": "fff"
-# > }
-# > {
+# 19,20c19,20
+# <   "num": 444,
+# <   "str": "ddd"
+# ---
 # >   "num": 777,
 # >   "str": "ggg"
-# > }
-# > {
+# 23,24c23,24
+# <   "num": 555,
+# <   "str": "eee"
+# ---
 # >   "num": 888,
 # >   "str": "hhh"
 ```
@@ -458,6 +451,7 @@ This helped me see that the data update in question (`c0..c1`) dropped some fiel
 
 [`mdcmd`]: https://github.com/runsascoded/bash-markdown-fence?tab=readme-ov-file#bmdf
 [`test/data`]: test/data
+[test/data]: test/data
 [ryan-williams/dvc-helpers@test]: https://github.com/ryan-williams/dvc-helpers/tree/test
 [`git-diff-dvc.sh`]: https://github.com/ryan-williams/dvc-helpers/blob/main/git-diff-dvc.sh
 

{dvc-utils-0.2.0 → dvc_utils-0.3.0}/src/dvc_utils.egg-info/SOURCES.txt

@@ -1,9 +1,12 @@
 LICENSE
 README.md
-setup.py
+pyproject.toml
 src/dvc_utils/__init__.py
 src/dvc_utils/cli.py
+src/dvc_utils/diff.py
+src/dvc_utils/main.py
 src/dvc_utils/path.py
+src/dvc_utils/sync.py
 src/dvc_utils.egg-info/PKG-INFO
 src/dvc_utils.egg-info/SOURCES.txt
 src/dvc_utils.egg-info/dependency_links.txt

dvc_utils-0.3.0/src/dvc_utils.egg-info/entry_points.txt

@@ -0,0 +1,3 @@
+[console_scripts]
+dvc-diff = dvc_utils.diff:dvc_diff
+dvc-utils = dvc_utils.main:main

dvc_utils-0.3.0/src/dvc_utils.egg-info/requires.txt

@@ -0,0 +1,8 @@
+click
+dffs>=0.0.5
+pyyaml
+utz>=0.20.0
+
+[ci]
+bmdf==0.5.2
+dvc-s3

dvc-utils-0.2.0/setup.py

@@ -1,23 +0,0 @@
-from setuptools import setup, find_packages
-
-setup(
-    name='dvc-utils',
-    version="0.2.0",
-    description="CLI for diffing DVC files at two commits (or one commit vs. current worktree), optionally passing both through another command first",
-    long_description=open("README.md").read(),
-    long_description_content_type="text/markdown",
-    package_dir={"": "src"},
-    packages=find_packages(where="src"),
-    install_requires=open("requirements.txt").read(),
-    entry_points={
-        'console_scripts': [
-            'dvc-utils = dvc_utils.cli:cli',
-            'dvc-diff = dvc_utils.cli:dvc_utils_diff',
-        ],
-    },
-    license="MIT",
-    author="Ryan Williams",
-    author_email="ryan@runsascoded.com",
-    author_url="https://github.com/ryan-williams",
-    url="https://github.com/runsascoded/dvc-utils",
-)

dvc-utils-0.2.0/src/dvc_utils.egg-info/entry_points.txt

@@ -1,3 +0,0 @@
-[console_scripts]
-dvc-diff = dvc_utils.cli:dvc_utils_diff
-dvc-utils = dvc_utils.cli:cli

dvc-utils-0.2.0/src/dvc_utils.egg-info/requires.txt

@@ -1,4 +0,0 @@
-click
-pyyaml
-qmdx>=0.0.5
-utz>=0.13.0