Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/floatingpurr/sync_with_pdm
Sync .pre-commit-config.yaml repos starting from pdm.lock
https://github.com/floatingpurr/sync_with_pdm
package-manager pre-commit pre-commit-hook python
Last synced: 2 months ago
JSON representation
Sync .pre-commit-config.yaml repos starting from pdm.lock
- Host: GitHub
- URL: https://github.com/floatingpurr/sync_with_pdm
- Owner: floatingpurr
- License: mit
- Created: 2022-07-25T14:22:07.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2024-10-21T22:40:03.000Z (3 months ago)
- Last Synced: 2024-10-22T18:57:46.831Z (3 months ago)
- Topics: package-manager, pre-commit, pre-commit-hook, python
- Language: Python
- Homepage:
- Size: 51.8 KB
- Stars: 9
- Watchers: 2
- Forks: 1
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Contributing: .github/CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
- awesome-pdm - sync_with_pdm - a `pre-commit` hook to keep PDM-managed packages and pre-commit hooks in sync (Eco-system)
README
# Sync with PDM
[](https://github.com/floatingpurr/sync_with_pdm/actions/workflows/ci.yml)
[](https://codecov.io/gh/floatingpurr/sync_with_pdm)
[](https://results.pre-commit.ci/latest/github/floatingpurr/sync_with_pdm/main)
[](https://github.com/pre-commit/pre-commit)
[](https://github.com/psf/black)
[](https://pdm.fming.dev)
A .pre-commit hook for keeping in sync the repos `rev` in
`.pre-commit-config.yaml` with the packages version locked into `pdm.lock`.
Check out [pre-commit.com](https://pre-commit.com/) for more about the main
framework.
> Do you rely on [Poetry](https://github.com/python-poetry/poetry)? See this
> equivalent sync repo:
> [sync_with_poetry](https://github.com/floatingpurr/sync_with_poetry).
## What problem does this hook help us solve?
[PDM](https://pdm.fming.dev) is a modern Python package and dependency manager
supporting the latest PEP standards.
[Sometimes](https://stackoverflow.com/q/70127649/4820341), you might want to
install dev dependencies locally (e.g., `black`, `flake8`, `isort`, `mypy`, ...)
to make your IDE (e.g., VS Code) play nicely with dev packages. This approach
usually turns on a live feedback as you code (e.g., suggestions, linting,
formatting, errors highlighting). PDM pins dev packages in `pdm.lock`.
This hook updates the `rev` of each `repo` in `.pre-commit-config.yaml` with the
corresponding package version stored in `pdm.lock`.
E.g., starting from the following files:
```toml
# pdm.lock
[[package]]
name = "black"
version = "21.12b0"
# ...
```
```yaml
# .pre-commit-config.yaml
repos:
# black - formatting
- repo: https://github.com/psf/black
rev: 21.11b1
hooks:
- id: black
```
this hook will bump `black` in `.pre-commit-config.yaml` as follows:
```yaml
# .pre-commit-config.yaml
repos:
# black - formatting
- repo: https://github.com/psf/black
rev: 21.12b0
hooks:
- id: black
```
## Usage
Excerpt from a `.pre-commit-config.yaml` using an example of this hook:
```yaml
- repo: https://github.com/floatingpurr/sync_with_pdm
rev: "" # the revision or tag to clone at
hooks:
- id: sync_with_pdm
args: [] # optional args
```
### Args
```
--all Scan all dependencies in pdm.lock (main, optional and dev)
--skip [SKIP ...] Packages to skip
--config CONFIG Path to a custom .pre-commit-config.yaml file
--db PACKAGE_LIST Path to a custom package list (json)
```
Usually this hook uses only dev packages to sync the hooks. Pass `--all`, if you
want to scan also the main project packages.
Pass `--skip ...` to disable the automatic
synchronization of the repos such packages correspond to.
Pass `--config ` to point to an alternative config file (it
defaults to `.pre-commit-config.yaml`).
Pass `--db ` to point to an alternative package list (json).
Such a file overrides the mapping in [`db.py`](sync_with_pdm/db.py).
## Supported packages
Supported packages out-of-the-box are listed in [`db.py`](sync_with_pdm/db.py):
- autopep8
- bandit
- black
- commitizen
- flake8
- flakeheaven
- isort
- mypy
- pyupgrade
From version `0.4.0`, you can create your very own package list, passing a
custom json file with the arg `--db`. Such a file specifies how to map a package
to the corresponding repo, following this pattern:
```json
{
"": {
"repo": "",
"rev": ""
}
}
```
Sometimes the template of the version number of a package in PyPI differs from
the one used in the repo `rev`. For example, version `0.910` of `mypy` in PyPI
(no pun intended) maps to repo `rev: v0.910`. To make this hook aware of the
leading `v`, you need to specify `"v${rev}"` as a `""`. Use
`"${rev}"` if both the package version and the repo `rev` follow the same
pattern.
PRs extending [`db.py`](sync_with_pdm/db.py) are welcome.
## Contributing
See [CONTRIBUTING.md](.github/CONTRIBUTING.md).
## Credits
This hook is inspired by
[pre-commit autoupdate](https://pre-commit.com/index.html#pre-commit-autoupdate).