Skip to content

Commit

Permalink
0.0.1 (#4)
Browse files Browse the repository at this point in the history
# Changelog

##
[0.0.1a3](https://github.com/NeonGeckoCom/skill-core_ready/tree/0.0.1a3)
(2023-12-16)

[Full
Changelog](0.0.1a2...0.0.1a3)

**Merged pull requests:**

- Update test dependency
[\#3](#3)
([NeonDaniel](https://github.com/NeonDaniel))

##
[0.0.1a2](https://github.com/NeonGeckoCom/skill-core_ready/tree/0.0.1a2)
(2023-11-27)

[Full
Changelog](0.0.1a1...0.0.1a2)

**Merged pull requests:**

- Add more phrasing to intents with updated tests
[\#2](#2)
([NeonDaniel](https://github.com/NeonDaniel))

##
[0.0.1a1](https://github.com/NeonGeckoCom/skill-core_ready/tree/0.0.1a1)
(2023-11-18)

[Full
Changelog](6c2a65e...0.0.1a1)

**Merged pull requests:**

- Skill initial implementation
[\#1](#1)
([NeonDaniel](https://github.com/NeonDaniel))



\* *This Changelog was automatically generated by
[github_changelog_generator](https://github.com/github-changelog-generator/github-changelog-generator)*
  • Loading branch information
NeonDaniel authored Dec 16, 2023
2 parents 6c2a65e + 0672a84 commit 565ee08
Show file tree
Hide file tree
Showing 25 changed files with 552 additions and 0 deletions.
7 changes: 7 additions & 0 deletions .github/workflows/license_tests.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
name: Run License Tests
on:
workflow_dispatch:
pull_request:
jobs:
license_tests:
uses: neongeckocom/.github/.github/workflows/license_tests.yml@master
27 changes: 27 additions & 0 deletions .github/workflows/propose_release.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@
name: Propose Stable Release
on:
workflow_dispatch:
inputs:
release_type:
type: choice
description: Release Type
options:
- patch
- minor
- major
jobs:
update_version:
uses: neongeckocom/.github/.github/workflows/propose_semver_release.yml@master
with:
branch: dev
release_type: ${{ inputs.release_type }}
update_changelog: True
pull_changes:
uses: neongeckocom/.github/.github/workflows/pull_master.yml@master
needs: update_version
with:
pr_reviewer: neonreviewers
pr_assignee: ${{ github.actor }}
pr_draft: false
pr_title: ${{ needs.update_version.outputs.version }}
pr_body: ${{ needs.update_version.outputs.changelog }}
12 changes: 12 additions & 0 deletions .github/workflows/publish_release.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
# This workflow will generate a release distribution and upload it to PyPI

name: Publish Build and GitHub Release
on:
push:
branches:
- master

jobs:
build_and_publish_pypi_and_release:
uses: neongeckocom/.github/.github/workflows/publish_stable_release.yml@master
secrets: inherit
17 changes: 17 additions & 0 deletions .github/workflows/publish_test_build.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
# This workflow will generate a distribution and upload it to PyPI

name: Publish Alpha Build
on:
push:
branches:
- dev
paths-ignore:
- 'version.py'

jobs:
build_and_publish_pypi:
uses: neongeckocom/.github/.github/workflows/publish_alpha_release.yml@master
secrets: inherit
with:
version_file: "version.py"
publish_prerelease: true
13 changes: 13 additions & 0 deletions .github/workflows/push_skill_json.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
# Update skill.json at neon_skills repository
name: Update neon_skills
on:
workflow_dispatch:
push:
branches:
- dev
- master

jobs:
push_skill_json:
uses: neongeckocom/.github/.github/workflows/skill_update_meta_repo.yml@master
secrets: inherit
20 changes: 20 additions & 0 deletions .github/workflows/skill_tests.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
# This workflow will run unit tests

name: Test Skill
on:
pull_request:
workflow_dispatch:

jobs:
py_build_tests:
uses: neongeckocom/.github/.github/workflows/python_build_tests.yml@master
skill_unit_tests:
uses: neongeckocom/.github/.github/workflows/skill_tests.yml@master
skill_intent_tests:
uses: neongeckocom/.github/.github/workflows/skill_test_intents.yml@master
skill_resource_tests:
uses: neongeckocom/.github/.github/workflows/skill_test_resources.yml@master
skill_install_tests:
uses: neongeckocom/.github/.github/workflows/skill_test_installation.yml@master
with:
test_osm: false
9 changes: 9 additions & 0 deletions .github/workflows/update_skill_json.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
# This workflow will run unit tests

name: Update skill.json
on:
push:

jobs:
update_skill_json:
uses: neongeckocom/.github/.github/workflows/skill_update_json_spec.yml@master
29 changes: 29 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
# Changelog

## [0.0.1a3](https://github.com/NeonGeckoCom/skill-core_ready/tree/0.0.1a3) (2023-12-16)

[Full Changelog](https://github.com/NeonGeckoCom/skill-core_ready/compare/0.0.1a2...0.0.1a3)

**Merged pull requests:**

- Update test dependency [\#3](https://github.com/NeonGeckoCom/skill-core_ready/pull/3) ([NeonDaniel](https://github.com/NeonDaniel))

## [0.0.1a2](https://github.com/NeonGeckoCom/skill-core_ready/tree/0.0.1a2) (2023-11-27)

[Full Changelog](https://github.com/NeonGeckoCom/skill-core_ready/compare/0.0.1a1...0.0.1a2)

**Merged pull requests:**

- Add more phrasing to intents with updated tests [\#2](https://github.com/NeonGeckoCom/skill-core_ready/pull/2) ([NeonDaniel](https://github.com/NeonDaniel))

## [0.0.1a1](https://github.com/NeonGeckoCom/skill-core_ready/tree/0.0.1a1) (2023-11-18)

[Full Changelog](https://github.com/NeonGeckoCom/skill-core_ready/compare/6c2a65ef396bee4c9614b1e7ed4e7d5305b2b87b...0.0.1a1)

**Merged pull requests:**

- Skill initial implementation [\#1](https://github.com/NeonGeckoCom/skill-core_ready/pull/1) ([NeonDaniel](https://github.com/NeonDaniel))



\* *This Changelog was automatically generated by [github_changelog_generator](https://github.com/github-changelog-generator/github-changelog-generator)*
21 changes: 21 additions & 0 deletions LICENSE.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
# NEON AI (TM) SOFTWARE, Software Development Kit & Application Development System
# All trademark and other rights reserved by their respective owners
# Copyright 2008-2021 Neongecko.com Inc.
# BSD-3 License

Redistribution and use in source and binary forms, with or without modification, are permitted provided that the
following conditions are met:
1. Redistributions of source code must retain the above copyright notice, this list of conditions and the following
disclaimer.
2. Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following
disclaimer in the documentation and/or other materials provided with the distribution.
3. Neither the name of the copyright holder nor the names of its contributors may be used to endorse or promote products
derived from this software without specific prior written permission.

THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES,
INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
30 changes: 30 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,30 @@
# <img src='https://0000.us/klatchat/app/files/neon_images/icons/neon_skill.png' card_color="#FF8600" width="50" style="vertical-align:bottom">Ready

## Summary

Skill to speak when Neon is ready

## Description

When Neon is started or restarted, this skill will speak a notification to the
user. This speech can be enabled/disabled by intent.

## Examples

- "Enable ready notifications."
- "Disable load speech."

## Contact Support

Use the [link](https://neongecko.com/ContactUs) or [submit an issue on GitHub](https://help.github.com/en/articles/creating-an-issue)

## Credits
[NeonDaniel](https://github.com/NeonDaniel)
[NeonGeckoCom](https://github.com/NeonGeckoCom)

## Category
**Daily**

## Tags
#NeonGecko Original
#NeonAI
85 changes: 85 additions & 0 deletions __init__.py
Original file line number Diff line number Diff line change
@@ -0,0 +1,85 @@
# NEON AI (TM) SOFTWARE, Software Development Kit & Application Framework
# All trademark and other rights reserved by their respective owners
# Copyright 2008-2022 Neongecko.com Inc.
# Contributors: Daniel McKnight, Guy Daniels, Elon Gasper, Richard Leeds,
# Regina Bloomstine, Casimiro Ferreira, Andrii Pernatii, Kirill Hrymailo
# BSD-3 License
# Redistribution and use in source and binary forms, with or without
# modification, are permitted provided that the following conditions are met:
# 1. Redistributions of source code must retain the above copyright notice,
# this list of conditions and the following disclaimer.
# 2. Redistributions in binary form must reproduce the above copyright notice,
# this list of conditions and the following disclaimer in the documentation
# and/or other materials provided with the distribution.
# 3. Neither the name of the copyright holder nor the names of its
# contributors may be used to endorse or promote products derived from this
# software without specific prior written permission.
# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
# AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
# THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
# PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR
# CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
# EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
# PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA,
# OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
# LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
# NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
# SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

from ovos_bus_client import Message
from ovos_utils import classproperty
from ovos_utils.log import LOG
from ovos_utils.process_utils import RuntimeRequirements
from neon_utils.skills import NeonSkill
from ovos_workshop import intent_handler


class CoreReadySkill(NeonSkill):
def __init__(self, **kwargs):
NeonSkill.__init__(self, **kwargs)
self.add_event("mycroft.ready", self.handle_ready)

@classproperty
def runtime_requirements(self):
return RuntimeRequirements(network_before_load=False,
internet_before_load=False,
gui_before_load=False,
requires_internet=False,
requires_network=False,
requires_gui=False,
no_internet_fallback=True,
no_network_fallback=True,
no_gui_fallback=True)

@property
def speak_ready(self):
"""
Speak `ready` dialog when ready unless disabled in settings
"""
return self.settings.get("speak_ready") is not False

def handle_ready(self, _: Message):
"""
Handle mycroft.ready event. Notify the user everything is ready if
configured.
"""
if self.speak_ready:
self.speak_dialog("ready")
else:
LOG.info("Ready notification disabled in settings")

@intent_handler("enable_ready_notification.intent")
def handle_enable_notification(self, _: Message):
"""
Handle a request to enable ready announcements
"""
self.settings["speak_ready"] = True
self.speak_dialog("confirm_speak_ready")

@intent_handler("disable_ready_notification.intent")
def handle_disable_notification(self, _: Message):
"""
Handle a request to disable ready announcements
"""
self.settings["speak_ready"] = False
self.speak_dialog("confirm_no_speak_ready")
1 change: 1 addition & 0 deletions locale/en-us/dialog/confirm_no_speak_ready.dialog
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
Okay. I will stop notifying you when I am ready.
1 change: 1 addition & 0 deletions locale/en-us/dialog/confirm_speak_ready.dialog
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
Okay. I will tell you when I am ready after restarts.
1 change: 1 addition & 0 deletions locale/en-us/dialog/ready.dialog
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
Neon AI is ready.
1 change: 1 addition & 0 deletions locale/en-us/intent/disable_ready_notification.intent
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
(disable|turn off|deactivate) (ready|start|startup|start up|boot|load|readiness|started|booted|loaded) (sound|notification|speech|sounds|notifications)
1 change: 1 addition & 0 deletions locale/en-us/intent/enable_ready_notification.intent
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
(enable|turn on|activate) (ready|start|startup|start up|boot|load|readiness|started|startup|booted|loaded) (sound|notification|speech|sounds|notifications)
4 changes: 4 additions & 0 deletions requirements.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
neon-utils~=1.2
ovos-workshop~=0.0.12
ovos-utils~=0.0.28
ovos-bus-client~=0.0.3
1 change: 1 addition & 0 deletions requirements/test.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
neon-minerva[padatious]~=0.1
8 changes: 8 additions & 0 deletions settingsmeta.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
skillMetadata:
sections:
- name: Ready Notification
fields:
- name: speak_ready
type: checkbox
label: Speak when everything is ready after booting
value: "true"
Loading

0 comments on commit 565ee08

Please sign in to comment.