and3rson · ValentijnvdBeek · Aug 15, 2018 · Aug 15, 2018 · Aug 15, 2018 · Aug 16, 2018
diff --git a/.github/bug_report.md b/.github/bug_report.md
@@ -0,0 +1,21 @@
+A short description of what the issue is.
+
+## Expected Behaviour
+
+## Actual Behaviour
+
+## Steps to Reproduce
+
+  1.
+  2.
+  3.
+
+## Specifications
+ - Version of Clay: 2.0.0
+ - Python version:
+ - OS Type/version:
+ - VLC version: NA
+ - MPV version: NA
+
+## Screenshots
+Add screenshots if applicable
diff --git a/.github/feature_request.md b/.github/feature_request.md
@@ -0,0 +1,11 @@
+If applicable, a description of what problem or issue promoted you to begin with.
+
+# Your proposed solution/feature
+The way you would like us to solve this issue or how you would like
+the feature to work.
+
+# Alternatives
+Any alternative features or solutions you considered
+
+# Additional context
+Any other context, screenshots or mockups.
diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md
@@ -0,0 +1,10 @@
+**REMINDER: Please read our [contribution guidelines!](../CONTRIBUTING.rst)**
+
+Fixes #
+
+# Description
+A description of what merge request changes
+
+-
+-
+-
diff --git a/.travis.yml b/.travis.yml
@@ -1,8 +1,6 @@
 language: python
 matrix:
   include:
-  - python: 2.7
-    env: TOXENV=py27
   - python: 3.6
     env: TOXENV=py36
 before_install:
@@ -12,4 +10,3 @@ install:
   - "pip install tox radon"
 script:
   - "tox"
-
diff --git a/CHANGELOG.rst b/CHANGELOG.rst
@@ -1,36 +1,50 @@
 Changelog
 ---------
 
-Clay 1.2.0
+Clay 2.0.0
 ==========
 
 TBA
 
+* Support the MPRIS2 protocol
+* Remove X keybinds and drop the Gtk dependency
+* Artist and Album view
+* Notification actions
+* libmpv support
+* Rework of the internals
+* Enter appending songs in library or search view
+* Dropping of x keybinds
+* Add playcount incrementation (by @vale981)
+* Fix #37: clay crashing without a running notification daemon (by @agg23)
+* Fix #38: no tracks displaying (by @agg3)
+* Fix #43: queue doesn't move to the next track (by @agg23)
+* Fix #55: Unsafe load() call disabled by Gentoo (by @guitmz)
+
 Clay 1.1.0
 ==========
 
 2018-08-09
 
-* Liked Songs Playlist (by Valentijn)
-* Thumbs Up / Thumbs Down (by Valentijn)
-* Alphabetical Sorting in Library View (by Valentijn)
-* Explicit Rating Icon (by Valentijn)
+* Liked Songs Playlist
+* Thumbs Up / Thumbs Down
+* Alphabetical Sorting in Library View
+* Explicit Rating Icon
 * OSD notifications
 * setproctitle to nicely display clay in process list
 * Various bugfixes
-* Fix #29 (customizable tab activation hotkeys)
-* Fix #31 (rating issues)
+* Fix #29: customizable tab activation hotkeys
+* Fix #31: rating issues
 
 Clay 1.0.0
 ==========
 
 2018-04-06
 
- * Configurable keybinds (by Valentijn)
- * Configurable colors (by Valentijn)
- * Pluggable X keybinds (by Valentijn)
+ * Configurable keybinds
+ * Configurable colors
+ * Pluggable X keybinds
  * "My stations" page (by @Fluctuz)
- * Better settings management (by Valentijn)
+ * Better settings management
  * Equalizer
  * Track caching indicator
  * Optimized settings & cache

diff --git a/CONTRIBUTING.rst b/CONTRIBUTING.rst
@@ -0,0 +1,52 @@
+How to contribute to Clay
+======
+
+Bugs
+####
+
+Reporting bugs
+****
+- Please read the `README`_ carefully.
+- Search our `Github issues`_
+  to see whether it already has been reported.
+- Follow the relevant template.
+
+Feature request
+****
+Feature requests are always welcome but do keep in mind that it might
+take a very long time (or maybe forever!) until we get to it.
+
+Did you write a patch that fixes a bug?
+****
+- File a relevant issue if one doesn't already exist
+- Open a new pull request with the patch
+- Ensure the PR description describes the problem
+- Follow the code guidelines
+
+Any questions
+****
+Feel free to ask any questions on our irc channel:
+
+- Server: irc.oftc.net
+- Channel: **#clay**
+
+Code guidelines
+####
+
+Python guidelines
+****
+- Please follow `PEP 8`_
+- Write docstrings using the `Google Style Docstrings`_
+- Bare exceptions should be avoided
+
+Git guidelines
+****
+- Make sure that every commit functions an standalone unit.
+- Commit messages need to be descriptive
+- Pull requests that only change cosmetics will probably be denied.
+- Run a linter before commiting
+
+.. _README: README.md
+.. _Github issues: https://github.com/and3rson/Clay/issues
+.. _PEP 8: https://www.python.org/dev/peps/pep-0008/
+.. _Google Style Docstrings: https://sphinxcontrib-napoleon.readthedocs.io/en/latest/example_google.html
diff --git a/README.md b/README.md
@@ -18,6 +18,7 @@
   * [Equalizer](#equalizer)
   * [Misc](#misc)
 - [Troubleshooting](#troubleshooting)
+- [Contributing](./CONTRIBUTING.rst)
 - [Credits](#credits)
 - [Changelog](./CHANGELOG.rst)
 
@@ -27,7 +28,7 @@
 
 Standalone command line player for Google Play Music.
 
-This app wouldn't be possible without the wonderful [gmusicapi] and [VLC] libraries.
+This app wouldn't be possible without the wonderful [gmusicapi] and [VLC] & [MPV] libraries.
 
 This project is neither affiliated nor endorsed by Google.
 
@@ -49,7 +50,8 @@ Click the image below to see the screencast:
 # Quick start
 
 ```bash
-sudo apt install python-gi python-gi-cairo python3-gi python3-gi-cairo vlc keybinder python-keybinder
+sudo apt install python-gi python-gi-cairo python3-gi python3-gi-cairo
+vlc
 pip install --user clay-player
 clay
 ```
@@ -61,31 +63,31 @@ Documentation is [available here](http://clay.readthedocs.io/en/latest/).
 # Requirements
 
 - Python 3.x (native)
-- [gmusicapi] (PYPI)
-- [urwid] (PYPI)
-- [PyYAML] (PYPI)
-- lib[VLC] (native, distributed with VLC player)
-- [PyGObject] (optional) (native, used for global X keybinds)
-- [Keybinder] (optional) (native, used for global X keybinds)
-- [setproctitle] (optional) PYPI, used to change clay process name from 'python' to 'clay')
-- python-dbus (optional)
+- [gmusicapi] (PyPI)
+- [urwid] (PyPI)
+- [PyYAML] (PyPI)
+- lib[VLC] (native, distributed with VLC player) OR libMPV (native, distributed with MPV)
+- [setproctitle] (optional) PyPI, used to change clay process name from 'python' to 'clay')
+- [pydbus] (PyPI)
+- [Pillow] (PyPI, optional) used to resize album art before displaying it in notifications
 
 # What works
 - Audio equalizer
 - Caching (not for song data, that one is coming soon)
 - Configurable keybinds and colours
 - Configuration UI
 - Filtering results
-- Global hotkeys
+- Global hotkeys (via MPRIS2/DBus)
 - Like/dislike tracks
 - Liked songs playlist
 - Music library browsing & management
 - Notifications - in-app & OSD (via DBus)
-- PYPI package
+- PyPI package
 - Playback
 - Playlists
 - Queue management
 - Radio stations
+- I'm Feeling Lucky station
 - Song file caching
 - Song operations (add to library, start station etc.)
 - Song search
@@ -96,20 +98,11 @@ Documentation is [available here](http://clay.readthedocs.io/en/latest/).
 - Artist/album search
 - Other functionality that is supported by [gmusicapi]
 - Playlist editing
+- Different playback transports
 
 # Installation
 
-**Warning:** The AUR and PyPy packages called `python3-keybinder` will
-not work with Clay since you need to use the official bindings. Since
-Ubuntu seperated the official bindings into a different package but
-with the same name as the unofficial one it can cause some
-confusion. So if you get a `Namespace Keybinder not available` warning
-it is probably caused by this. So, for example, on Arch Linux you need
-the `libkeybinder3` package instead.
-
-1. Install Python 3, and VLC from your package manager.
-2. Optionally, you can install PyGObject, DBus for Python and keybinder plus bindings
-   if you want global X keybinds.
+1. Install Python 3, pydbus, PyGObject, and VLC or MPV from your package manager.
 
 ## Method 1 (PyPi, automatic)
 
@@ -170,12 +163,24 @@ Here's how you do it:
 
 You *should* get the sound working. Also docker will reuse the Clay config file from host (if you have one).
 
+# Remote control
+Clay supports the MPRIS2 protocol which allows users to remote control their Clay instances using generic tools like [playerctl].
+This replaces the old X Hotkeys systems but does require you to manually bind the keys to your windowing system of choice.
+
 # Configuration
 
 - Once you launch the app, use the "Settings" page to enter your login and password.
 - You will also need to know your Device ID. Thanks to [gmusicapi], the app should display possible IDs once you enter a wrong one.
 - Please be aware that this app has not been tested with 2FA yet.
 - For people with 2FA, you can just create an app password in Google accounts page and proceed normally. (Thanks @j605)
+- By default VLC is used. If you want to use MPV instead, add the following line to your Clay config file (`~/.config/clay/config.yaml`) in `clay_settings` section:
+
+    ```yaml
+    # ...
+    clay_settings:
+      player_class: clay.playback.mpv:MPVPlayer
+    # ...
+    ```
 
 # Controls
 
@@ -186,7 +191,8 @@ You *should* get the sound working. Also docker will reuse the Clay config file
 
 ## Songs
 
-- `<ENTER>` - play highlighted track
+- `<ENTER>` - add highlighted track to the queue
+- `<CTRL> p` - start or pause the queue
 - `<CTRL> w` - play/pause
 - `<CTRL> e` - play next song
 - `<CTRL> a` - append highlighted song to the queue
@@ -213,12 +219,6 @@ You *should* get the sound working. Also docker will reuse the Clay config file
 - `<CTRL> x` - exit app
 - To filter songs just start typing words. Hit `<ESC>` to cancel.
 
-## X keybinds
-**NOTE:** you need to pass the `--with-x-keybinds` flag for these to work
-- `<XF86AudioPlay>` - play/pause the song
-- `<XF86AudioNext>` - play the next song
-- `<XF86AudioPrev>` - play previous song
-
 # Troubleshooting
 
 At some point, the app may fail. Possible reasons are app bugs,
@@ -241,13 +241,19 @@ Regards to [gmusicapi] and [VLC] who made this possible.
 People who contribute to this project:
 
 - [@ValentijnvdBeek (Valentijn)](https://github.com/ValentijnvdBeek)
+- [@Vale981 (Valentin Boettcher)](https://github.com/vale981)
 - [@Fluctuz](https://github.com/Fluctuz)
 - [@sjkingo (Sam Kingston)](https://github.com/sjkingo)
+- [@agg23 (Adam Gastineau)](https://github.com/agg23)
+- [@guitmz (Guilherme Thomazi Bonicontro)][https://github.com/guitmz]
 
 [gmusicapi]: https://github.com/simon-weber/gmusicapi
 [VLC]: https://wiki.videolan.org/python_bindings
+[MPV]: https://mpv.io/
 [urwid]: http://www.urwid.org/
 [pyyaml]: https://github.com/yaml/pyyaml
 [PyGObject]: https://pygobject.readthedocs.io/en/latest/getting_started.html
 [Keybinder]: https://github.com/kupferlauncher/keybinder
 [setproctitle]: https://pypi.org/project/setproctitle/
+[pydbus]: https://github.com/LEW21/pydbus
+[Pillow]: https://pillow.readthedocs.io/en/5.3.x/