Metadata-Version: 2.4
Name: moveq-cli
Version: 0.1.0
Summary: Command-line tool for moveq — compute equity metrics from CSV or JSON without writing Python.
Author-email: Soura <martisoura@gmail.com>
License-Expression: BSD-3-Clause
Project-URL: Homepage, https://github.com/SVamseekar/moveq
Project-URL: Documentation, https://github.com/SVamseekar/moveq/blob/main/docs/getting_started.md
Project-URL: Repository, https://github.com/SVamseekar/moveq
Project-URL: Issues, https://github.com/SVamseekar/moveq/issues
Project-URL: Changelog, https://github.com/SVamseekar/moveq/blob/main/CHANGELOG.md
Keywords: transport,equity,accessibility,cli,gini,palma
Classifier: Development Status :: 3 - Alpha
Classifier: Environment :: Console
Classifier: Intended Audience :: Science/Research
Classifier: Intended Audience :: Developers
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3 :: Only
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.13
Classifier: Topic :: Scientific/Engineering
Requires-Python: >=3.10
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: moveq>=0.1.0
Provides-Extra: frames
Requires-Dist: moveq[frames]; extra == "frames"
Provides-Extra: test
Requires-Dist: pytest>=7; extra == "test"
Dynamic: license-file

# moveq-cli

Command-line interface for [`moveq`](https://pypi.org/project/moveq/): compute
equity metrics, composite accessibility scores, and validate country
harmonization catalogues from CSV or JSON without writing Python.

[![PyPI](https://img.shields.io/pypi/v/moveq-cli.svg)](https://pypi.org/project/moveq-cli/)
[![Python versions](https://img.shields.io/pypi/pyversions/moveq-cli.svg)](https://pypi.org/project/moveq-cli/)
[![License](https://img.shields.io/pypi/l/moveq-cli.svg)](https://github.com/SVamseekar/moveq/blob/main/LICENSE)

## Installation

Requires Python 3.10+.

```bash
pip install moveq-cli
```

This installs the `moveq` console script and pulls in `moveq` (and therefore
`moveq-core` and `moveq-catalogue`).

## Commands

### Inequality metrics from CSV

```bash
moveq gini data.csv --value trips --weight population
moveq palma data.csv --value trips --weight population
moveq ci data.csv --value trips --rank deprivation_rank --weight population
```

### Composite scoring

```bash
moveq score --terms '{"coverage": 0.8, "evening": 0.5, "frequency": null}' \
            --weights '{"coverage": 0.5, "evening": 0.3, "frequency": 0.2}'

moveq score score_config.json --json
```

### Catalogue validation

```bash
moveq catalogue validate country_catalogue.json
```

## Documentation

- [Getting started & CLI guide](https://github.com/SVamseekar/moveq/blob/main/docs/getting_started.md)
- [API reference](https://github.com/SVamseekar/moveq/blob/main/docs/api_reference.md)
- [Source repository](https://github.com/SVamseekar/moveq)
- [Changelog](https://github.com/SVamseekar/moveq/blob/main/CHANGELOG.md)

## License

[BSD 3-Clause](https://github.com/SVamseekar/moveq/blob/main/LICENSE).
