Ecosyste.ms: Awesome

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

Awesome Lists | Featured Topics | Projects

https://github.com/mopidy/cookiecutter-mopidy-ext

cookiecutter template for creating a Mopidy extension
https://github.com/mopidy/cookiecutter-mopidy-ext

cookiecutter mopidy python

Last synced: about 2 months ago
JSON representation

cookiecutter template for creating a Mopidy extension

Host: GitHub
URL: https://github.com/mopidy/cookiecutter-mopidy-ext
Owner: mopidy
License: apache-2.0
Created: 2013-10-05T10:29:43.000Z (about 11 years ago)
Default Branch: main
Last Pushed: 2023-10-29T22:38:57.000Z (about 1 year ago)
Last Synced: 2024-04-14T07:45:11.261Z (9 months ago)
Topics: cookiecutter, mopidy, python
Language: Python
Homepage: https://docs.mopidy.com/en/latest/extensiondev/
Size: 81.1 KB
Stars: 17
Watchers: 16
Forks: 14
Open Issues: 0
Metadata Files:
- Readme: README.rst
- License: LICENSE

Awesome Lists containing this project

README

***********************
cookiecutter-mopidy-ext
***********************

`cookiecutter `_ template for a
`Mopidy `_ extension.

The template sets up a project with:

- a readme explaining how to install and configure the extension,
- a license file with the Apache License,
- a Python module with an empty Mopidy extension,
- an empty test suite executed with ``pytest``,
- continuous integration using GitHub Actions,
- test coverage reporting to `Codecov `_,
- a ``setup.py`` file for releasing and installing the extension as a Python
package, and
- a GitHub Action to automatically upload packages to PyPI when a GitHub
Release is created, if the GitHub repo has a `PYPI_TOKEN` secret set.

Usage
=====

#. Install `cookiecutter`::

python3 -m pip install cookiecutter

#. Generate a Mopidy extension project::

cookiecutter gh:mopidy/cookiecutter-mopidy-ext

#. Create a Git repo from the generated project.

#. Make your Mopidy extension do something.

#. Release the extension to `PyPI `_.