Metadata-Version: 2.4
Name: ovos-skill-count
Version: 0.0.7a1
Summary: OVOS count to N skill
Home-page: https://github.com/OpenVoiceOS/ovos-skill-count
Author: OpenVoiceOS
Author-email: jarbasai@mailfence.com
License: Apache-2.0
Keywords: ovos skill plugin
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: ovos-utils>=0.0.38
Requires-Dist: ovos-workshop<10.0.0,>=0.0.15
Requires-Dist: ovos-number-parser
Provides-Extra: test
Requires-Dist: coveralls>=1.8.2; extra == "test"
Requires-Dist: flake8>=3.7.9; extra == "test"
Requires-Dist: pytest>=5.2.4; extra == "test"
Requires-Dist: pytest-cov>=2.8.1; extra == "test"
Requires-Dist: pytest-testmon>=2.1.3; extra == "test"
Requires-Dist: pytest-randomly>=3.16.0; extra == "test"
Requires-Dist: cov-core>=1.15.0; extra == "test"
Requires-Dist: ovoscope<2.0.0,>=1.5.0; extra == "test"
Requires-Dist: ovos-bus-client; extra == "test"
Requires-Dist: ovos-core[lgpl,plugins]>=2.0.0a1; extra == "test"
Dynamic: author
Dynamic: author-email
Dynamic: description
Dynamic: description-content-type
Dynamic: home-page
Dynamic: keywords
Dynamic: license
Dynamic: license-file
Dynamic: provides-extra
Dynamic: requires-dist
Dynamic: summary

# Count Skill

CountSkill is a skill for [Open Voice OS (OVOS)](https://openvoiceos.org). It counts aloud from 1 to a number the user gives, or counts without a limit until stopped. It supports cardinal and ordinal formats and works offline, using [ovos-number-parser](https://github.com/OpenVoiceOS/ovos-number-parser) to extract and pronounce numbers.

## Install

```bash
pip install ovos-skill-count
```

## Usage

Say one of these to start the skill:

* "Count to 10"
* "Can you count to twenty-five?"
* "Start counting"
* "Count infinitely"
* "Count to the 5th"

These utterances need matching `*.intent` files in your locale directory.

The skill extracts a number from the utterance with `ovos-number-parser`, then speaks each number up to that limit with `pronounce_number`. It supports short and long scales, and cardinal or ordinal formats, depending on the configured language. If the user asks for infinite counting, the skill counts without a limit until stopped.

The skill implements `can_stop()` and `stop_session()` with OVOS session management. Say one of these to stop a count in progress:

* "Stop"
* "That's enough"
* "Cancel"

## Related projects

* [OpenVoiceOS/ovos-number-parser](https://github.com/OpenVoiceOS/ovos-number-parser) — parses and pronounces numbers; this skill uses it to read numbers aloud.

## License

See [LICENSE](LICENSE).
