Metadata-Version: 2.1
Name: upadup
Version: 0.0.2
Summary: utility for python additional_dependencies updates in pre-commit
Project-URL: Documentation, https://github.com/sirosen/upadup#readme
Project-URL: Issues, https://github.com/sirosen/upadup/issues
Project-URL: Source, https://github.com/sirosen/upadup
Author-email: Stephen Rosen <sirosen0@gmail.com>
License-File: LICENSE
Classifier: Development Status :: 4 - Beta
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: Implementation :: CPython
Classifier: Programming Language :: Python :: Implementation :: PyPy
Requires-Python: >=3.7
Requires-Dist: ruamel-yaml<0.18
Description-Content-Type: text/markdown

# updadup!

`upadup` -- Utility for Python `additional_dependencies` Updates in Pre-Commit

## Why?

`pre-commit` is great, and `pre-commit autoupdate` is also great.
However, what's not great is that `pre-commit autoupdate` cannot update your
`additional_dependencies` lists.

`upadup` is a supplemental tool which knows how to handle specific common cases.

## Usage

`updadup` will only update `additional_dependencies` items which are pinned to
specific versions, and only for known python hooks and their dependencies.

Simply `cd myrepo; upadup`!

`upadup` can also be configured with information about hooks which are unknown
to it. More on this below.

### Config Loading and Format

If you have hooks outside of the defaults which you want `upadup` to examine,
drop a `.upadup.yaml` file into your repo to configure which hooks to update.

`upadup` takes no arguments and automatically reads `.upadup.yaml` from the current
directory if available.
Otherwise, it uses its default configuration.

`upadup` needs to know what hook repos you want it to examine, and within those
which dependencies you want it to keep updated.
The config format intentionally mirrors your pre-commit config. Specify a list
of repos, and in each repo, specify a list of hooks to update. Hooks are a
combination of `id` (the hook ID) and `additional_dependencies`.

For example:

```yaml
# .upadup.yaml
repos:
  - repo: https://github.com/pycqa/flake8
    hooks:
      - id: flake8
        additional_dependencies:
          - flake8_bugbear
```

This configuration would match the following pre-commit config:

```yaml
# .pre-commit-config.yaml
repos:
  - repo: https://github.com/PyCQA/flake8
    rev: 5.0.4
    hooks:
      - id: flake8
        additional_dependencies:
          - 'flake8-bugbear==22.7.1'
```

Note that matching is case insensitive for repo names and
`additional_dependencies`, and that we normalize `-` and `_` to match, as
pypi.org does. But the overall structure of the config is intended to be a
mirror image.

### Default Config

The following config is the `upadup` default. Note that missing dependencies are
ignored.

```yaml
repos:
  - repo: https://github.com/pycqa/flake8
    hooks:
      - id: flake8
        additional_dependencies:
          - flake8-bandit
          - flake8-bugbear
          - flake8-comprehensions
          - flake8-pyi
          - flake8-typing-imports
          - flake8-docstrings
          - flake8-builtins
  - repo: https://github.com/asottile/blacken-docs
    hooks:
      - id: blacken-docs
        additional_dependencies:
          - black
```

## The Meaning of "upadup"

Update python additional depenedencies uh... pre-commit!

Unacceptable puns accosting durable urban pachyderms

Unbelievably playful, awesome, deterministic update program
