refactor!: {VCS}Repo -> {VCS}Project

Author: tony

README.md

@@ -41,14 +41,15 @@ git.clone(url='https://github.com/vcs-python/libvcs.git')
 
 ## Projects
 
-Create a [`GitRepo`](https://libvcs.git-pull.com/projects/git.html#libvcs.projects.git.GitRepo)
-object of the project to inspect / checkout / update:
+Create a
+[`GitProject`](https://libvcs.git-pull.com/projects/git.html#libvcs.projects.git.GitProject) object
+of the project to inspect / checkout / update:
 
 ```python
 import pathlib
-from libvcs.projects.git import GitRepo
+from libvcs.projects.git import GitProject
 
-repo = GitRepo(
+repo = GitProject(
    url="https://github.com/vcs-python/libvcs",
    dir=pathlib.Path().cwd() / "my_repo",
    remotes={

docs/projects/base.md

@@ -2,13 +2,13 @@
 
 Base objects / classes for projects.
 
-Adding your own VCS / Extending libvcs can be done through subclassing `BaseRepo`.
+Adding your own VCS / Extending libvcs can be done through subclassing `BaseProject`.
 
 ```{eval-rst}
 .. autosummary::
    :recursive:
 
-   libvcs.projects.base.BaseRepo
+   libvcs.projects.base.BaseProject
 ```
 
 ```{eval-rst}

docs/projects/git.md

@@ -12,7 +12,7 @@ Compare to:
    :recursive:
 
    libvcs.projects.git.GitRemote
-   libvcs.projects.git.GitRepo
+   libvcs.projects.git.GitProject
 ```
 
 ```{eval-rst}

docs/projects/hg.md

@@ -6,7 +6,7 @@ For mercurial, aka `hg(1)`.
 .. autosummary::
    :recursive:
 
-   libvcs.projects.hg.MercurialRepo
+   libvcs.projects.hg.MercurialProject
 ```
 
 ```{eval-rst}

docs/projects/svn.md

@@ -6,7 +6,7 @@ For subversion, aka `svn(1)`
 .. autosummary::
    :recursive:
 
-   libvcs.projects.svn.SubversionRepo
+   libvcs.projects.svn.SubversionProject
 ```
 
 ```{eval-rst}

libvcs/__init__.py

@@ -2,16 +2,16 @@
 import logging
 
 from .cmd.core import CmdLoggingAdapter
-from .projects.base import BaseRepo
-from .projects.git import GitRepo
-from .projects.hg import MercurialRepo
-from .projects.svn import SubversionRepo
+from .projects.base import BaseProject
+from .projects.git import GitProject
+from .projects.hg import MercurialProject
+from .projects.svn import SubversionProject
 
 __all__ = [
-    "GitRepo",
-    "MercurialRepo",
-    "SubversionRepo",
-    "BaseRepo",
+    "GitProject",
+    "MercurialProject",
+    "SubversionProject",
+    "BaseProject",
     "CmdLoggingAdapter",
 ]
 

libvcs/conftest.py

@@ -11,7 +11,7 @@
 from faker import Faker
 
 from libvcs.cmd.core import run, which
-from libvcs.projects.git import GitRemoteDict, GitRepo
+from libvcs.projects.git import GitProject, GitRemoteDict
 
 skip_if_git_missing = pytest.mark.skipif(
     not which("git"), reason="git is not available"
@@ -299,7 +299,7 @@ def hg_remote_repo(remote_repos_path: pathlib.Path):
 @pytest.fixture
 def git_repo(projects_path: pathlib.Path, git_remote_repo: pathlib.Path):
     """Pre-made git clone of remote repo checked out to user's projects dir."""
-    git_repo = GitRepo(
+    git_repo = GitProject(
         url=f"file://{git_remote_repo}",
         dir=str(projects_path / "git_repo"),
         remotes={

libvcs/projects/base.py

@@ -16,7 +16,7 @@ class VCSLocation(NamedTuple):
 
 
 def convert_pip_url(pip_url: str) -> VCSLocation:
-    """Return repo URL and revision by parsing `libvcs.base.BaseRepo.url`."""
+    """Return repo URL and revision by parsing `libvcs.base.BaseProject.url`."""
     error_message = (
         "Sorry, '%s' is a malformed VCS url. "
         "The format is <vcs>+<protocol>://<url>, "
@@ -32,7 +32,7 @@ def convert_pip_url(pip_url: str) -> VCSLocation:
     return VCSLocation(url=url, rev=rev)
 
 
-class BaseRepo:
+class BaseProject:
     """Base class for repositories."""
 
     #: log command output to buffer
@@ -54,7 +54,7 @@ def __init__(self, url, dir: StrOrPath, progress_callback=None, *args, **kwargs)
             >>> def progress_cb(output, timestamp):
             ...     sys.stdout.write(output)
             ...     sys.stdout.flush()
-            >>> class Repo(BaseRepo):
+            >>> class Repo(BaseProject):
             ...     bin_name = 'git'
             ...     def obtain(self, *args, **kwargs):
             ...         self.ensure_dir()
@@ -129,12 +129,12 @@ def run(
         """Return combined stderr/stdout from a command.
 
         This method will also prefix the VCS command bin_name. By default runs
-        using the cwd `libvcs.base.BaseRepo.dir` of the repo.
+        using the cwd `libvcs.base.BaseProject.dir` of the repo.
 
         Parameters
         ----------
         cwd : str
-            dir command is run from, defaults to `libvcs.base.BaseRepo.dir`.
+            dir command is run from, defaults to `libvcs.base.BaseProject.dir`.
 
         check_returncode : bool
             Indicate whether a :exc:`~exc.CommandError` should be raised if return code

libvcs/projects/constants.py

@@ -1,14 +1,15 @@
 from typing import Dict, Literal, Type, Union
 
-from libvcs import GitRepo, MercurialRepo, SubversionRepo
+from libvcs import GitProject, MercurialProject, SubversionProject
 
 #: Default VCS systems by string (in :data:`DEFAULT_VCS_CLASS_MAP`)
 DEFAULT_VCS_LITERAL = Literal["git", "hg", "svn"]
 #: Union of VCS Classes
-DEFAULT_VCS_CLASS_UNION = Type[Union[GitRepo, MercurialRepo, SubversionRepo]]
-#: String -> Class Map. ``DEFAULT_VCS_CLASS_MAP['git']`` -> :class:`~libvcs.git.GitRepo`
+DEFAULT_VCS_CLASS_UNION = Type[Union[GitProject, MercurialProject, SubversionProject]]
+#: ``str`` -> ``class`` Map. ``DEFAULT_VCS_CLASS_MAP['git']`` ->
+#: :class:`~libvcs.projects.git.GitProject`
 DEFAULT_VCS_CLASS_MAP: Dict[DEFAULT_VCS_LITERAL, DEFAULT_VCS_CLASS_UNION] = {
-    "git": GitRepo,
-    "svn": SubversionRepo,
-    "hg": MercurialRepo,
+    "git": GitProject,
+    "svn": SubversionProject,
+    "hg": MercurialProject,
 }

libvcs/projects/git.py

@@ -4,15 +4,15 @@
 
     From https://github.com/saltstack/salt (Apache License):
 
-    - [`GitRepo.remote`](libvcs.git.GitRepo.remote) (renamed to ``remote``)
-    - [`GitRepo.remote`](libvcs.git.GitRepo.remote_set) (renamed to ``set_remote``)
+    - [`GitProject.remote`](libvcs.git.GitProject.remote) (renamed to ``remote``)
+    - [`GitProject.remote`](libvcs.git.GitProject.remote_set) (renamed to ``set_remote``)
 
     From pip (MIT Licnese):
 
-    - [`GitRepo.remote`](libvcs.git.GitRepo.remote_set) (renamed to ``set_remote``)
-    - [`GitRepo.convert_pip_url`](libvcs.git.GitRepo.convert_pip_url`) (``get_url_rev``)
-    - [`GitRepo.get_revision`](libvcs.git.GitRepo.get_revision)
-    - [`GitRepo.get_git_version`](libvcs.git.GitRepo.get_git_version)
+    - [`GitProject.remote`](libvcs.git.GitProject.remote_set) (renamed to ``set_remote``)
+    - [`GitProject.convert_pip_url`](libvcs.git.GitProject.convert_pip_url`) (``get_url_rev``)
+    - [`GitProject.get_revision`](libvcs.git.GitProject.get_revision)
+    - [`GitProject.get_git_version`](libvcs.git.GitProject.get_git_version)
 """  # NOQA: E501
 import logging
 import pathlib
@@ -22,7 +22,7 @@
 
 from .. import exc
 from ..projects.base import (
-    BaseRepo,
+    BaseProject,
     VCSLocation,
     convert_pip_url as base_convert_pip_url,
 )
@@ -134,12 +134,12 @@ class GitRemoteDict(TypedDict):
     push_url: str
 
 
-GitRepoRemoteDict = Dict[str, GitRemote]
+GitProjectRemoteDict = Dict[str, GitRemote]
 GitFullRemoteDict = Dict[str, GitRemoteDict]
 GitRemotesArgs = Union[None, GitFullRemoteDict, Dict[str, str]]
 
 
-class GitRepo(BaseRepo):
+class GitProject(BaseProject):
     bin_name = "git"
     schemes = ("git", "git+http", "git+https", "git+ssh", "git+git", "git+file")
 
@@ -162,11 +162,11 @@ def __init__(
         .. code-block:: python
 
             import os
-            from libvcs.git import GitRepo
+            from libvcs.git import GitProject
 
             checkout = pathlib.Path(__name__) + '/' + 'my_libvcs'
 
-            repo = GitRepo(
+            repo = GitProject(
                url="https://github.com/vcs-python/libvcs",
                dir=checkout,
                remotes={
@@ -177,11 +177,11 @@ def __init__(
         .. code-block:: python
 
             import os
-            from libvcs.git import GitRepo
+            from libvcs.git import GitProject
 
             checkout = pathlib.Path(__name__) + '/' + 'my_libvcs'
 
-            repo = GitRepo(
+            repo = GitProject(
                url="https://github.com/vcs-python/libvcs",
                dir=checkout,
                remotes={
@@ -197,10 +197,10 @@ def __init__(
         if "tls_verify" not in kwargs:
             self.tls_verify = False
 
-        self._remotes: GitRepoRemoteDict
+        self._remotes: GitProjectRemoteDict
 
         if remotes is None:
-            self._remotes: GitRepoRemoteDict = {
+            self._remotes: GitProjectRemoteDict = {
                 "origin": GitRemote(name="origin", fetch_url=url, push_url=url)
             }
         elif isinstance(remotes, dict):
@@ -225,7 +225,7 @@ def __init__(
                 fetch_url=url,
                 push_url=url,
             )
-        BaseRepo.__init__(self, url, dir, *args, **kwargs)
+        BaseProject.__init__(self, url, dir, *args, **kwargs)
         self.url = self.chomp_protocol(
             (
                 self._remotes.get("origin")
@@ -594,7 +594,7 @@ def status(self) -> dict:
 
         Examples
         --------
-        >>> git_repo = GitRepo(
+        >>> git_repo = GitProject(
         ...     url=f'file://{create_git_remote_repo()}',
         ...     dir=tmp_path
         ... )