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

Merging mopidy-local-sqlite and mopidy-local-images into mopidy-local #10

Merged
merged 23 commits into from
Dec 9, 2019
Merged
Show file tree
Hide file tree
Changes from 21 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
51 changes: 51 additions & 0 deletions .circleci/config.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,51 @@
version: 2.1

orbs:
codecov: codecov/codecov@1.0.5

workflows:
version: 2
test:
jobs:
- py38
- py37
- black
- check-manifest
- flake8

jobs:
py38: &test-template
docker:
- image: mopidy/ci-python:3.8
steps:
- checkout
- restore_cache:
name: Restoring tox cache
key: tox-v1-{{ .Environment.CIRCLE_JOB }}-{{ checksum "setup.cfg" }}
- run:
name: Run tests
command: |
tox -e $CIRCLE_JOB -- \
--junit-xml=test-results/pytest/results.xml \
--cov-report=xml
- save_cache:
name: Saving tox cache
key: tox-v1-{{ .Environment.CIRCLE_JOB }}-{{ checksum "setup.cfg" }}
paths:
- ./.tox
- ~/.cache/pip
- codecov/upload:
file: coverage.xml
- store_test_results:
path: test-results

py37:
<<: *test-template
docker:
- image: mopidy/ci-python:3.7

black: *test-template

check-manifest: *test-template

flake8: *test-template
16 changes: 9 additions & 7 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -1,8 +1,10 @@
*.egg-info
*.pyc
.coverage
.pytest_cache/
.tox/
MANIFEST
build/
dist/
/*.egg-info
/.coverage
/.mypy_cache/
/.pytest_cache/
/.tox/
/MANIFEST
/build/
/dist/
/docs/_build/
28 changes: 0 additions & 28 deletions .travis.yml

This file was deleted.

8 changes: 8 additions & 0 deletions CHANGELOG.rst
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,14 @@
Changelog
*********

v3.0.0a2 (UNRELEASED)
=====================

- Require Python >= 3.7.
- Require Mopidy >= 3.0.0a5.
- Require Pykka >= 2.0.1.
- Update project setup.
jodal marked this conversation as resolved.
Show resolved Hide resolved


v3.0.0a1 (2019-08-04)
=====================
Expand Down
15 changes: 11 additions & 4 deletions MANIFEST.in
Original file line number Diff line number Diff line change
@@ -1,10 +1,17 @@
include .travis.yml
include CHANGELOG.rst
include *.py
include *.rst
include .mailmap
include LICENSE
include MANIFEST.in
include README.rst
include mopidy_local/ext.conf
include pyproject.toml
include tox.ini

recursive-include .circleci *
recursive-include .github *

include mopidy_*/ext.conf

recursive-include tests *.py
recursive-include tests/data *
recursive-include mopidy_local/www *.html
recursive-include mopidy_local/sql *.sql
39 changes: 21 additions & 18 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -2,17 +2,17 @@
Mopidy-Local
************

.. image:: https://img.shields.io/pypi/v/Mopidy-Local.svg?style=flat
.. image:: https://img.shields.io/pypi/v/Mopidy-Local
:target: https://pypi.org/project/Mopidy-Local/
:alt: Latest PyPI version

.. image:: https://img.shields.io/travis/mopidy/mopidy-local/master.svg?style=flat
:target: https://travis-ci.org/mopidy/mopidy-local
:alt: Travis CI build status
.. image:: https://img.shields.io/circleci/build/gh/tkem/mopidy-local
tkem marked this conversation as resolved.
Show resolved Hide resolved
:target: https://circleci.com/gh/tkem/mopidy-local
:alt: CircleCI build status

.. image:: https://img.shields.io/coveralls/mopidy/mopidy-local/master.svg?style=flat
:target: https://coveralls.io/r/mopidy/mopidy-local
:alt: Test coverage
.. image:: https://img.shields.io/codecov/c/gh/tkem/mopidy-local
:target: https://codecov.io/gh/tkem/mopidy-local
:alt: Test coverage

`Mopidy`_ extension for playing music from your local music archive.

Expand Down Expand Up @@ -108,9 +108,6 @@ The following configuration values are available:
- ``local/enabled``: If the local extension should be enabled or not.
Defaults to ``true``.

- ``local/library``: Local library provider to use, change this if you want to
use a third party library for local files.

- ``local/media_dir``: Path to directory with local media files.

- ``local/scan_timeout``: Number of milliseconds before giving up scanning a
Expand All @@ -126,6 +123,20 @@ The following configuration values are available:
- ``local/excluded_file_extensions``: File extensions to exclude when scanning
the media directory. Values should be separated by either comma or newline.

- ``local/directories``: List of top-level directory names and URIs
for browsing.

- ``local/timeout``: Database connection timeout in seconds.

- ``local/use_artist_sortname``: Whether to use the sortname field for
ordering artist browse results. Disabled by default, since this may
give confusing results if not all artists in the library have proper
sortnames.

- ``album_art_files``: List of file names to check for when searching
jodal marked this conversation as resolved.
Show resolved Hide resolved
for external album art. These may contain UNIX shell patterns,
i.e. ``*``, ``?``, etc.


Usage
=====
Expand Down Expand Up @@ -160,14 +171,6 @@ Mopidy's index of your local library, you need to rescan::

mopidy local scan

Note that if you are using the default local library storage, ``json``, you
need to restart Mopidy after the scan completes for the updated index to be
used.

If you want index updates to come into effect immediately, you can try out
`Mopidy-Local-SQLite <https://github.com/mopidy/mopidy-local-sqlite>`_, which
will probably become the default backend in the near future.


Project resources
=================
Expand Down
Loading