python-mpd2
===========
.. image:: https://travis-ci.org/Mic92/python-mpd2.png?branch=master
:target: http://travis-ci.org/Mic92/python-mpd2
:alt: Build Status
*python-mpd2* is a Python library which provides a client interface for
the `Music Player Daemon <http://musicpd.org>`__.
Difference with python-mpd
--------------------------
python-mpd2 is a fork of `python-mpd`_. While 0.4.x was backwards compatible
with python-mpd, starting with 0.5 provides enhanced features which are *NOT*
backward compatibles with the original `python-mpd`_ package (see `Porting
Guide <https://python-mpd2.readthedocs.io/en/latest/topics/porting.html>`__
for more information).
The following features were added:
- Python 3 support (but you need at least Python 3.6)
- asyncio/twisted support
- support for the client-to-client protocol
- support for new commands from MPD (seekcur, prio, prioid,
config, searchadd, searchaddpl, listfiles, rangeid, addtagid, cleartagid,
mount, umount, listmounts, listneighbors)
- remove deprecated commands (volume)
- explicitly declared MPD commands (which is handy when using for
example `IPython <http://ipython.org>`__)
- a test suite
- API documentation to add new commands (see `Future Compatible <https://python-mpd2.readthedocs.io/en/latest/topics/advanced.html#future-compatible>`__)
- support for Unicode strings in all commands (optionally in python2,
default in python3 - see `Unicode Handling <https://python-mpd2.readthedocs.io/en/latest/topics/advanced.html#unicode-handling>`__)
- configurable timeouts
- support for `logging <https://python-mpd2.readthedocs.io/en/latest/topics/logging.html>`__
- improved support for sticker
- improved support for ranges
Getting the latest source code
------------------------------
If you would like to use the latest source code, you can grab a
copy of the development version from Git by running the command::
$ git clone https://github.com/Mic92/python-mpd2.git
Getting the latest release
--------------------------
The latest stable release of *python-mpd2* can be found on
`PyPI <http://pypi.python.org/pypi?:action=display&name=python-mpd2>`__
PyPI:
~~~~~
::
$ pip install python-mpd2
Installation in Linux/BSD distributions
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Until Linux distributions adapt this package, here are some ready to use
packages to test your applications:
See `INSTALL.rst <INSTALL.rst>`__
Installing from source
----------------------
To install *python-mpd2* from source, simply run the command::
$ python setup.py install
You can use the *--help* switch to *setup.py* for a complete list of commands
and their options. See the `Installing Python Modules <http://docs.python.org/inst/inst.html>`__ document for more details.
Documentation
-------------
`Documentation <https://python-mpd2.readthedocs.io/en/latest/>`__
`Getting Started <https://python-mpd2.readthedocs.io/en/latest/topics/getting-started.html>`__
`Command Reference <https://python-mpd2.readthedocs.io/en/latest/topics/commands.html>`__
`Examples <examples>`__
Testing
-------
Just run::
$ python setup.py test
This will install `Tox <http://tox.testrun.org/>`__. Tox will take care of
testing against all the supported Python versions (at least available) on our
computer, with the required dependencies
If you have nix, you can also use the provided `default.nix` to bring all supported
python versions in scope using `nix-shell`. In that case run `tox` directly instead
of using `setup.py`::
$ nix-shell --command 'tox'
Building Documentation
----------------------
Install Sphinx::
$ pip install Sphinx
Change to the source directory and run::
$ python ./setup.py build_sphinx
The command reference is generated from the official mpd protocol documentation.
In order to update it, install python-lxml and run the following command::
$ python ./doc/generate_command_reference.py > ./doc/topics/commands.rst
.. _python-mpd: https://pypi.python.org/pypi/python-mpd/
Raw data
{
"_id": null,
"home_page": "https://github.com/Mic92/python-mpd2",
"name": "python-mpd2",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.6",
"maintainer_email": "",
"keywords": "mpd",
"author": "Joerg Thalheim",
"author_email": "joerg@thalheim.io",
"download_url": "https://files.pythonhosted.org/packages/53/be/e77206eb35eb37ccd3506fba237e1431431d04c482707730ce2a6802e95c/python-mpd2-3.1.1.tar.gz",
"platform": null,
"description": "python-mpd2\n===========\n\n.. image:: https://travis-ci.org/Mic92/python-mpd2.png?branch=master\n :target: http://travis-ci.org/Mic92/python-mpd2\n :alt: Build Status\n\n*python-mpd2* is a Python library which provides a client interface for\nthe `Music Player Daemon <http://musicpd.org>`__.\n\n\nDifference with python-mpd\n--------------------------\n\npython-mpd2 is a fork of `python-mpd`_. While 0.4.x was backwards compatible\nwith python-mpd, starting with 0.5 provides enhanced features which are *NOT*\nbackward compatibles with the original `python-mpd`_ package (see `Porting\nGuide <https://python-mpd2.readthedocs.io/en/latest/topics/porting.html>`__\nfor more information).\n\nThe following features were added:\n\n- Python 3 support (but you need at least Python 3.6)\n- asyncio/twisted support\n- support for the client-to-client protocol\n- support for new commands from MPD (seekcur, prio, prioid,\n config, searchadd, searchaddpl, listfiles, rangeid, addtagid, cleartagid,\n mount, umount, listmounts, listneighbors)\n- remove deprecated commands (volume)\n- explicitly declared MPD commands (which is handy when using for\n example `IPython <http://ipython.org>`__)\n- a test suite\n- API documentation to add new commands (see `Future Compatible <https://python-mpd2.readthedocs.io/en/latest/topics/advanced.html#future-compatible>`__)\n- support for Unicode strings in all commands (optionally in python2,\n default in python3 - see `Unicode Handling <https://python-mpd2.readthedocs.io/en/latest/topics/advanced.html#unicode-handling>`__)\n- configurable timeouts\n- support for `logging <https://python-mpd2.readthedocs.io/en/latest/topics/logging.html>`__\n- improved support for sticker\n- improved support for ranges\n\n\nGetting the latest source code\n------------------------------\n\nIf you would like to use the latest source code, you can grab a\ncopy of the development version from Git by running the command::\n\n $ git clone https://github.com/Mic92/python-mpd2.git\n\n\nGetting the latest release\n--------------------------\n\nThe latest stable release of *python-mpd2* can be found on\n`PyPI <http://pypi.python.org/pypi?:action=display&name=python-mpd2>`__\n\n\nPyPI:\n~~~~~\n\n::\n\n $ pip install python-mpd2\n\n\nInstallation in Linux/BSD distributions\n~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~\n\nUntil Linux distributions adapt this package, here are some ready to use\npackages to test your applications:\n\nSee `INSTALL.rst <INSTALL.rst>`__\n\n\nInstalling from source\n----------------------\n\nTo install *python-mpd2* from source, simply run the command::\n\n $ python setup.py install\n\nYou can use the *--help* switch to *setup.py* for a complete list of commands\nand their options. See the `Installing Python Modules <http://docs.python.org/inst/inst.html>`__ document for more details.\n\n\nDocumentation\n-------------\n\n`Documentation <https://python-mpd2.readthedocs.io/en/latest/>`__\n\n`Getting Started <https://python-mpd2.readthedocs.io/en/latest/topics/getting-started.html>`__\n\n`Command Reference <https://python-mpd2.readthedocs.io/en/latest/topics/commands.html>`__\n\n`Examples <examples>`__\n\n\nTesting\n-------\n\nJust run::\n\n $ python setup.py test\n\nThis will install `Tox <http://tox.testrun.org/>`__. Tox will take care of\ntesting against all the supported Python versions (at least available) on our\ncomputer, with the required dependencies\n\nIf you have nix, you can also use the provided `default.nix` to bring all supported\npython versions in scope using `nix-shell`. In that case run `tox` directly instead\nof using `setup.py`::\n\n $ nix-shell --command 'tox'\n\n\nBuilding Documentation\n----------------------\n\nInstall Sphinx::\n\n $ pip install Sphinx\n\nChange to the source directory and run::\n\n $ python ./setup.py build_sphinx\n\nThe command reference is generated from the official mpd protocol documentation.\nIn order to update it, install python-lxml and run the following command::\n\n $ python ./doc/generate_command_reference.py > ./doc/topics/commands.rst\n\n\n.. _python-mpd: https://pypi.python.org/pypi/python-mpd/\n",
"bugtrack_url": null,
"license": "GNU Lesser General Public License v3 (LGPLv3)",
"summary": "A Python MPD client library",
"version": "3.1.1",
"project_urls": {
"Homepage": "https://github.com/Mic92/python-mpd2"
},
"split_keywords": [
"mpd"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "8e6d1b9e1c203057c9a7fa6971db3605188a8ef1120ca305e4878c960ab6e2d3",
"md5": "4d13bc899532f70ed294a44a2ce73cd0",
"sha256": "86bf1100a0b135959d74a9a7a58cf0515bf30bb54eb25ae6fb8e175e50300fc3"
},
"downloads": -1,
"filename": "python_mpd2-3.1.1-py2.py3-none-any.whl",
"has_sig": false,
"md5_digest": "4d13bc899532f70ed294a44a2ce73cd0",
"packagetype": "bdist_wheel",
"python_version": "py2.py3",
"requires_python": ">=3.6",
"size": 35050,
"upload_time": "2024-01-13T11:47:40",
"upload_time_iso_8601": "2024-01-13T11:47:40.013630Z",
"url": "https://files.pythonhosted.org/packages/8e/6d/1b9e1c203057c9a7fa6971db3605188a8ef1120ca305e4878c960ab6e2d3/python_mpd2-3.1.1-py2.py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "53bee77206eb35eb37ccd3506fba237e1431431d04c482707730ce2a6802e95c",
"md5": "b218d6f233c23da0bc82c372308bbf8d",
"sha256": "4baec3584cc43ed9948d5559079fafc2679b06b2ade273e909b3582654b2b3f5"
},
"downloads": -1,
"filename": "python-mpd2-3.1.1.tar.gz",
"has_sig": false,
"md5_digest": "b218d6f233c23da0bc82c372308bbf8d",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.6",
"size": 58713,
"upload_time": "2024-01-13T11:47:42",
"upload_time_iso_8601": "2024-01-13T11:47:42.032520Z",
"url": "https://files.pythonhosted.org/packages/53/be/e77206eb35eb37ccd3506fba237e1431431d04c482707730ce2a6802e95c/python-mpd2-3.1.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-01-13 11:47:42",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "Mic92",
"github_project": "python-mpd2",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"tox": true,
"lcname": "python-mpd2"
}
JSON
