Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Support XDG Base Directory compatible MSM #63

Merged
merged 2 commits into from
Jun 2, 2022
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 8 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,9 +26,12 @@ pip3 install msk

```bash
msk create
msk create-test /opt/mycroft/skills/myskill
msk submit /opt/mycroft/skills/myskill
msk create-test ~/.local/share/mycroft/skills/myskill
msk submit ~/.local/share/mycroft/skills/myskill
```

Note that Mycroft is [compatible with the XDG base directory specification](https://specifications.freedesktop.org/basedir-spec/basedir/basedir-spec-latest.html) meaning that if you have set `$XDG_DATA_HOME`, you should replace `~/.local/share` for `$XDG_DATA_HOME`.

### Creating a New Skill

`msk create`:
Expand All @@ -37,19 +40,19 @@ msk submit /opt/mycroft/skills/myskill

### Creating Tests

`msk create-test /opt/mycroft/skills/myskill`:
`msk create-test ~/.local/share/mycroft/skills/myskill`:

[![msk-create-test](https://images2.imgbox.com/9c/c8/gLRS7xuL_o.gif)](https://asciinema.org/a/Ayzaj6QJbKGBfs2eIQWr11idH?speed=1.5)

## Submitting a new skill / Updating existing skill

`msk submit /opt/mycroft/skills/myskill`:
`msk submit ~/.local/share/mycroft/skills/myskill`:

[![msk-submit](https://images2.imgbox.com/7a/5f/RcBxgLXc_o.gif)](https://asciinema.org/a/242108)

--or--

```bash
cd /opt/mycroft/skills/myskill
cd ~/.local/share/mycroft/skills/myskill
msk submit .
```
2 changes: 1 addition & 1 deletion msk/__init__.py
Original file line number Diff line number Diff line change
Expand Up @@ -15,4 +15,4 @@
# See the License for the specific language governing permissions and
# limitations under the License.
#
__version__ = "0.3.17rc1" # Also update in setup.py
__version__ = "0.4.0" # Also update in setup.py
5 changes: 1 addition & 4 deletions msk/__main__.py
Original file line number Diff line number Diff line change
Expand Up @@ -46,9 +46,6 @@ def main():
parser.add_argument(
"-s", "--skills-dir", help="Directory to look for skills in"
)
parser.add_argument(
"-c", "--repo-cache", help="Location to store local skills repo clone"
)

subparsers = parser.add_subparsers(dest="action")
subparsers.required = True
Expand All @@ -65,7 +62,7 @@ def main():
context.msm = MycroftSkillsManager(
skills_dir=args.skills_dir,
repo=SkillRepo(
url=args.repo_url, branch=args.repo_branch, path=args.repo_cache
url=args.repo_url, branch=args.repo_branch
),
)
context.branch = context.msm.repo.branch
Expand Down
6 changes: 2 additions & 4 deletions setup.py
Original file line number Diff line number Diff line change
Expand Up @@ -26,17 +26,15 @@

setup(
name='msk',
version='0.3.17rc1', # Also update in msk/__init__.py
version='0.4.0', # Also update in msk/__init__.py
packages=['msk', 'msk.actions'],
package_data={'msk': ['licenses/*']},
install_requires=['GitPython>=3.0.5', 'msm~=0.8.9', 'pygithub',
install_requires=['GitPython>=3.0.5', 'msm~=0.9.0', 'pygithub',
'requests', 'colorama'],
url='https://github.com/MycroftAI/mycroft-skills-kit',
license='Apache-2.0',
author='Mycroft AI',
author_email='support@mycroft.ai',
maintainer='Matthew Scholefield',
maintainer_email='matthew331199@gmail.com',
description='Mycroft Skills Kit',
long_description=long_description,
long_description_content_type="text/markdown",
Expand Down