amps-python-client 5.3.5.0__tar.gz → 5.3.5.2__tar.gz

{amps-python-client-5.3.5.0 → amps-python-client-5.3.5.2}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: amps-python-client
-Version: 5.3.5.0
+Version: 5.3.5.2
 Summary: AMPS Python Client
 Home-page: https://crankuptheamps.com
 Maintainer: 60East Technologies, Incorporated
@@ -21,8 +21,7 @@ Description: AMPS Python Client
         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).
+        * Python setuptools. Most python installations build and include this package by default, but you may run into issues building this extension module if setuptools is not functioning properly on your system.
         * 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.
@@ -59,7 +58,7 @@ Description: AMPS Python 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.
+        2. Check under the `build` directory for `AMPS.abi3.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.
         

{amps-python-client-5.3.5.0 → amps-python-client-5.3.5.2}/README.md

@@ -13,8 +13,7 @@ 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).
+* Python setuptools. Most python installations build and include this package by default, but you may run into issues building this extension module if setuptools is not functioning properly on your system.
 * 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.
@@ -51,7 +50,7 @@ This client is distributed as source code and must be compiled before it is used
    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.
+2. Check under the `build` directory for `AMPS.abi3.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.
 

{amps-python-client-5.3.5.0 → amps-python-client-5.3.5.2}/README.txt

@@ -16,12 +16,9 @@ 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).
+* Python setuptools. Most python installations build and include this package 
+by default, but you may run into issues building this extension module if 
+setuptools is not functioning properly on your system.
 * 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 
@@ -70,7 +67,7 @@ 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 
+2. Check under the `build` directory for `AMPS.abi3.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-python-client-5.3.5.2/docs/html/.buildinfo

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

amps-python-client-5.3.5.2/docs/html/_sources/index.rst.txt

@@ -0,0 +1,307 @@
+AMPS Python Client API Reference
+================================
+
+Introduction
+------------
+
+The AMPS Python client is the official library for working with AMPS from Python applications. It provides a straightforward
+way to establish connections, publish data, execute commands, and process message streams.
+
+Designed to align with Python development practices, the client offers a clear and consistent interface while exposing the
+underlying capabilities of AMPS. This makes it suitable for both simple integrations and more advanced messaging workflows.
+
+Basic Example
+^^^^^^^^^^^^^
+
+The example below shows a minimal publish flow using the Python client:
+
+.. code-block:: python
+
+   import AMPS
+   import sys
+
+   uri = "tcp://localhost:9007/amps/json"
+
+   client = AMPS.Client("publish-example")
+
+   try:
+       client.connect(uri)
+       client.logon()
+       client.publish("messages", '{"hi" : "Hello, world!"}')
+
+   except AMPS.AMPSException as e:
+       sys.stderr.write(str(e))
+
+   client.publish_flush()
+
+For details on how to start using the AMPS client and additional examples, see the
+`Quickstart page <https://crankuptheamps.com/clients/amps-client-python/quickstart>`_ in the
+AMPS Python Client Developer Guide.
+
+Core Types
+----------
+
+.. autoclass:: AMPS.Client
+   :members:
+   :member-order: groupwise
+
+.. autoclass:: AMPS.HAClient
+   :members:
+   :inherited-members:
+   :exclude-members: Bookmarks, ConnectionStateListener
+   :member-order: groupwise
+
+.. autoclass:: AMPS.Command
+   :members:
+   :member-order: groupwise
+
+.. autoclass:: AMPS.Message
+   :members:
+   :member-order: groupwise
+
+.. autoclass:: AMPS.MessageStream
+   :members:
+   :member-order: groupwise
+
+.. autoclass:: AMPS.VersionInfo
+   :members:
+   :member-order: groupwise
+
+Connection And Runtime Helpers
+------------------------------
+
+.. autoclass:: AMPS.DefaultAuthenticator
+   :members:
+   :member-order: groupwise
+
+.. autoclass:: AMPS.DefaultServerChooser
+   :members:
+   :member-order: groupwise
+
+.. autoclass:: AMPS.ExponentialDelayStrategy
+   :members:
+   :member-order: groupwise
+
+.. autoclass:: AMPS.FixedDelayStrategy
+   :members:
+   :member-order: groupwise
+
+.. autoclass:: AMPS.Reason
+   :members:
+   :member-order: groupwise
+
+.. autoclass:: AMPS.CMessageHandler
+   :members:
+   :member-order: groupwise
+
+Stores And Recovery
+-------------------
+
+.. autoclass:: AMPS.Store
+   :members:
+   :member-order: groupwise
+
+.. autoclass:: AMPS.PublishStore
+   :members:
+   :member-order: groupwise
+
+.. autoclass:: AMPS.MemoryPublishStore
+   :members:
+   :member-order: groupwise
+
+.. autoclass:: AMPS.HybridPublishStore
+   :members:
+   :member-order: groupwise
+
+.. autoclass:: AMPS.MemoryBookmarkStore
+   :members:
+   :member-order: groupwise
+
+.. autoclass:: AMPS.MMapBookmarkStore
+   :members:
+   :member-order: groupwise
+
+.. autoclass:: AMPS.RingBookmarkStore
+   :members:
+   :member-order: groupwise
+
+.. autoclass:: AMPS.RecoveryPoint
+   :members:
+   :member-order: groupwise
+
+.. autoclass:: AMPS.ConflatingRecoveryPointAdapter
+   :members:
+   :member-order: groupwise
+
+.. autoclass:: AMPS.SOWRecoveryPointAdapter
+   :members:
+   :member-order: groupwise
+
+Builders And Parsers
+--------------------
+
+.. autoclass:: AMPS.FIXBuilder
+   :members:
+   :member-order: groupwise
+
+.. autoclass:: AMPS.FIXShredder
+   :members:
+   :member-order: groupwise
+
+.. autoclass:: AMPS.NVFIXBuilder
+   :members:
+   :member-order: groupwise
+
+.. autoclass:: AMPS.NVFIXShredder
+   :members:
+   :member-order: groupwise
+
+.. autoclass:: AMPS.CompositeMessageBuilder
+   :members:
+   :member-order: groupwise
+
+.. autoclass:: AMPS.CompositeMessageParser
+   :members:
+   :member-order: groupwise
+
+Module Functions And Data
+-------------------------
+
+.. autofunction:: AMPS.ssl_get_context
+
+.. autofunction:: AMPS.ssl_init
+
+.. autofunction:: AMPS.ssl_load_verify_locations
+
+.. autofunction:: AMPS.ssl_set_verify
+
+.. autodata:: AMPS.VERSION
+
+Exception Classes
+-----------------
+
+.. autoexception:: AMPS.AMPSException
+
+.. autoexception:: AMPS.AlreadyConnected
+
+.. autoexception:: AMPS.AlreadyConnectedException
+
+.. autoexception:: AMPS.AuthenticationError
+
+.. autoexception:: AMPS.AuthenticationException
+
+.. autoexception:: AMPS.BadFilter
+
+.. autoexception:: AMPS.BadFilterException
+
+.. autoexception:: AMPS.BadRegexTopic
+
+.. autoexception:: AMPS.BadRegexTopicException
+
+.. autoexception:: AMPS.BadSowKeyException
+
+.. autoexception:: AMPS.ClientNameInUse
+
+.. autoexception:: AMPS.CommandError
+
+.. autoexception:: AMPS.CommandException
+
+.. autoexception:: AMPS.CommandTimedOut
+
+.. autoexception:: AMPS.CommandTypeError
+
+.. autoexception:: AMPS.ConnectionError
+
+.. autoexception:: AMPS.ConnectionException
+
+.. autoexception:: AMPS.ConnectionRefused
+
+.. autoexception:: AMPS.ConnectionRefusedException
+
+.. autoexception:: AMPS.CorruptedRecord
+
+.. autoexception:: AMPS.Disconnected
+
+.. autoexception:: AMPS.DisconnectedException
+
+.. autoexception:: AMPS.DuplicateLogonException
+
+.. autoexception:: AMPS.InvalidBookmarkException
+
+.. autoexception:: AMPS.InvalidMessageTypeOptions
+
+.. autoexception:: AMPS.InvalidOptionsException
+
+.. autoexception:: AMPS.InvalidOrderByException
+
+.. autoexception:: AMPS.InvalidSubIdException
+
+.. autoexception:: AMPS.InvalidTopicError
+
+.. autoexception:: AMPS.InvalidTopicException
+
+.. autoexception:: AMPS.InvalidTransportOptions
+
+.. autoexception:: AMPS.InvalidTransportOptionsException
+
+.. autoexception:: AMPS.InvalidUriException
+
+.. autoexception:: AMPS.InvalidUriFormat
+
+.. autoexception:: AMPS.LocalStorageError
+
+.. autoexception:: AMPS.LogonRequiredException
+
+.. autoexception:: AMPS.MessageTypeError
+
+.. autoexception:: AMPS.MessageTypeException
+
+.. autoexception:: AMPS.MessageTypeNotFound
+
+.. autoexception:: AMPS.MissingFieldsException
+
+.. autoexception:: AMPS.NameInUseException
+
+.. autoexception:: AMPS.NotEntitledError
+
+.. autoexception:: AMPS.NotEntitledException
+
+.. autoexception:: AMPS.PublishException
+
+.. autoexception:: AMPS.PublishStoreGapException
+
+.. autoexception:: AMPS.RetryOperation
+
+.. autoexception:: AMPS.RetryOperationException
+
+.. autoexception:: AMPS.StoreError
+
+.. autoexception:: AMPS.StoreException
+
+.. autoexception:: AMPS.StreamError
+
+.. autoexception:: AMPS.StreamException
+
+.. autoexception:: AMPS.SubidInUseException
+
+.. autoexception:: AMPS.SubscriptionAlreadyExists
+
+.. autoexception:: AMPS.SubscriptionAlreadyExistsException
+
+.. autoexception:: AMPS.TimedOut
+
+.. autoexception:: AMPS.TimedOutException
+
+.. autoexception:: AMPS.TransportError
+
+.. autoexception:: AMPS.TransportException
+
+.. autoexception:: AMPS.TransportNotFound
+
+.. autoexception:: AMPS.TransportTypeException
+
+.. autoexception:: AMPS.UnknownError
+
+.. autoexception:: AMPS.UnknownException
+
+.. autoexception:: AMPS.UsageException