From 1b0ad2ab269c1d957369b23cd29ca5eed9127ed7 Mon Sep 17 00:00:00 2001 From: Tony Narlock Date: Sun, 2 Oct 2022 11:01:47 -0500 Subject: [PATCH 1/5] docs(CLI): Consolidate vcspull command into root --- docs/cli/index.md | 23 +++++++++++++++++------ docs/cli/vcspull.md | 16 ---------------- 2 files changed, 17 insertions(+), 22 deletions(-) delete mode 100644 docs/cli/vcspull.md diff --git a/docs/cli/index.md b/docs/cli/index.md index 484d474e..2a92d138 100644 --- a/docs/cli/index.md +++ b/docs/cli/index.md @@ -2,15 +2,26 @@ # Commands -```{toctree} -:hidden: - -vcspull -``` - ```{toctree} :caption: General commands :maxdepth: 1 sync ``` + +(cli-main)= + +(vcspull-main)= + +## Command: `vcspull` + +```{eval-rst} +.. argparse:: + :module: vcspull.cli + :func: create_parser + :prog: vcspull + :nosubcommands: + + subparser_name : @replace + See :ref:`cli-sync` +``` diff --git a/docs/cli/vcspull.md b/docs/cli/vcspull.md deleted file mode 100644 index d220c548..00000000 --- a/docs/cli/vcspull.md +++ /dev/null @@ -1,16 +0,0 @@ -(cli-main)= - -(vcspull-main)= - -# vcspull - -```{eval-rst} -.. argparse:: - :module: vcspull.cli - :func: create_parser - :prog: vcspull - :nosubcommands: - - subparser_name : @replace - See :ref:`cli-sync` -``` From 6afd7b92eff5e4a5acc95f99547e4b77942a0da7 Mon Sep 17 00:00:00 2001 From: Tony Narlock Date: Sun, 2 Oct 2022 11:17:24 -0500 Subject: [PATCH 2/5] docs(CHANGES): Typo --- CHANGES | 2 -- 1 file changed, 2 deletions(-) diff --git a/CHANGES b/CHANGES index 33ab2f00..a291e5e4 100644 --- a/CHANGES +++ b/CHANGES @@ -27,8 +27,6 @@ $ pipx install --suffix=@next 'vcspull' --pip-args '\--pre' --force - Move from click to {mod}`argparse` (#400) - Click was more difficult to control and workwith, ironically. - ### Packaging - Drop click dependency (#400) From c0cdf8988015100948fdbc5bfd8325a26cfd6e9a Mon Sep 17 00:00:00 2001 From: Tony Narlock Date: Sun, 2 Oct 2022 14:43:21 -0500 Subject: [PATCH 3/5] build(deps): Pin importlib_metadata < 5 until our dependencies are figured out --- poetry.lock | 8 ++++---- pyproject.toml | 3 +++ 2 files changed, 7 insertions(+), 4 deletions(-) diff --git a/poetry.lock b/poetry.lock index ba36e4be..d7236cee 100644 --- a/poetry.lock +++ b/poetry.lock @@ -223,7 +223,7 @@ python-versions = ">=2.7, !=3.0.*, !=3.1.*, !=3.2.*, !=3.3.*" [[package]] name = "importlib-metadata" -version = "5.0.0" +version = "4.13.0" description = "Read metadata from Python packages" category = "dev" optional = false @@ -944,7 +944,7 @@ test = [] [metadata] lock-version = "1.1" python-versions = "^3.9" -content-hash = "fd3c32184923878d6c214502bcaab380fc093fb17f239600f4726d542259f80a" +content-hash = "8bde2b70cf44ee48a20a37ecb1bd489f14e64e6083cf15a9cf9458513d6ef614" [metadata.files] alabaster = [ @@ -1093,8 +1093,8 @@ imagesize = [ {file = "imagesize-1.4.1.tar.gz", hash = "sha256:69150444affb9cb0d5cc5a92b3676f0b2fb7cd9ae39e947a5e11a36b4497cd4a"}, ] importlib-metadata = [ - {file = "importlib_metadata-5.0.0-py3-none-any.whl", hash = "sha256:ddb0e35065e8938f867ed4928d0ae5bf2a53b7773871bfe6bcc7e4fcdc7dea43"}, - {file = "importlib_metadata-5.0.0.tar.gz", hash = "sha256:da31db32b304314d044d3c12c79bd59e307889b287ad12ff387b3500835fc2ab"}, + {file = "importlib_metadata-4.13.0-py3-none-any.whl", hash = "sha256:8a8a81bcf996e74fee46f0d16bd3eaa382a7eb20fd82445c3ad11f4090334116"}, + {file = "importlib_metadata-4.13.0.tar.gz", hash = "sha256:dd0173e8f150d6815e098fd354f6414b0f079af4644ddfe90c71e2fc6174346d"}, ] iniconfig = [ {file = "iniconfig-1.1.1-py2.py3-none-any.whl", hash = "sha256:011e24c64b7f47f6ebd835bb12a743f2fbe9a26d4cecaa7f53bc4f35ee9da8b3"}, diff --git a/pyproject.toml b/pyproject.toml index 8bbabe01..86736f22 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -101,6 +101,9 @@ types-requests = "*" types-PyYAML = "*" types-colorama = "*" +### Quirks ### +importlib-metadata = "<5" # https://github.com/PyCQA/flake8/issues/1701 + [tool.poetry.extras] docs = [ "sphinx", From 1c3bcd82e5ae4b9fc0192d9d90b28b6d3045c921 Mon Sep 17 00:00:00 2001 From: Tony Narlock Date: Sun, 2 Oct 2022 15:32:18 -0500 Subject: [PATCH 4/5] fix(cli) sync: Fix command help descriptions --- src/vcspull/cli/sync.py | 8 ++++++-- 1 file changed, 6 insertions(+), 2 deletions(-) diff --git a/src/vcspull/cli/sync.py b/src/vcspull/cli/sync.py index 57aef33f..3a5605bf 100644 --- a/src/vcspull/cli/sync.py +++ b/src/vcspull/cli/sync.py @@ -22,13 +22,17 @@ def clamp(n, _min, _max): def create_sync_subparser(parser: argparse.ArgumentParser) -> argparse.ArgumentParser: parser.add_argument("--config", "-c", help="Specify config") - parser.add_argument("repo_terms", nargs="+", help="Specify config") + parser.add_argument( + "repo_terms", + nargs="+", + help="Filters of repo terms, separated by spaces, supports globs / fnmatch (1)", + ) parser.add_argument( "--exit-on-error", "-x", action="store_true", dest="exit_on_error", - help="Specify config", + help="Exit immediately when encountering an error syncing multiple repos", ) return parser From e0bf4abf49b78c80ea900b2cf67033534603245a Mon Sep 17 00:00:00 2001 From: Tony Narlock Date: Sun, 2 Oct 2022 15:33:25 -0500 Subject: [PATCH 5/5] Tag v0.15.1, help text fix --- CHANGES | 6 ++++++ pyproject.toml | 2 +- src/vcspull/__about__.py | 2 +- 3 files changed, 8 insertions(+), 2 deletions(-) diff --git a/CHANGES b/CHANGES index a291e5e4..1a7c5c87 100644 --- a/CHANGES +++ b/CHANGES @@ -19,6 +19,12 @@ $ pipx install --suffix=@next 'vcspull' --pip-args '\--pre' --force - _Add your latest changes from PRs here_ +## vcspull v1.15.1 (2022-10-02) + +### Bug fix + +- Fix help text for `vcspull sync` arguments and flags + ## vcspull v1.15.0 (2022-10-02) **Maintenance release, no features or fixes** diff --git a/pyproject.toml b/pyproject.toml index 86736f22..d2711c3f 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -1,6 +1,6 @@ [tool.poetry] name = "vcspull" -version = "1.15.0" +version = "1.15.1" description = "Manage and sync multiple git, mercurial, and svn repos" license = "MIT" authors = ["Tony Narlock "] diff --git a/src/vcspull/__about__.py b/src/vcspull/__about__.py index 8580fbde..7239ce60 100644 --- a/src/vcspull/__about__.py +++ b/src/vcspull/__about__.py @@ -1,7 +1,7 @@ __title__ = "vcspull" __package_name__ = "vcspull" __description__ = "Manage and sync multiple git, mercurial, and svn repos" -__version__ = "1.15.0" +__version__ = "1.15.1" __author__ = "Tony Narlock" __github__ = "https://github.com/vcs-python/vcspull" __docs__ = "https://vcspull.git-pull.com"