amps-python-client 5.3.4.1__zip

amps-python-client-5.3.4.1/HISTORY

@@ -0,0 +1,7 @@
+The release note history for the AMPS Python client, including for this release,
+is available on the 60East website.
+
+See http://www.crankuptheamps.com/history/python.html for the release note
+history for the AMPS Python client.
+
+The complete index of available history files is at http://www.crankuptheamps.com/history/index.html

amps-python-client-5.3.4.1/LICENSE

@@ -0,0 +1,157 @@
+API License Agreement
+
+IMPORTANT - READ THIS CAREFULLY BEFORE INSTALLING, USING OR ELECTRONICALLY
+ACCESSING THIS PROPRIETARY PRODUCT. THIS API LICENSE AGREEMENT ("AGREEMENT") IS
+A LEGAL AGREEMENT BETWEEN 60EAST TECHNOLOGIES, INC. ("60EAST") AND THE BUSINESS
+ENTITY ON WHOSE BEHALF YOU ("YOU") ARE ACTING ("CUSTOMER") AS THE END USER OF
+THE 60EAST CLIENT APPLICATION PROGRAMING INTERFACE SOFTWARE CODE ACCOMPANYING
+THIS AGREEMENT, WHICH INCLUDES OBJECT CODE AND SOURCE CODE AND MAY INCLUDE
+ASSOCIATED MEDIA, PRINTED MATERIALS AND DOCUMENTATION (COLLECTIVELY, THE "CLIENT
+API").  THE CLIENT API ALSO INCLUDES ANY UPDATES OR UPGRADES TO OR NEW VERSIONS
+OF THE ORIGINAL CLIENT API, IF AND WHEN MADE AVAILABLE TO YOU BY 60EAST.
+
+YOU AGREE THAT YOU ARE AN EMPLOYEE OR AGENT OF CUSTOMER AND ARE ENTERING INTO
+THIS AGREEMENT TO USE THE CLIENT API FOR CUSTOMER'S OWN BUSINESS PURPOSES.  YOU
+HEREBY AGREE THAT YOU ENTER INTO THIS AGREEMENT ON BEHALF OF CUSTOMER AND THAT
+YOU HAVE THE AUTHORITY TO BIND CUSTOMER TO THE TERMS AND CONDITIONS OF THIS
+AGREEMENT.
+
+60EAST IS WILLING TO LICENSE THE CLIENT API TO CUSTOMER ONLY ON THE CONDITION
+THAT YOU ACCEPT ALL OF THE TERMS IN THIS AGREEMENT.  IF YOU ARE ACCESSING THE
+CLIENT API ELECTRONICALLY AND YOU AGREE TO THE TERMS OF THIS AGREEMENT, SELECT
+THE "I AGREE", "I ACCEPT", OR "YES" BUTTON BENEATH THIS AGREEMENT TO COMPLETE
+YOUR ACCESS TO THE CLIENT API.  BY INSTALLING, DOWNLOADING, CONFIGURING,
+ACCESSING, OR OTHERWISE USING THE CLIENT API, INCLUDING ANY UPDATES, UPGRADES,
+OR NEWER VERSIONS, YOU ACKNOWLEDGE THAT YOU HAVE READ THIS AGREEMENT, UNDERSTAND
+THIS AGREEMENT, AND THAT CUSTOMER AGREES TO BE BOUND BY ALL OF THE TERMS OF
+THIS AGREEMENT.
+
+1. License Grant.  Subject to the terms of this Agreement, 60East grants to
+Customer, during the Term, a limited, revocable, non-exclusive,
+non-transferable, non-sublicensable license to install and use the Client API
+solely to (a) download and integrate "package manager" sites from development
+environments into a Customer application and (b) enable a Customer application
+to interact with 60East's AMPS Software ("AMPS") solely for Customer's own
+internal business purpose in accordance with the Client API documentation and
+other terms and conditions of this Agreement.  Customer may make a reasonable
+number of copies of the Client API solely for the purpose of interacting with
+AMPS for Customer's internal business purposes.
+
+2. Restrictions on Use.  Customer is responsible for all activities that occur
+in connection with the Client API.  Customer acknowledges that the Client API
+and the structure, organization, and source code thereof constitute valuable
+trade secrets of 60East.  Accordingly, except as expressly permitted in
+Section 1 or as otherwise authorized by 60East in writing, Customer will not,
+and will not permit any third party to (a) modify, adapt, alter, translate, or
+create derivative works from the Client API; (b) sublicense, lease, rent, loan,
+sell, distribute, make available or otherwise transfer the Client API to any
+third party; (c) reverse engineer, decompile, disassemble, or otherwise attempt
+to derive the source code for the Client API; or (d) otherwise use or copy the
+Client API except as expressly allowed under Section 1 above.  Customer may not
+disclose to third parties or through publication the results of
+performance/benchmark tests run on the Client API without the prior written
+consent of 60East.
+
+3. Delivery and Acceptance.  The Client API will be delivered electronically
+pursuant to 60East standard download procedures.  The Client API is deemed
+accepted upon delivery.
+
+4. Ownership.  As between the parties, the Client API and all modifications and
+improvements to the Client API, and all worldwide intellectual property rights
+and proprietary rights relating thereto or embodied therein, are the exclusive
+property of 60East and its suppliers.  60East and its suppliers reserve all
+rights in and to the Client API not expressly granted to Customer in Section 1,
+and no other licenses or rights are granted by implication, estoppel or
+otherwise.
+
+5. Implementation and Support.  60East has no obligation under this Agreement to
+provide any support or consultation concerning the Client API; provided,
+however, 60East may, in its sole discretion, provide Customer with certain
+support and consultation free of charge to assist in the permitted activities of
+Customer under this Agreement. The furnishing of such support or consultation
+will not subject 60East to any liability, whether in contract, tort or
+otherwise.  Customer is responsible for providing all applicable hardware and
+any third party software or required installation and configuration services
+required for the operation of the Client API.  Any third party software license
+agreements will be agreed to by Customer and the applicable third party software
+vendor.
+
+6. Term and Termination.  This Agreement is effective upon acceptance by
+Customer and shall continue until terminated in accordance with this Agreement.
+Customer may terminate this Agreement at any time by destroying the Client API
+and notifying 60East at:  sales@crankuptheamps.com.  If Customer breaches any
+provision of this Agreement, this Agreement will automatically terminate.  The
+provisions of Sections 2, 4, 6, 7, 8, 9, 10, 11, and 12 shall survive
+termination or expiration of this Agreement for any reason.
+
+7. Confidentiality.  60East may disclose certain information regarding the
+business of 60East and its suppliers, including the Client API and technical,
+marketing, financial, employee, planning, and other confidential or proprietary
+information of 60East or its suppliers ("Confidential Information"). Any
+information that Customer knew or should have known, under the circumstances,
+was considered confidential or proprietary by 60East will be considered
+Confidential Information. Customer agrees (a) not to disclose Confidential
+information to any persons outside its organization, except to its consultants
+or agents who agree in writing to protect such Confidential information as
+required herein; and (b) to use the Confidential information only for the
+purpose of using the Client API as permitted by this Agreement.
+
+8. Disclaimer.  CUSTOMER ACKNOWLEDGES AND AGREES THAT CUSTOMER'S USE OF THE
+CLIENT API IS ENTIRELY AT ITS OWN RISK AND THE CLIENT API PROVIDED BY 60EAST TO
+CUSTOMER IS PROVIDED "AS IS" WITHOUT ANY WARRANTY OF ANY KIND WHATSOEVER.
+60EAST, ON BEHALF OF ITSELF AND ITS SUPPLIERS, HEREBY EXPRESSLY DISCLAIMS ALL
+WARRANTIES WITH REGARD TO THE CLIENT API, WHETHER EXPRESS, IMPLIED, STATUTORY OR
+OTHERWISE, INCLUDING, WITHOUT LIMITATION, ANY IMPLIED WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, TITLE NON-INFRINGEMENT AND
+ANY WARRANTIES ARISING FROM COURSE OF DEALING OR COURSE OF PERFORMANCE. TO THE
+EXTENT THAT, AS A MATTER OF APPLICABLE LAW, ANY IMPLIED OR STATUTORY WARRANTY
+MAY NOT BE DISCLAIMED, THE DURATION AND SCOPE OF SUCH WARRANTY SHALL BE THE
+MINIMUM PERMISSIBLE UNDER SUCH APPLICABLE LAW.
+
+9. Limitation of Liability.  IN NO EVENT WILL 60EAST BE LIABLE FOR ANY
+CONSEQUENTIAL, INDIRECT, EXEMPLARY, PUNITIVE, SPECIAL OR INCIDENTAL DAMAGES,
+INCLUDING ANY LOST DATA AND LOST PROFITS, ARISING FROM OR RELATING TO THE CLIENT
+API OR THIS AGREEMENT, EVEN IF 60EAST HAS BEEN ADVISED OF THE POSSIBILITY OF
+SUCH DAMAGES. 60EAST'S TOTAL CUMULATIVE LIABILITY IN CONNECTION WITH THIS
+AGREEMENT AND THE CLIENT API, WHETHER IN CONTRACT OR TORT OR OTHERWISE, WILL NOT
+EXCEED $1000. CUSTOMER ACKNOWLEDGES THAT THIS PROVISION REFLECTS THE AGREED UPON
+ALLOCATION OF RISK FOR THIS AGREEMENT AND THAT 60EAST WOULD NOT ENTER INTO THIS
+AGREEMENT WITHOUT THESE LIMITATIONS ON ITS LIABILITY.
+
+10. Compliance with Laws.  Customer shall comply with all laws, regulations,
+rules, ordinances and orders applicable to its use of the Client API. Without
+limiting the foregoing, Customer shall comply with the relevant export
+administration and control laws and regulations, as may be amended from time to
+time, including, without limitation, the United States Export Administration
+Act, to ensure that the Client API is not shipped, transferred or exported
+(directly or indirectly) in violation of U.S. law.
+
+11. U.S. Government End Users.  The Client API is a "commercial item" as that
+term is defined at 48 C.F.R. 2.101, consisting of "commercial computer software"
+and "commercial computer software documentation" as such terms are used in 48
+C.F.R. 12.212. Consistent with 48 C.F.R. 12.212 and 48 C.F.R. 227.7202-1 through
+227.7202-4, all U.S. Government end users acquire the Client API with only those
+rights set forth therein.
+
+12. Miscellaneous.  Customer may not assign or delegate, directly or indirectly,
+by operation of law or otherwise, this Agreement or any of its rights or
+obligations under this Agreement (including the license rights granted to
+Customer to the Client API) to any third party.  Any attempted assignment or
+transfer in violation of the foregoing will be null and void and of no effect.
+This Agreement will be subject to and governed by the laws of the State of
+Nevada and the United States of America without regard for its conflicts of law
+principles that would require application of the laws of a different state or
+country. The federal and state courts for Clark County Nevada shall have
+jurisdiction over any disputes, claims or controversies arising out of or
+relating to this Agreement, and Customer hereby irrevocably waives any objection
+to the jurisdiction of such courts over any such dispute, claim or controversy.
+All modifications, waivers and amendments must be in writing and signed by both
+parties. Any waiver or failure to enforce any provision of this Agreement on one
+occasion will not be deemed a waiver of any other provision or of such provision
+on any other occasion. If any provision of this Agreement is held by a court of
+competent jurisdiction to be unenforceable for any reason, the remaining
+provisions hereof shall be unaffected and continue in full force and effect.
+This Agreement constitutes the entire agreement between the parties regarding
+the subject hereof and supersedes all prior or contemporaneous agreements,
+understandings and communications, whether written or oral.
+

amps-python-client-5.3.4.1/PKG-INFO

@@ -0,0 +1,112 @@
+Metadata-Version: 2.1
+Name: amps-python-client
+Version: 5.3.4.1
+Summary: AMPS Python Client
+Home-page: https://crankuptheamps.com
+Maintainer: 60East Technologies, Incorporated
+Maintainer-email: support@crankuptheamps.com
+License: Commercial/Proprietary :: see LICENSE
+Platform: Linux
+Platform: Windows
+Classifier: License :: Other/Proprietary License
+Description-Content-Type: text/markdown
+License-File: LICENSE
+
+AMPS Python Client
+==================
+
+Introduction
+------------
+
+The AMPS Python Client is a Python extension module that makes it easy to connect to AMPS. This client builds upon the AMPS C++ Client and Python/C api to bring high performance AMPS connectivity to Python code.
+
+
+Prerequisites
+-------------
+
+To use the AMPS Python Client, you must have the following software installed and configured on your system:
+
+* Python 2.7 or Python 3.5 and above.
+* Python distutils. Most python installations build and include this package by default, but you may run into issues building this extension module if distutils is not functioning properly on your system.
+  Python distutils may be packaged in a standalone package named 'python-distutils', or included in 'python-devel.x86_64'. You can also run the setup script available [here](http://peak.telecommunity.com/dist/ez_setup.py).
+* C++ compiler. gcc 4.4 or greater on Linux, or a verion of Visual Studio with Mainstream Support from Microsoft (please
+  refer to Microsoft product lifecycle policies) on Windows. Note that this must be the same compiler used to build your
+  python distribution, else python distutils may be unable to invoke your compiler.
+
+
+Fedora prerequisites:
+1. dnf install redhat-rpm-config
+2. dnf install python-devel  # for use with Python2
+3. dnf install python3-devel # for use with Python3
+4. dnf install gcc-c++
+
+Building From a Git Clone
+-------------------------
+
+If you obtained this client by a git clone of the 60East amps-client-python repository, you also need to fetch the correct version of the 
+AMPS C++ client submodule. To do this, issue a git submodule command to initialize and update the src/cpp submodule. One easy
+way to do this is by issuing the command:
+
+    git submodule update --init
+
+which will initialize and update the submodule in one step. Note that working with submodules in git requires extra care. Visit
+[this chapter](http://git-scm.com/book/en/Git-Tools-Submodules) to learn more about git submodules.
+
+Build
+-----
+
+This client is distributed as source code and must be compiled before it is used. The build process emits a shared library
+(or DLL on Windows) that can be imported into your python application.
+
+### To build on Linux:
+
+1. Run `python setup.py build` from the AMPS Python Client directory to build the client.
+
+   This script uses Python distutils to build the client library. Python distutils provides many additional options for installing the built library into your Python distribution, or
+   otherwise controlling the output of the build process. Run `python setup.py --help` to view command help.
+
+2. Check under the `build` directory for `AMPS.so` -- this is the Python extension module. Ensure this library's directory is in your PYTHONPATH.
+
+3. To test, run `python -c "import AMPS"`.  If any errors occur importing the AMPS module, validate that the module built properly, and that the containing directory is in your PYTHONPATH.
+
+### To build on Windows:
+
+1. Use a Visual Studio Command Prompt to create a command prompt where the necessary Visual Studio environment variables are set for command line builds.
+
+2. Add the Python directory (the location of the python.exe interpreter) to your path.
+   *Note:* The platform of your python installation must match the target platform for this python module. If you want to
+   build a 64-bit module, you must set your PATH to a 64-bit Python installation; for a 32-bit module, you must set it to
+   a 32-bit installation. If you'd like to build both, you must do so separately, once with each Python installation.
+3. Run `python setup.py build` fom the AMPS Python Client directory to build the client module. Use the `-p win32` option to build a 32-bit client module.
+4. Check under the `build` directory for `AMPS.pyd` -- this is the Python extension module. Ensure this library's directory is in your PYTHONPATH.
+5. To test, run `python -c "import AMPS"`. If any errors occur importing the AMPS module, validate that the module built properly, and that the containing directory is in your PYTHONPATH.
+
+Installing the Python Binary Wheel
+----------------------------------
+
+60East also provides Linux-x86-64 and Windows 64-bit binary wheels built with Python 2.7 and for Python 3.x.
+These wheel files are provided on the 60East website.
+
+If your system is not Linux-x86-64, or you are not using Python 2.6, you can generate your own egg by running 'python setup.py bdist_wheel'.
+
+## Installing:
+
+1. Download the wheel file from the 60East client release page.
+
+2. run 'python -m pip install *.whl'.
+
+Troubleshooting Build Problems
+------------------------------
+
+Symptom: Python.h not found
+
+Resolution: Update or install python distutils. See the entry on python distutils in the prequisites section for information on installing this package.
+
+
+For More Information
+--------------------
+
+The developer's guide and generated reference documentation for this client are available under the doc/ directory.
+
+
+

amps-python-client-5.3.4.1/README.md

@@ -0,0 +1,96 @@
+AMPS Python Client
+==================
+
+Introduction
+------------
+
+The AMPS Python Client is a Python extension module that makes it easy to connect to AMPS. This client builds upon the AMPS C++ Client and Python/C api to bring high performance AMPS connectivity to Python code.
+
+
+Prerequisites
+-------------
+
+To use the AMPS Python Client, you must have the following software installed and configured on your system:
+
+* Python 2.7 or Python 3.5 and above.
+* Python distutils. Most python installations build and include this package by default, but you may run into issues building this extension module if distutils is not functioning properly on your system.
+  Python distutils may be packaged in a standalone package named 'python-distutils', or included in 'python-devel.x86_64'. You can also run the setup script available [here](http://peak.telecommunity.com/dist/ez_setup.py).
+* C++ compiler. gcc 4.4 or greater on Linux, or a verion of Visual Studio with Mainstream Support from Microsoft (please
+  refer to Microsoft product lifecycle policies) on Windows. Note that this must be the same compiler used to build your
+  python distribution, else python distutils may be unable to invoke your compiler.
+
+
+Fedora prerequisites:
+1. dnf install redhat-rpm-config
+2. dnf install python-devel  # for use with Python2
+3. dnf install python3-devel # for use with Python3
+4. dnf install gcc-c++
+
+Building From a Git Clone
+-------------------------
+
+If you obtained this client by a git clone of the 60East amps-client-python repository, you also need to fetch the correct version of the 
+AMPS C++ client submodule. To do this, issue a git submodule command to initialize and update the src/cpp submodule. One easy
+way to do this is by issuing the command:
+
+    git submodule update --init
+
+which will initialize and update the submodule in one step. Note that working with submodules in git requires extra care. Visit
+[this chapter](http://git-scm.com/book/en/Git-Tools-Submodules) to learn more about git submodules.
+
+Build
+-----
+
+This client is distributed as source code and must be compiled before it is used. The build process emits a shared library
+(or DLL on Windows) that can be imported into your python application.
+
+### To build on Linux:
+
+1. Run `python setup.py build` from the AMPS Python Client directory to build the client.
+
+   This script uses Python distutils to build the client library. Python distutils provides many additional options for installing the built library into your Python distribution, or
+   otherwise controlling the output of the build process. Run `python setup.py --help` to view command help.
+
+2. Check under the `build` directory for `AMPS.so` -- this is the Python extension module. Ensure this library's directory is in your PYTHONPATH.
+
+3. To test, run `python -c "import AMPS"`.  If any errors occur importing the AMPS module, validate that the module built properly, and that the containing directory is in your PYTHONPATH.
+
+### To build on Windows:
+
+1. Use a Visual Studio Command Prompt to create a command prompt where the necessary Visual Studio environment variables are set for command line builds.
+
+2. Add the Python directory (the location of the python.exe interpreter) to your path.
+   *Note:* The platform of your python installation must match the target platform for this python module. If you want to
+   build a 64-bit module, you must set your PATH to a 64-bit Python installation; for a 32-bit module, you must set it to
+   a 32-bit installation. If you'd like to build both, you must do so separately, once with each Python installation.
+3. Run `python setup.py build` fom the AMPS Python Client directory to build the client module. Use the `-p win32` option to build a 32-bit client module.
+4. Check under the `build` directory for `AMPS.pyd` -- this is the Python extension module. Ensure this library's directory is in your PYTHONPATH.
+5. To test, run `python -c "import AMPS"`. If any errors occur importing the AMPS module, validate that the module built properly, and that the containing directory is in your PYTHONPATH.
+
+Installing the Python Binary Wheel
+----------------------------------
+
+60East also provides Linux-x86-64 and Windows 64-bit binary wheels built with Python 2.7 and for Python 3.x.
+These wheel files are provided on the 60East website.
+
+If your system is not Linux-x86-64, or you are not using Python 2.6, you can generate your own egg by running 'python setup.py bdist_wheel'.
+
+## Installing:
+
+1. Download the wheel file from the 60East client release page.
+
+2. run 'python -m pip install *.whl'.
+
+Troubleshooting Build Problems
+------------------------------
+
+Symptom: Python.h not found
+
+Resolution: Update or install python distutils. See the entry on python distutils in the prequisites section for information on installing this package.
+
+
+For More Information
+--------------------
+
+The developer's guide and generated reference documentation for this client are available under the doc/ directory.
+

amps-python-client-5.3.4.1/docs/command-reference/html/.buildinfo

@@ -0,0 +1,4 @@
+# Sphinx build info version 1
+# This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done.
+config: 951caf5bd819336a64039cd238b22ebf
+tags: 645f666f9bcd5a90fca523b33c5a78b7

amps-python-client-5.3.4.1/docs/command-reference/html/_images/caution.svg

@@ -0,0 +1,25 @@
+<?xml version="1.0" encoding="iso-8859-1"?>
+<!-- Generator: Adobe Illustrator 9.0, SVG Export Plug-In  -->
+<!DOCTYPE svg [
+	<!ENTITY st0 "fill:#FFFFFF;stroke:none;">
+	<!ENTITY st1 "fill:#FFFFFF;stroke-width:6.6112;stroke-linecap:round;stroke-linejoin:round;">
+	<!ENTITY st2 "stroke:#FFFFFF;stroke-width:6.6112;">
+	<!ENTITY st3 "fill:none;stroke:none;">
+	<!ENTITY st4 "fill-rule:nonzero;clip-rule:nonzero;stroke:#000000;stroke-miterlimit:4;">
+	<!ENTITY st5 "stroke:none;">
+]>
+<svg  width="48pt" height="48pt" viewBox="0 0 48 48" xml:space="preserve" xmlns="http://www.w3.org/2000/svg">
+	<g id="Layer_x0020_3" style="&st4;">
+		<g>
+			<path style="&st2;" d="M41.7,35.3L26.6,9.4c-0.6-1-1.7-1.7-2.9-1.6c-1.2,0-2.3,0.7-2.9,1.7L6.3,35.4c-0.6,1-0.6,2.3,0,3.3c0.6,1,1.7,1.6,2.9,1.6h29.6c1.2,0,2.3-0.6,2.9-1.7c0.6-1,0.6-2.3,0-3.3z"/>
+			<path style="&st1;" d="M23.7,11L9.2,37h29.6L23.7,11z"/>
+			<path style="&st0;" d="M23.7,11.9L10.3,36.1h27.5l-14-24.1z"/>
+			<g>
+				<path style="&st5;" d="M24.1,34c-1.1,0-1.8-0.8-1.8-1.8c0-1.1,0.7-1.8,1.8-1.8c1.1,0,1.8,0.7,1.8,1.8c0,1-0.7,1.8-1.8,1.8h0z M22.9,29.3l-0.4-9.1h3.2l-0.4,9.1h-2.3z"/>
+			</g>
+		</g>
+	</g>
+	<g id="crop_x0020_marks" style="&st4;">
+		<path style="&st3;" d="M48,48H0V0h48v48z"/>
+	</g>
+</svg>

amps-python-client-5.3.4.1/docs/command-reference/html/_sources/chapters/ack-messages.rst.txt

@@ -0,0 +1,32 @@
+.. _#command-guide-ack-messages:
+
+Ack Messages
+=================
+
+AMPS provides information to the application and
+AMPS client about the status of commands using
+acknowledgement, or ``ack``, messages.
+
+A command to AMPS must explicitly request
+acknowledgement to receive a response from AMPS.
+By default, the AMPS client libraries request
+acknowledgements as needed to detect failures:
+see the *AMPS User Guide* chapter on
+acknowledgements and the *Developer Guide*
+for each client language for details.
+
+In some cases, an application may want additional
+information about the state of a command, and may
+request an ``ack`` explicitly.  For example,
+an application may want to know how many records
+would be returned by a particular query. In that
+case, a common technique is to request a ``stats``
+(statistics) ``ack``, while setting the number
+of data messages to be returned to ``0`` (using
+the ``top_n=0`` option).
+
+This section describes the ``ack`` messages
+returned by AMPS.
+
+.. include:: ./ack-messages/ack.inc
+

amps-python-client-5.3.4.1/docs/command-reference/html/_sources/chapters/content-messages.rst.txt

@@ -0,0 +1,27 @@
+.. _#command-guide-content-response:
+
+Content Messages
+====================
+
+AMPS provides three types of message that contain message content:
+
+-  ``publish`` messages return data from a topic as it is published, in
+   order, whether the data is being published live, or is the result of
+   a replay
+
+-  ``sow`` messages return data from a SOW query. These messages return
+   the state of messages that are current as of the time for the query.
+   By default, the messages are returned without regard to the order in
+   which the messages were published. A query can specify the order of
+   the returned messages based on the data within the message by
+   including the OrderBy header on the SOW query.
+
+-  ``oof`` messages indicate that a content message no longer matches a
+   subscription. These messages are sent to a client in order.
+
+.. include:: ./content-messages/content_publish.inc
+
+.. include:: ./content-messages-sow.inc
+
+.. include:: ./content-messages/oof.inc
+

amps-python-client-5.3.4.1/docs/command-reference/html/_sources/chapters/intro.rst.txt

@@ -0,0 +1,43 @@
+.. _#command-guide-intro:
+
+Introduction
+===========================
+
+This guide includes a listing of all AMPS commands as well as the
+required and optional parameters. AMPS supports a consistent set of
+commands and options regardless of the protocol used to communicate with
+AMPS. This guide covers the semantics of the commands and options, but
+does not cover how those commands and options are represented in any
+particular protocol. Each protocol uses a different concrete format for
+messages, and that format is specific to the protocol.
+
+To use a command from your application, set the properties of the
+Command object as shown in this guide, the use the execute function to
+send the command. The AMPS client is responsible for interpreting the
+command and formatting the message to AMPS in the proper format for the
+specific protocol the client is using.
+
+This guide lists the available options and their usage.
+When using the AMPS client libraries (either with the
+named convenience methods or with the ``Command`` interface),
+your application only needs to specify a subset of
+options. The AMPS client itself will handle
+formatting the command, adding options necessary for
+submitting the command (such as requesting a response
+indicating if a subscription succeeded, and so forth).
+
+The Developer Guide for each language provides a
+cookbook for common commands to AMPS, and indicates
+which fields and options to set for those commands.
+
+.. tip::
+
+  The AMPS client libraries handle many of the details
+  for an application, such as handling heartbeating,
+  requesting acknowledgement on commands, and so on.
+
+  The Developer Guides for the AMPS client libraries include
+  a reference that lists the fields and options to
+  set to produce a specific result.
+
+