added rm command and tests (#3)

* added rm command and tests

* Renamed vcstool to vcstool2

Author: MaxandreOgeret

.github/workflows/ci.yml

@@ -1,4 +1,4 @@
-name: vcstool
+name: vcstool2
 
 on:
   push:

.gitignore

@@ -2,4 +2,4 @@
 build
 deb_dist
 dist
-vcstool.egg-info
+vcstool2.egg-info

MANIFEST.in

@@ -1,4 +1,4 @@
-include vcstool-completion/vcs.bash vcstool-completion/vcs.tcsh vcstool-completion/vcs.zsh
-include vcstool-completion/vcs.fish
+include vcstool2-completion/vcs.bash vcstool2-completion/vcs.tcsh vcstool2-completion/vcs.zsh
+include vcstool2-completion/vcs.fish
 include test/*.repos
 include test/*.txt

Makefile

@@ -1,6 +1,6 @@
 .PHONY: all setup clean_dist distro clean install
 
-NAME=vcstool
+NAME=vcstool2
 VERSION=`./setup.py --version`
 
 all:
@@ -12,7 +12,7 @@ setup:
 clean_dist:
 	-rm -rf deb_dist
 	-rm -rf dist
-	-rm -rf vcstool.egg-info
+	-rm -rf vcstool2.egg-info
 
 distro: setup clean_dist
 	python setup.py sdist

README.md

@@ -55,17 +55,17 @@ these dictionaries contains keys `url`, and `version`. If the `version` key is o
 being used.
 
 This results in something similar to the following for a set of two repositories
-([vcstool](https://github.com/dirk-thomas/vcstool) cloned via Git and
-[rosinstall](http://github.com/vcstools/rosinstall) checked out via Subversion):
+([vcstool](https://github.com/dirk-thomas/vcstool) and
+[vcstool2](https://github.com/MaxandreOgeret/vcstool2)):
 
 ``` yaml
 repositories:
   vcstool:
     url: git@github.com:dirk-thomas/vcstool.git
     version: master
   old_tools/rosinstall:
-    url: https://github.com/vcstools/rosinstall/trunk
-    version: 748
+    url: git@github.com:MaxandreOgeret/vcstool2.git
+    version: master
 ```
 
 ### Export set of repositories
@@ -104,11 +104,32 @@ The `vcs validate` command takes a YAML file which is passed in via `stdin` and
 data of a previously-exported file or hand-generated file are piped in:
 
 ```bash
-    vcs validate < my.repos
+vcs validate < my.repos
+```
+
+### Deleting repositories
+
+The `vcs rm` command takes a YAML file containing the repositories which is passed in via `stdin` or with its path
+specified via `--input`.
+
+The command performs a dry run by default, to perform the deletion use the `--force` option.
+
+This command will delete all the pulled repositories if the `--all` option is passed.  
+It can also filter the repos to delete based on their cloning path with a regex pattern passed with the `--pattern` 
+option, see the `re` module [documentation](https://docs.python.org/3/library/re.html#regular-expression-syntax) 
+for details about the syntax.
+
+To delete all:
+
+```bash
+vcs rm --all --force < repos.yaml
 ```
 
-The `validate` command also supports input in the
-[rosinstall file format](http://www.ros.org/doc/independent/api/rosinstall/html/rosinstall_file_format.html).
+To delete all repos paths containing "foo" or "bar":
+
+```bash
+vcs rm --pattern "foo|bar" --force < repos.yaml
+```
 
 ## Advanced features
 
@@ -156,25 +177,25 @@ enable that feature the shell specific completion file must be sourced.
 For *bash* append the following line to the `~/.bashrc` file:
 
 ```bash
-source /usr/share/vcstool-completion/vcs.bash
+source /usr/share/vcstool2-completion/vcs.bash
 ```
 
 For *tcsh* append the following line to the `~/.cshrc` file:
 
 ```bash
-source /usr/share/vcstool-completion/vcs.tcsh
+source /usr/share/vcstool2-completion/vcs.tcsh
 ```
 
 For *zsh* append the following line to the `~/.zshrc` file:
 
 ```bash
-source /usr/share/vcstool-completion/vcs.zsh
+source /usr/share/vcstool2-completion/vcs.zsh
 ```
 
 For *fish* append the following line to the `~/.config/fishconfig.fish` file:
 
 ```bash
-source /usr/share/vcstool-completion/vcs.fish
+source /usr/share/vcstool2-completion/vcs.fish
 ```
 
 # How to contribute?

publish-python.yaml

@@ -6,7 +6,7 @@ artifacts:
     uploads:
       - type: packagecloud
         config:
-          repository: dirk-thomas/vcstool
+          repository: MaxandreOgeret/vcstool2
           distributions:
             - ubuntu:bionic
             - ubuntu:focal

scripts/vcs

@@ -2,6 +2,6 @@
 
 import sys
 
-from vcstool.commands.vcs import main
+from vcstool2.commands.vcs import main
 
 sys.exit(main() or 0)

scripts/vcs-branch

@@ -2,6 +2,6 @@
 
 import sys
 
-from vcstool.commands.branch import main
+from vcstool2.commands.branch import main
 
 sys.exit(main() or 0)

scripts/vcs-custom

@@ -2,6 +2,6 @@
 
 import sys
 
-from vcstool.commands.custom import main
+from vcstool2.commands.custom import main
 
 sys.exit(main() or 0)

scripts/vcs-diff

@@ -2,6 +2,6 @@
 
 import sys
 
-from vcstool.commands.diff import main
+from vcstool2.commands.diff import main
 
 sys.exit(main() or 0)

scripts/vcs-export

@@ -2,6 +2,6 @@
 
 import sys
 
-from vcstool.commands.export import main
+from vcstool2.commands.export import main
 
 sys.exit(main() or 0)

scripts/vcs-help

@@ -2,6 +2,6 @@
 
 import sys
 
-from vcstool.commands.help import main
+from vcstool2.commands.help import main
 
 sys.exit(main() or 0)

scripts/vcs-import

@@ -2,6 +2,6 @@
 
 import sys
 
-from vcstool.commands.import_ import main
+from vcstool2.commands.import_ import main
 
 sys.exit(main() or 0)

scripts/vcs-log

@@ -2,6 +2,6 @@
 
 import sys
 
-from vcstool.commands.log import main
+from vcstool2.commands.log import main
 
 sys.exit(main() or 0)

scripts/vcs-pull

@@ -2,6 +2,6 @@
 
 import sys
 
-from vcstool.commands.pull import main
+from vcstool2.commands.pull import main
 
 sys.exit(main() or 0)

scripts/vcs-push

@@ -2,6 +2,6 @@
 
 import sys
 
-from vcstool.commands.push import main
+from vcstool2.commands.push import main
 
 sys.exit(main() or 0)

scripts/vcs-remotes

@@ -2,6 +2,6 @@
 
 import sys
 
-from vcstool.commands.remotes import main
+from vcstool2.commands.remotes import main
 
 sys.exit(main() or 0)

scripts/vcs-rm

@@ -0,0 +1,7 @@
+#!/usr/bin/env python3
+
+import sys
+
+from vcstool2.commands.rm import main
+
+sys.exit(main() or 0)

scripts/vcs-status

@@ -2,6 +2,6 @@
 
 import sys
 
-from vcstool.commands.status import main
+from vcstool2.commands.status import main
 
 sys.exit(main() or 0)

scripts/vcs-validate

@@ -2,6 +2,6 @@
 
 import sys
 
-from vcstool.commands.validate import main
+from vcstool2.commands.validate import main
 
 sys.exit(main() or 0)

setup.py

@@ -1,8 +1,12 @@
+from pathlib import Path
 from setuptools import find_packages
 from setuptools import setup
-from vcstool import __version__
+
+from vcstool2 import __version__
 
 install_requires = ['PyYAML', 'setuptools']
+this_directory = Path(__file__).parent
+long_description = (this_directory / "README.md").read_text()
 
 setup(
     name='vcstool2',
@@ -19,34 +23,35 @@
                  'Programming Language :: Python',
                  'Topic :: Software Development :: Version Control',
                  'Topic :: Utilities'],
-    description='vcstool provides a command line tool to invoke git commands on multiple repositories.',
-    long_description='vcstool2 enables batch commands on multiple different git repositories. It is a fork of Dirk '
-                     'Thomas\' vcstool',
+    description='vcstool2 provides a command line tool to invoke git commands on multiple repositories.',
+    long_description=long_description,
+    long_description_content_type='text/markdown',
     license='Apache License, Version 2.0',
     data_files=[
-        ('share/vcstool-completion', [
-            'vcstool-completion/vcs.bash',
-            'vcstool-completion/vcs.tcsh',
-            'vcstool-completion/vcs.zsh',
-            'vcstool-completion/vcs.fish'
+        ('share/vcstool2-completion', [
+            'vcstool2-completion/vcs.bash',
+            'vcstool2-completion/vcs.tcsh',
+            'vcstool2-completion/vcs.zsh',
+            'vcstool2-completion/vcs.fish'
         ])
     ],
     entry_points={
         'console_scripts': [
-            'vcs = vcstool.commands.vcs:main',
-            'vcs-branch = vcstool.commands.branch:main',
-            'vcs-custom = vcstool.commands.custom:main',
-            'vcs-diff = vcstool.commands.diff:main',
-            'vcs-export = vcstool.commands.export:main',
-            'vcs-git = vcstool.commands.custom:git_main',
-            'vcs-help = vcstool.commands.help:main',
-            'vcs-import = vcstool.commands.import_:main',
-            'vcs-log = vcstool.commands.log:main',
-            'vcs-pull = vcstool.commands.pull:main',
-            'vcs-push = vcstool.commands.push:main',
-            'vcs-remotes = vcstool.commands.remotes:main',
-            'vcs-status = vcstool.commands.status:main',
-            'vcs-validate = vcstool.commands.validate:main',
+            'vcs = vcstool2.commands.vcs:main',
+            'vcs-branch = vcstool2.commands.branch:main',
+            'vcs-custom = vcstool2.commands.custom:main',
+            'vcs-diff = vcstool2.commands.diff:main',
+            'vcs-export = vcstool2.commands.export:main',
+            'vcs-git = vcstool2.commands.custom:git_main',
+            'vcs-help = vcstool2.commands.help:main',
+            'vcs-import = vcstool2.commands.import_:main',
+            'vcs-log = vcstool2.commands.log:main',
+            'vcs-pull = vcstool2.commands.pull:main',
+            'vcs-push = vcstool2.commands.push:main',
+            'vcs-remotes = vcstool2.commands.remotes:main',
+            'vcs-rm = vcstool2.commands.rm:main',
+            'vcs-status = vcstool2.commands.status:main',
+            'vcs-validate = vcstool2.commands.validate:main',
         ]
     }
 )

test/commands.txt

@@ -1 +1 @@
-branch custom diff export import log pull push remotes status validate
+branch custom diff export import log pull push remotes rm status validate