Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/quant-aq/cli

The QuantAQ CLI
https://github.com/quant-aq/cli

Last synced: 3 months ago
JSON representation

The QuantAQ CLI

Host: GitHub
URL: https://github.com/quant-aq/cli
Owner: quant-aq
License: apache-2.0
Created: 2020-06-04T01:13:58.000Z (over 4 years ago)
Default Branch: master
Last Pushed: 2022-12-12T19:48:04.000Z (about 2 years ago)
Last Synced: 2024-09-26T03:50:53.295Z (4 months ago)
Language: Python
Size: 6.33 MB
Stars: 5
Watchers: 5
Forks: 0
Open Issues: 1
Metadata Files:
- Readme: README.md
- Contributing: docs/contributing.rst
- License: LICENSE

Awesome Lists containing this project

awesome-air-quality - The QuantAQ CLI - _QuantAQ command line interface_ (Software Libraries)

README

# QuantAQ Command Line Interface (CLI)

[![PyPI version](https://badge.fury.io/py/quantaq-cli.svg)](https://badge.fury.io/py/quantaq-cli)
![PyPI - Python Version](https://img.shields.io/pypi/pyversions/quantaq-cli)
[![license](https://img.shields.io/badge/License-Apache_2.0-blue.svg)](https://github.com/quant-aq/cli/blob/master/LICENSE)
![run and build](https://github.com/quant-aq/cli/workflows/run%20and%20build/badge.svg?branch=master)
[![codecov](https://codecov.io/gh/quant-aq/cli/branch/master/graph/badge.svg)](https://codecov.io/gh/quant-aq/cli)

This package provides easy-to-use tools to munge data associated with QuantAQ air quality sensors.

## Documentation

Full documentation can be found [here](https://quant-aq.github.io/cli/).

## Dependencies

This tool is built for Python 3.6.1+ and has the following key dependencies

```
python = ">=3.8,<4.0"
pandas = ">=1.0.4"
```

More details can be found in the `pyproject.toml` file at the base of this repository.

## Installation

Install from PyPI

```sh
$ pip install quantaq-cli
```

It can also be added as a dependency using Poetry

```sh
$ poetry add quantaq-cli
```

If you would like to install locally, you can clone the repository and install directly with Poetry

```sh
$ poetry install
```

## Testing

All tests are automagically run via GitHub actions and reports are uploaded directly to codecov. For results to these runs, click on the badges at the top of this file. In addition, you can run tests locally

```sh
$ poetry run pytest --cov=./ --cov-report=xml -rP
```

## Development

Development takes place on GitHub. Issues and bugs can be submitted and tracked via the [GitHub Issue Tracker](https://github.com/quant-aq/cli/issues) for this repository.

## License

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at

```
http://www.apache.org/licenses/LICENSE-2.0
```

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.