Libvcs

Bug fixes

- _Backport from 0.13.x_. Fix argument input for git commands, e.g. `git config --get color.diff`
would not properly pass-through to subprocess. 360

Packaging

- Update [trove classifiers](https://pypi.org/classifiers/)

Packaging

- Add keywords and update subscription
- Add `py.typed` file to `libvcs/py.typed`

Breaking

- `GitRepo`, `SVNRepo`, `MercurialRepo`, `BaseRepo` have been renamed to `GitSync`, `SVNProject`,
`HgSync`, `BaseSync` (327)
- `GitSync`, `SVNProject`, `HgSync`, `BaseSync` have been moved to
`libvcs.sync.{module}.{Module}Project`
- `repo_dir` param is renamed to `dir`:

Before: `GitSync(url='...', repo_path='...')`

After: `GitSync(url='...', path='...')`

324

- `dir` to `pathlib`, `BaseSync.path` -> `BaseSync.path`
- Logging functions moved to {attr}`libvcs.sync.base.BaseSync.log` (322)
- Rename `ProjectLoggingAdapter` to `CmdLoggingAdapter`
- `CmdLoggingAdapter`: Rename `repo_name` param to `keyword`
- `create_repo` -> `create_project`
- `GitRemote` and `GitStatus`: Move to {func}`dataclasses.dataclass` (329)
- `extract_status()`: Move to `GitStatus.from_stdout` (329)

What's new

- **Commands**: Experimental command wrappers added (319):

- {class}`libvcs.cmd.git.Git`

- {meth}`libvcs.cmd.git.Git.run`
- {meth}`libvcs.cmd.git.Git.clone`
- {meth}`libvcs.cmd.git.Git.init`
- {meth}`libvcs.cmd.git.Git.pull`
- {meth}`libvcs.cmd.git.Git.rebase`

- {class}`libvcs.cmd.svn.Svn`

- {meth}`libvcs.cmd.svn.Svn.run`
- {meth}`libvcs.cmd.svn.Svn.checkout`
- {meth}`libvcs.cmd.svn.Svn.update`
- {meth}`libvcs.cmd.svn.Svn.status`
- {meth}`libvcs.cmd.svn.Svn.auth`
- {meth}`libvcs.cmd.svn.Svn.blame`
- {meth}`libvcs.cmd.svn.Svn.commit`

- {class}`libvcs.cmd.hg.Hg`

- {meth}`libvcs.cmd.hg.Hg.run`
- {meth}`libvcs.cmd.hg.Hg.clone`

- {class}`libvcs.sync.git.GitSync` now accepts remotes in `__init__`

python
repo = GitSync(
url="https://github.com/vcs-python/libvcs",
repo_path=checkout,
remotes={
'gitlab': 'https://gitlab.com/vcs-python/libvcs',
}
)


python
repo = GitSync(
url="https://github.com/vcs-python/libvcs",
repo_path=checkout,
remotes={
'gitlab': {
'fetch_url': 'https://gitlab.com/vcs-python/libvcs',
'push_url': 'https://gitlab.com/vcs-python/libvcs',
},
}
)


- {meth}`libvcs.sync.git.GitSync.update_repo` now accepts `set_remotes=True`

Compatibility

- Python 3.7 and 3.8 dropped (308)

Maintenance and bug support exists in
[`v0.11.x`](https://github.com/vcs-python/libvcs/tree/v0.11.x)

Development

- Add codeql analysis (303)
- git test suite: Lots of parametrization (309)
- CI: Use poetry caching from
[actions/setup v3.1](https://github.com/actions/setup-python/releases/tag/v3.1.0), (#316)
- New constants for `str` -> class mappings

- {data}`libvcs.sync.constants.DEFAULT_VCS_CLASS_MAP`
- {data}`libvcs.sync.constants.DEFAULT_VCS_CLASS_UNION`
- {data}`libvcs.sync.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)
- Add [doctest](https://docs.python.org/3/library/doctest.html) w/
[pytest + doctest](https://docs.pytest.org/en/7.1.x/how-to/doctest.html), (#321).
- Publish to PyPI via CI when git tags are set.

Documentation

- API: Split documentation of modules to separate pages
- Fix sphinx-issues (321)
- Experiment with sphinx-autoapi (328) for table of contents support

CVE-2022-21187: Command Injection with mercurial repositories

- By setting a mercurial URL with an alias it is possible to execute arbitrary shell commands via
`.obtain()` or in the case of uncloned destinations, `.update_repo()`.
([306](https://github.com/vcs-python/libvcs/pull/306), credit: Alessio Della Libera)

See also: [cve.mitre.org](https://cve.mitre.org/cgi-bin/cvename.cgi?name=CVE-2022-21187),
[nvd.nist.gov](https://nvd.nist.gov/vuln/detail/CVE-2022-21187),
[snyk](https://security.snyk.io/vuln/SNYK-PYTHON-LIBVCS-2421204).

Development

- Run pyupgrade formatting (305)
- Tests:
- Move from pytest `tmp_dir` (`py.path.local`) to `tmp_path` (`pathlib.Path`)
- Text fixture updates: Use home directory via `tmp_path_factory`, generate config for git and hg.

Documentation

- Move to furo theme
- Root: `make start_docs`, `make design_docs`
- docs/: `make start`, `make design`

Compatibility

- Add python 3.10 (300)
- Drop python 3.6 (300)

Development

- Poetry: 1.1.7 -> 1.1.12 (300)
- Add `.pre-commit-config.yaml`