Metadata-Version: 2.5
Name: quickie-runner
Version: 0.10.1
Summary: A CLI tool for quick tasks.
Project-URL: Homepage, https://github.com/adrianmrit/quickie
Project-URL: Documentation, https://quickie.readthedocs.io
Project-URL: Repository, https://github.com/adrianmrit/quickie.git
Project-URL: Issues, https://github.com/adrianmrit/quickie/issues
Project-URL: Changelog, https://github.com/adrianmrit/quickie/blob/main/CHANGELOG.md
Author-email: Adrian Martinez Rodriguez <adrianmrit@gmail.com>
License: The MIT License
        
        Copyright 2024 Adrian Martinez Rodriguez <adrianmrit@gmail.com>
        
        Permission is hereby granted, free of charge, to any person obtaining a copy
        of this software and associated documentation files (the "Software"), to deal
        in the Software without restriction, including without limitation the rights
        to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
        copies of the Software, and to permit persons to whom the Software is
        furnished to do so, subject to the following conditions:
        
        The above copyright notice and this permission notice shall be included in
        all copies or substantial portions of the Software.
        
        THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
        IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
        FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
        AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
        LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
        OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
        THE SOFTWARE.
License-File: LICENSE
Keywords: CLI,quick,tasks
Classifier: Development Status :: 3 - Alpha
Classifier: Environment :: Console
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python :: 3.12
Requires-Python: >=3.12
Requires-Dist: argcomplete>=3.6
Requires-Dist: fastmcp>=3.4
Requires-Dist: frozendict>=2.4
Requires-Dist: oslex>=2.0
Requires-Dist: python-dotenv>=1.2
Requires-Dist: rich>=15.0
Requires-Dist: watchdog>=5.0
Description-Content-Type: text/markdown

# Quickie - A CLI Tool for Quick Tasks

[![License](https://img.shields.io/github/license/adrianmrit/quickie)](https://github.com/adrianmrit/quickie/blob/master/LICENSE)

Quickie is a powerful and flexible command-line tool designed to simplify task automation. It supports both per-project and global task configurations, making it ideal for developers and teams.

Documentation is available at [quickie.readthedocs.io](https://quickie.readthedocs.io/en/latest/).

## Development

This project uses [uv](https://docs.astral.sh/uv/) for dependency management.

### Setup

```bash
uv sync --dev
pre-commit install
```

### Running tests

```bash
uv run pytest
```

Run the tests with coverage and enforce the project's coverage threshold:

```bash
uv run pytest --cov --cov-report=term-missing --cov-fail-under=95
```

### Linting and formatting

```bash
uv run ruff check .
uv run ruff format .
```

### Pre-commit

Hooks are configured in `.pre-commit-config.yaml` and run automatically on commit. To run them manually:

```bash
uv run pre-commit run --all-files
```

### Continuous integration

CI runs on GitHub Actions for every push and pull request (see `.github/workflows/ci.yml`). It runs the test suite with coverage, linting, formatting checks, and pre-commit.

See [CONTRIBUTING.md](CONTRIBUTING.md) for more details.
