Metadata-Version: 2.1
Name: blackadder
Version: 0.1.1
Summary: The uncompromising code formatter.
Home-page: UNKNOWN
License: UNKNOWN
Platform: UNKNOWN
Classifier: Development Status :: 3 - Alpha
Classifier: Environment :: Console
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3 :: Only
Classifier: Topic :: Software Development :: Libraries :: Python Modules
Classifier: Topic :: Software Development :: Quality Assurance
Requires-Python: >=3.6
Description-Content-Type: text/markdown
Requires-Dist: black (>=20.8b1)
Requires-Dist: vyper (>=0.2.7)

> [_black_](https://github.com/psf/black)-[_adder_](https://github.com/vyperlang/vyper)

A code formatter for vyper.

## Usage

To run it manually, first install using pip:
```
pip install blackadder
```
Then run the following in you terminal:
```
blackadder --fast --include '\.vy$' .
```

You can also use pre-commit hooks: put this in your repo's `.pre-commit-config.yaml` and add Python's `pre-commit` to your test requirements.
```
repos:
-   repo: https://github.com/spinoch/blackadder
    rev: "master"
    hooks:
    - id: blackadder
      language_version: python3
```



## Warning
This is still in an experimental state. Formatting may be done incorrectly for `log` keywords if the next variable name is less than 3 characters long.
If you run into issues, check out the logs to see what happens.

As of now, `blackadder` will fail if invoked without `--fast`.
In general, black options shouldn't be expected to work except for `--diff` and `--include`.




