Skip to content

Commit

Permalink
Fixed documentation naming and updated setup classifiers
Browse files Browse the repository at this point in the history
  • Loading branch information
jinglemansweep committed Mar 17, 2012
1 parent 09efb5a commit 1b23bdb
Show file tree
Hide file tree
Showing 7 changed files with 32 additions and 29 deletions.
6 changes: 3 additions & 3 deletions docs/source/cli.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand All @@ -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
Expand Down
14 changes: 7 additions & 7 deletions docs/source/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down Expand Up @@ -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
Expand All @@ -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
Expand Down
8 changes: 4 additions & 4 deletions docs/source/index.rst
Original file line number Diff line number Diff line change
@@ -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.

Expand Down
12 changes: 6 additions & 6 deletions docs/source/player.rst
Original file line number Diff line number Diff line change
@@ -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:

8 changes: 4 additions & 4 deletions docs/source/server.rst
Original file line number Diff line number Diff line change
@@ -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:

4 changes: 2 additions & 2 deletions docs/source/utils.rst
Original file line number Diff line number Diff line change
@@ -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:

9 changes: 6 additions & 3 deletions setup.py
Original file line number Diff line number Diff line change
Expand Up @@ -9,20 +9,23 @@
description="PyLMS (Python Logitech Media Server API Library)",
author="JingleManSweep",
author_email="[email protected]",
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"
]
)

0 comments on commit 1b23bdb

Please sign in to comment.