refactor!: states -> projects, *Repo -> *Project (#327)

* refactor!: Rename states -> projects
* refactor!: {VCS}Repo -> {VCS}Project
* docs(CHANGES): Note Repo -> Project name change
* refactor!: More Repo -> Project name changes

Author: tony

CHANGES

@@ -15,19 +15,21 @@ $ pip install --user --upgrade --pre libvcs
 
 ### Breaking
 
-- `GitRepo`, `SVNRepo`, `MercurialRepo`, `BaseRepo` have been moved to
-  `libvcs.states.{module}.{Module}Repo`
+- `GitRepo`, `SVNRepo`, `MercurialRepo`, `BaseRepo` have been renamed to
+  `GitProject`, `SVNProject`, `MercurialProject`, `BaseProject` ({issue}`#327`)
+- `GitProject`, `SVNProject`, `MercurialProject`, `BaseProject` have been moved to
+  `libvcs.projects.{module}.{Module}Project`
 - `repo_dir` param is renamed to `dir`:
 
-  Before: `GitRepo(url='...', repo_dir='...')`
+  Before: `GitProject(url='...', repo_dir='...')`
 
-  After: `GitRepo(url='...', dir='...')`
+  After: `GitProject(url='...', dir='...')`
 
   {issue}`#324`
 
-- `dir` to `pathlib`, `BaseRepo.path` -> `BaseRepo.dir`
-- Logging functions moved to {attr}`libvcs.states.base.BaseRepo.log` ({issue}`#322`)
-- Rename `RepoLoggingAdapter` to `CmdLoggingAdapter`
+- `dir` to `pathlib`, `BaseProject.path` -> `BaseProject.dir`
+- Logging functions moved to {attr}`libvcs.projects.base.BaseProject.log` ({issue}`#322`)
+- Rename `ProjectLoggingAdapter` to `CmdLoggingAdapter`
 - `CmdLoggingAdapter`: Rename `repo_name` param to `keyword`
 
 ### What's new
@@ -51,10 +53,10 @@ $ pip install --user --upgrade --pre libvcs
     - {meth}`libvcs.cmd.hg.Hg.run`
     - {meth}`libvcs.cmd.hg.Hg.clone`
 
-- {class}`libvcs.states.git.GitRepo` now accepts remotes in `__init__`
+- {class}`libvcs.projects.git.GitProject` now accepts remotes in `__init__`
 
   ```python
-  repo = GitRepo(
+  repo = GitProject(
       url="https://github.com/vcs-python/libvcs",
       repo_dir=checkout,
       remotes={
@@ -64,7 +66,7 @@ $ pip install --user --upgrade --pre libvcs
   ```
 
   ```python
-  repo = GitRepo(
+  repo = GitProject(
       url="https://github.com/vcs-python/libvcs",
       repo_dir=checkout,
       remotes={
@@ -76,7 +78,7 @@ $ pip install --user --upgrade --pre libvcs
   )
   ```
 
-- {meth}`libvcs.states.git.GitRepo.update_repo` now accepts `set_remotes=True`
+- {meth}`libvcs.projects.git.GitProject.update_repo` now accepts `set_remotes=True`
 
 ### Compatibility
 
@@ -94,9 +96,9 @@ $ pip install --user --upgrade --pre libvcs
   ({issue}`#316`)
 - New constants for `str` -> class mappings
 
-  - {data}`libvcs.states.constants.DEFAULT_VCS_CLASS_MAP`
-  - {data}`libvcs.states.constants.DEFAULT_VCS_CLASS_UNION`
-  - {data}`libvcs.states.constants.DEFAULT_VCS_LITERAL`
+  - {data}`libvcs.projects.constants.DEFAULT_VCS_CLASS_MAP`
+  - {data}`libvcs.projects.constants.DEFAULT_VCS_CLASS_UNION`
+  - {data}`libvcs.projects.constants.DEFAULT_VCS_LITERAL`
 
 - Remove tox and tox-poetry-installer. It turns out installing poetry inside a poetry project
   doesn't work well. (`poetry update`, `poetry publish`, etc. commands would fail)

README.md

@@ -39,16 +39,17 @@ git = Git(dir=pathlib.Path.cwd() / 'my_git_repo')
 git.clone(url='https://github.com/vcs-python/libvcs.git')
 ```
 
-## States
+## Projects
 
-Create a [`GitRepo`](https://libvcs.git-pull.com/states/git.html#libvcs.states.git.GitRepo) object
+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.states.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/index.md

@@ -10,7 +10,7 @@
 
 quickstart
 cmd/index
-states/index
+projects/index
 ```
 
 ```{toctree}

docs/states/base.md renamed to docs/projects/base.md

@@ -1,18 +1,18 @@
-# `libvcs.states.base`
+# `libvcs.projects.base`
 
-Base objects / classes for states.
+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.states.base.BaseRepo
+   libvcs.projects.base.BaseProject
 ```
 
 ```{eval-rst}
-.. automodule:: libvcs.states.base
+.. automodule:: libvcs.projects.base
    :members:
    :show-inheritance:
 ```

docs/states/git.md renamed to docs/projects/git.md

@@ -1,22 +1,22 @@
-# `libvcs.states.git`
+# `libvcs.projects.git`
 
 For `git(1)`.
 
 Compare to:
 [`fabtools.require.git`](https://fabtools.readthedocs.io/en/0.19.0/api/require/git.html),
-[`salt.states.git`](https://docs.saltproject.io/en/latest/ref/states/all/salt.states.git.html),
+[`salt.projects.git`](https://docs.saltproject.io/en/latest/ref/projects/all/salt.projects.git.html),
 [`ansible.builtin.git`](https://docs.ansible.com/ansible/latest/collections/ansible/builtin/git_module.html)
 
 ```{eval-rst}
 .. autosummary::
    :recursive:
 
-   libvcs.states.git.GitRemote
-   libvcs.states.git.GitRepo
+   libvcs.projects.git.GitRemote
+   libvcs.projects.git.GitProject
 ```
 
 ```{eval-rst}
-.. automodule:: libvcs.states.git
+.. automodule:: libvcs.projects.git
    :members:
    :show-inheritance:
    :undoc-members:

docs/states/hg.md renamed to docs/projects/hg.md

@@ -1,16 +1,16 @@
-# `libvcs.states.hg`
+# `libvcs.projects.hg`
 
 For mercurial, aka `hg(1)`.
 
 ```{eval-rst}
 .. autosummary::
    :recursive:
 
-   libvcs.states.hg.MercurialRepo
+   libvcs.projects.hg.MercurialProject
 ```
 
 ```{eval-rst}
-.. automodule:: libvcs.states.hg
+.. automodule:: libvcs.projects.hg
    :members:
    :show-inheritance:
    :undoc-members:

docs/states/index.md renamed to docs/projects/index.md

@@ -1,10 +1,10 @@
-(states)=
+(projects)=
 
-# `libvcs.states`
+# `libvcs.projects`
 
 Compare to:
 [`fabtools.require.git`](https://fabtools.readthedocs.io/en/0.19.0/api/require/git.html),
-[`salt.states.git`](https://docs.saltproject.io/en/latest/ref/states/all/salt.states.git.html),
+[`salt.projects.git`](https://docs.saltproject.io/en/latest/ref/projects/all/salt.projects.git.html),
 [`ansible.builtin.git`](https://docs.ansible.com/ansible/latest/collections/ansible/builtin/git_module.html)
 
 :::{warning}
@@ -38,7 +38,7 @@ See examples below of git, mercurial, and subversion.
 ## Constants
 
 ```{eval-rst}
-.. automodule:: libvcs.states.constants
+.. automodule:: libvcs.projects.constants
    :members:
 ```
 

docs/states/svn.md renamed to docs/projects/svn.md

@@ -1,16 +1,16 @@
-# `libvcs.states.svn`
+# `libvcs.projects.svn`
 
 For subversion, aka `svn(1)`
 
 ```{eval-rst}
 .. autosummary::
    :recursive:
 
-   libvcs.states.svn.SubversionRepo
+   libvcs.projects.svn.SubversionProject
 ```
 
 ```{eval-rst}
-.. automodule:: libvcs.states.svn
+.. automodule:: libvcs.projects.svn
    :members:
    :show-inheritance:
    :undoc-members:

docs/redirects.txt

@@ -1,5 +1,5 @@
-"api.md" "states/index.md"
-"api/base.md" "states/base.md"
-"api/git.md" "states/git.md"
-"api/hg.md" "states/hg.md"
-"api/svn.md" "states/svn.md"
+"api.md" "projects/index.md"
+"api/base.md" "projects/base.md"
+"api/git.md" "projects/git.md"
+"api/hg.md" "projects/hg.md"
+"api/svn.md" "projects/svn.md"

libvcs/__init__.py

@@ -1,17 +1,17 @@
-"""Repo package for libvcs."""
+"""Project package for libvcs."""
 import logging
 
 from .cmd.core import CmdLoggingAdapter
-from .states.base import BaseRepo
-from .states.git import GitRepo
-from .states.hg import MercurialRepo
-from .states.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",
 ]