Metadata-Version: 2.1
Name: dapperdata
Version: 0.2.2
Summary: A python library
License: MIT
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: pydantic
Requires-Dist: typer
Requires-Dist: ruamel.yaml
Requires-Dist: tomli (>=1.1.0) ; python_version < "3.11"
Provides-Extra: dev
Requires-Dist: black ; extra == 'dev'
Requires-Dist: build ; extra == 'dev'
Requires-Dist: glom ; extra == 'dev'
Requires-Dist: isort ; extra == 'dev'
Requires-Dist: mypy ; extra == 'dev'
Requires-Dist: pip-tools ; extra == 'dev'
Requires-Dist: pytest ; extra == 'dev'
Requires-Dist: pytest-cov ; extra == 'dev'
Requires-Dist: pytest-pretty ; extra == 'dev'

# DapperData

DapperData is an opinionated formatter for YAML and JSON files.

It has two options- fix files in place, or just yell about files that fail.

## Usage

### Fix All Files in Place

If you want to fix all of the files in your current directory, recursively, run this command-

```bash
python -m dapperdata.cli pretty . --no-dry-run
```

### Test Files without Changing

You can use dapperdata to run a test in CI to confirm that all of the files already match the preferred styling.

```bash
python -m dapperdata.cli pretty .
```

This will return an list of all files to change, and will return a status code of 1 if any changes are needed. If no changes are needed the success status code (0) is returned.


## Configuration

### pyproject.toml

```toml
[tool.dapperdata]
exclude_paths = [".venv", "tests", ".git", ".vscode"]
```

### Environment Variables

```bash
DAPPERDATA_EXCLUDE_PATHS='[".venv", "tests", ".git", ".vscode"]'
```

## Excluded Files

If a `.gitignore` file is present the directories in it will be excluded from scans.
