Metadata-Version: 2.5
Name: pbcmd
Version: 8.0
Summary: PB's miscellaneous command line tools.
Project-URL: Homepage, https://github.com/parantapa/pbcmd
Author-email: Parantapa Bhattacharya <pb@parantapa.net>
License-Expression: MIT
License-File: LICENSE
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.12
Classifier: Typing :: Typed
Requires-Python: >=3.12
Requires-Dist: click>=8.1
Requires-Dist: jinja2>=3.1
Requires-Dist: json5>=0.9
Requires-Dist: pandas>=2.2
Requires-Dist: platformdirs>=4.2
Requires-Dist: pyarrow>=16.0
Requires-Dist: pydantic>=2.7
Requires-Dist: python-dateutil>=2.9
Requires-Dist: tqdm>=4.66
Provides-Extra: dev
Requires-Dist: black>=24.10; extra == 'dev'
Requires-Dist: build>=1.2; extra == 'dev'
Requires-Dist: pandas-stubs>=2.2; extra == 'dev'
Requires-Dist: pycodestyle>=2.12; extra == 'dev'
Requires-Dist: pyright>=1.1.390; extra == 'dev'
Requires-Dist: pytest-cov>=6.0; extra == 'dev'
Requires-Dist: pytest>=8.3; extra == 'dev'
Requires-Dist: twine>=5.1; extra == 'dev'
Requires-Dist: types-python-dateutil>=2.9; extra == 'dev'
Requires-Dist: types-tqdm>=4.66; extra == 'dev'
Description-Content-Type: text/markdown

# pbcmd

PB's miscellaneous command line tools.

## Installation

```bash
python3 -m venv .venv
. .venv/bin/activate
pip install pbcmd
```

## Usage

Once installed,
usage instructions are available using the `--help` flag:

```bash
pb --help
```

## Development

Install the project in editable mode along with the development tools:

```bash
python3 -m venv .venv
. .venv/bin/activate
pip install -e ".[dev]"
```

Run the tests:

```bash
pytest
```

Check style and types:

```bash
black --check src tests
pycodestyle src tests
pyright
```

Build the source distribution and the wheel:

```bash
python3 -m build
```

Upload a release to PyPI:

```bash
twine upload dist/*
```

## Updating from the template

This project was generated from a local
[Copier](https://copier.readthedocs.io/) template.
`copier update` pulls in later changes to that template,
but it only works where the `_src_path` recorded in
`.copier-answers.yml` resolves;
point `_src_path` at your copy of the template first.

```bash
copier update
```

## License

This project is licensed under the MIT license.
See [LICENSE](LICENSE).
