Metadata-Version: 2.2
Name: phal-plugin-save-conversations
Version: 0.2.1
Summary: A PHAL plugin that saves conversations to a file
Author-email: Mike Gray <mike@oscillatelabs.net>
License: Apache-2.0
Project-URL: Homepage, https://github.com/OscillateLabsLLC/phal-plugin-save-conversations
Project-URL: Repository, https://github.com/OscillateLabsLLC/phal-plugin-save-conversations.git
Project-URL: Issues, https://github.com/OscillateLabsLLC/phal-plugin-save-conversations/issues
Keywords: ovos,neon,phal,plugin,voice assistant
Classifier: Development Status :: 3 - Alpha
Classifier: Intended Audience :: Developers
Classifier: Topic :: Software Development :: Libraries :: Python Modules
Classifier: License :: OSI Approved :: Apache Software License
Classifier: Programming Language :: Python :: 3
Requires-Python: >=3.9
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: ovos-bus-client
Requires-Dist: ovos-plugin-manager
Requires-Dist: ovos-utils
Requires-Dist: orjson
Provides-Extra: test
Requires-Dist: pytest>=7.0.0; extra == "test"
Requires-Dist: pytest-cov>=4.0.0; extra == "test"
Requires-Dist: pytest-asyncio>=0.21.0; extra == "test"
Provides-Extra: dev
Requires-Dist: ruff>=0.0.291; extra == "dev"
Requires-Dist: mypy>=1.0.0; extra == "dev"

# SaveConversationsPlugin

An OVOS/Neon PHAL plugin that saves a transcript of your conversations in JSONL format.

These transcripts can be used to review your conversations, look for patterns, find opportunities to write new skills, or for any other purpose.

```python
self.bus.on("recognizer_loop:wakeword", self.record_message)
self.bus.on("recognizer_loop:utterance", self.record_message)
self.bus.on("speak", self.record_message)
```

## Configuration

OVOS `~/.config/mycroft/mycroft.conf`

```json
{
  "PHAL": {
    "phal-plugin-save-conversations": {
      "save_path": "/home/ovos/.cache/transcripts"
    }
  }
}
```

Neon `~/.config/neon/neon.yaml`

```yaml
PHAL:
  phal-plugin-save-conversations:
    save_path: "/home/neon/.cache/transcripts"
```

## Credits

- Mike Gray (@mikejgray)
