diff --git a/docs/source/cli.rst b/docs/source/cli.rst index 8940bae..7725368 100644 --- a/docs/source/cli.rst +++ b/docs/source/cli.rst @@ -3,7 +3,7 @@ Command Line Utility Help:: - Usage: pysqueezecenter or type pysqueezecenter -h (--help) for help + Usage: pylms or type pylms -h (--help) for help Options: --version show program's version number and exit @@ -13,8 +13,8 @@ Help:: [default: 3] -l LOGFILE, --logfile=LOGFILE Log to file instead of console - -s HOST, --host=HOST Specify Hostname of SqueezeCenter [default: localhost] - -n PORT, --port=PORT Specify Port of SqueezeCenter [default: 9090] + -s HOST, --host=HOST Specify Hostname of Server [default: localhost] + -n PORT, --port=PORT Specify Port of Server [default: 9090] -u USERNAME, --username=USERNAME Specify Authorisation Username -p PASSWORD, --password=PASSWORD diff --git a/docs/source/conf.py b/docs/source/conf.py index a88b654..a5aeb7d 100644 --- a/docs/source/conf.py +++ b/docs/source/conf.py @@ -64,17 +64,17 @@ def __getattr__(self, name): master_doc = 'index' # General information about the project. -project = u'PySqueezeCenter' -copyright = u'2010, Louis King & Tanguy Bonneau' +project = u'PyLMS' +copyright = u'' # The version info for the project you're documenting, acts as replacement for # |version| and |release|, also used in various other places throughout the # built documents. # # The short X.Y version. -version = '0.94' +version = '1.00' # The full version, including alpha/beta/rc tags. -release = '0.94' +release = '1.00' # The language for content autogenerated by Sphinx. Refer to documentation # for a list of supported languages. @@ -176,7 +176,7 @@ def __getattr__(self, name): #html_file_suffix = '' # Output file base name for HTML help builder. -htmlhelp_basename = 'PySqueezeCenterDoc' +htmlhelp_basename = 'PyLMSDoc' # Options for LaTeX output @@ -191,8 +191,8 @@ def __getattr__(self, name): # Grouping the document tree into LaTeX files. List of tuples # (source start file, target name, title, author, document class [howto/manual]). latex_documents = [ - ('index', 'PySqueezeCenter.tex', ur'PySqueezeCenter Documentation', - ur'Louis King', 'manual'), + ('index', 'PyLMS.tex', ur'PyLMS Documentation', + ur'Various', 'manual'), ] # The name of an image file (relative to this directory) to place at the top of diff --git a/docs/source/index.rst b/docs/source/index.rst index 331a994..cd3da83 100644 --- a/docs/source/index.rst +++ b/docs/source/index.rst @@ -1,8 +1,8 @@ -PySqueezeCenter Documentation -============================= +PyLMS Documentation +=================== -PySqueezeCenter is a Python wrapper library for communication with a -Logitech SqueezeCenter CLI (Telnet) interface. Once connected, it is +PyLMS is a Python wrapper library for communication with a +Logitech Media Server CLI (Telnet) interface. Once connected, it is possible to control the server and any compatible Logitech SqueezeBox devices associated with it. diff --git a/docs/source/player.rst b/docs/source/player.rst index 15bd9f8..bd5a0cf 100644 --- a/docs/source/player.rst +++ b/docs/source/player.rst @@ -1,13 +1,13 @@ -Player Class (pysqueezecenter.player.Player) +Player Class (pylms.player.Player) ============================================ -The Player class allows individual control of any Logitech SqueezeCenter compatible -devices that are connected and registered with the SqueezeCenter server. +The Player class allows individual control of any Logitech Media Server compatible +devices that are connected and registered with the server. -Any function calls made by the Player are communicated to the SqueezeCenter Telnet server -via the parent Server (pysqueezecenter.server.Server) class. +Any function calls made by the Player are communicated to the Logitech Media Server Telnet server +via the parent Server (pylms.server.Server) class. -.. autoclass:: pysqueezecenter.player.Player +.. autoclass:: pylms.player.Player :members: :undoc-members: diff --git a/docs/source/server.rst b/docs/source/server.rst index 9a03e70..ffd57ec 100644 --- a/docs/source/server.rst +++ b/docs/source/server.rst @@ -1,11 +1,11 @@ -Server Class (pysqueezecenter.player.Server) +Server Class (pylms.player.Server) ============================================ -The Server class deals with the SqueezeCenter server and provides the main -communication functions between the PySqueezeCenter API and the SqueezeCenter's +The Server class deals with the Logitech Media server and provides the main +communication functions between the PyLMS API and the Logitech Media Server's Telnet server. -.. autoclass:: pysqueezecenter.server.Server +.. autoclass:: pylms.server.Server :members: :undoc-members: diff --git a/docs/source/utils.rst b/docs/source/utils.rst index c41ae8a..ccc17d2 100644 --- a/docs/source/utils.rst +++ b/docs/source/utils.rst @@ -1,10 +1,10 @@ -Utility Functions (pysqueezecenter.utils) +Utility Functions (pylms.utils) ========================================= The module contains several utility functions used throughout the library. -.. autoclass:: pysqueezecenter.utils +.. autoclass:: pylms.utils :members: :undoc-members: diff --git a/setup.py b/setup.py index f57c73a..83f0aaa 100644 --- a/setup.py +++ b/setup.py @@ -9,20 +9,23 @@ description="PyLMS (Python Logitech Media Server API Library)", author="JingleManSweep", author_email="jinglemansweep@gmail.com", - url="http://www.louisking.co.uk", + url="https://github.com/jingleman/PyLMS", packages = ["pylms"], scripts = [os.path.join("bin", "pylms"),], test_suite = "nose.collector", install_requires = [], long_description="""Python Wrapper Library for Logitech Media Server CLI (Telnet) Interface""", classifiers=[ - "Development Status :: 2 - Pre-Alpha", + "Development Status :: 5 - Production/Stable", "Environment :: Console", "Intended Audience :: Developers", "Intended Audience :: End Users/Desktop", "License :: OSI Approved :: GNU General Public License (GPL)", "Natural Language :: English", "Operating System :: POSIX :: Linux", - "Programming Language :: Python :: 2.5", + "Operating System :: Microsoft :: Windows", + "Operating System :: MacOS :: MacOS X", + "Programming Language :: Python :: 2", + "Programming Language :: Python :: 3" ] )