python-terminusgps 20.4.1__tar.gz → 20.5.1__tar.gz

{python_terminusgps-20.4.1 → python_terminusgps-20.5.1}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: python-terminusgps
-Version: 20.4.1
+Version: 20.5.1
 Summary: Provides abstractions/utilities for working with Wialon API, Authorize.NET API, AWS API, and more.
 Project-URL: Documentation, https://app.terminusgps.com/docs/apps/python-terminusgps/index.html
 Project-URL: Repository, https://github.com/terminusgps/python-terminusgps

python_terminusgps-20.5.1/docs/source/authorizenet/auth.rst

@@ -0,0 +1,33 @@
+Authorizenet API Authentication
+===============================
+
+To authorize with the Authorizenet API, use these utility functions to provide data to each API call.
+
+.. currentmodule:: terminusgps.authorizenet.auth
+
+.. py:function:: get_merchant_auth() -> merchantAuthenticationType
+
+    Generates and returns a :py:obj:`~authorizenet.apicontractsv1.merchantAuthenticationType` object.
+
+    This object is generated using :confval:`MERCHANT_AUTH_LOGIN_ID` and :confval:`MERCHANT_AUTH_TRANSACTION_KEY`.
+
+    :returns: A merchant authentication object.
+    :rtype: :py:obj:`~authorizenet.apicontractsv1.merchantAuthenticationType`
+
+.. py:function:: get_environment() -> str
+
+    Gets the current application environment for Authorizenet API calls.    
+
+    This string is generated using :confval:`DEBUG`.
+
+    :returns: The current Authorizenet API environment.
+    :rtype: :py:obj:`str`
+
+.. py:function:: get_validation_mode() -> str
+
+    Gets the current application validation mode for Authorizenet API calls.    
+
+    This string is generated using :confval:`DEBUG`.
+
+    :returns: The current Authorizenet API validation mode.
+    :rtype: :py:obj:`str`

python_terminusgps-20.5.1/docs/source/authorizenet/index.rst

@@ -0,0 +1,11 @@
+Authorizenet API
+================
+
+:py:mod:`terminusgps` offers the :py:mod:`authorizenet` package; a Python library that makes it simple to operate within the Authorizenet API.
+
+.. toctree::
+    :maxdepth: 2
+    :caption: Contents:
+
+    auth.rst
+    profiles.rst

python_terminusgps-20.5.1/docs/source/authorizenet/profiles.rst

@@ -0,0 +1,22 @@
+Profiles
+========
+
+.. autoclass:: terminusgps.authorizenet.profiles.base.AuthorizenetProfileBase
+   :members:
+   :private-members:
+
+.. autoclass:: terminusgps.authorizenet.profiles.base.AuthorizenetSubProfileBase
+   :members:
+   :private-members:
+   
+.. autoclass:: terminusgps.authorizenet.profiles.addresses.AddressProfile
+   :members:
+   :private-members:
+
+.. autoclass:: terminusgps.authorizenet.profiles.customers.CustomerProfile
+   :members:
+   :private-members:
+
+.. autoclass:: terminusgps.authorizenet.profiles.payments.PaymentProfile
+   :members:
+   :private-members:

python_terminusgps-20.5.1/docs/source/aws/index.rst

@@ -0,0 +1,10 @@
+AWS API
+=======
+
+:py:mod:`terminusgps` offers the :py:mod:`aws` package; a Python library that makes it simple to operate within the AWS API.
+
+.. toctree::
+    :maxdepth: 2
+    :caption: Contents:
+
+    secrets.rst

python_terminusgps-20.5.1/docs/source/aws/secrets.rst

@@ -0,0 +1,17 @@
+Secrets
+=======
+
+.. currentmodule:: terminusgps.aws.secrets
+
+.. py:function:: get_secret(name, [region="us-east-1"]) -> dict[str, str]
+   
+    Logs into the default AWS CLI session and returns a secret value by name.
+
+    :param name: An AWS `secretsmanager`_ secret name.
+    :type name: :py:obj:`str`
+    :param region: An AWS region name. Default is ``"us-east-1"``.
+    :type region: :py:obj:`str`
+    :returns: The secret as a dictionary.
+    :rtype: :py:obj:`dict`
+
+    .. _secretsmanager: https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/secretsmanager.html

{python_terminusgps-20.4.1 → python_terminusgps-20.5.1}/docs/source/conf.py

@@ -9,7 +9,7 @@
 project = "python-terminusgps"
 copyright = "2025, Terminus GPS, LLC"
 author = "Terminus GPS, LLC"
-release = "20.4.0"
+release = "20.5.0"
 
 # -- General configuration ---------------------------------------------------
 # https://www.sphinx-doc.org/en/master/usage/configuration.html#general-configuration
@@ -21,6 +21,14 @@ extensions = [
     "sphinx.ext.viewcode",
 ]
 
+intersphinx_mapping = {
+    "python": ("https://docs.python.org/3", None),
+    "django": (
+        "http://docs.djangoproject.com/en/stable/",
+        "http://docs.djangoproject.com/en/stable/_objects/",
+    ),
+}
+
 templates_path = ["_templates"]
 exclude_patterns = []
 

{python_terminusgps-20.4.1 → python_terminusgps-20.5.1}/docs/source/index.rst

@@ -6,13 +6,11 @@
 python-terminusgps documentation
 ================================
 
-Add your content using ``reStructuredText`` syntax. See the
-`reStructuredText <https://www.sphinx-doc.org/en/master/usage/restructuredtext/index.html>`_
-documentation for details.
-
-
 .. toctree::
     :maxdepth: 2
     :caption: Contents:
 
+    authorizenet/index.rst
+    aws/index.rst
+    twilio/index.rst
     wialon/index.rst

python_terminusgps-20.5.1/docs/source/twilio/caller.rst

@@ -0,0 +1,47 @@
+Caller object
+=============
+
+
+.. currentmodule:: terminusgps.twilio.caller
+
+.. py:class:: TwilioCaller
+
+    An asyncronous phone messager/caller.
+
+    .. py:method:: create_notification(to_number, message, [method="sms"]) -> asyncio.Task
+
+        Creates a task that must be awaited in an asyncronous event loop in order to be executed.
+
+        :meta async:
+        :param to_number: A phone number, starting with a '+' and country code.
+        :type to_number: :py:obj:`str`
+        :param message: A message to send to `to_number`.
+        :type message: :py:obj:`str`
+        :param method: Notification method to use. Default is ``"sms"``.
+        :type method: :py:obj:`str`
+        :returns: An awaitable notification task.
+        :rtype: :py:obj:`asyncio.Task`
+
+    .. py:method:: create_call(to_number, message) -> None
+
+        Creates a phone call task.
+
+        :meta async:
+        :param to_number: A phone number, starting with a '+' and country code.
+        :type to_number: :py:obj:`str`
+        :param message: A message to send to `to_number`.
+        :type message: :py:obj:`str`
+        :returns: Nothing.
+        :rtype: :py:obj:`None`
+
+    .. py:method:: create_sms(to_number, message) -> None
+
+        Creates an sms message task.
+
+        :meta async:
+        :param to_number: A phone number, starting with a '+' and country code.
+        :type to_number: :py:obj:`str`
+        :param message: A message to send to `to_number`.
+        :type message: :py:obj:`str`
+        :returns: Nothing.
+        :rtype: :py:obj:`None`

python_terminusgps-20.5.1/docs/source/twilio/index.rst

@@ -0,0 +1,10 @@
+Twilio API
+==========
+
+:py:mod:`terminusgps` offers the :py:mod:`twilio` package; a Python library that makes it simple to operate within the Twilio API.
+
+.. toctree::
+    :maxdepth: 2
+    :caption: Contents:
+
+    caller.rst

python_terminusgps-20.5.1/docs/source/wialon/constants.rst

@@ -0,0 +1,19 @@
+Constants
+=========
+
+.. currentmodule:: terminusgps.wialon.constants
+
+.. py:data:: ACCESSMASK_RESOURCE_BASIC
+
+    :type: :py:obj:`int`
+    :value: ``17604054880353``
+
+.. py:data:: ACCESSMASK_UNIT_BASIC
+
+    :type: :py:obj:`int`
+    :value: ``3540009843``
+
+.. py:data:: ACCESSMASK_UNIT_MIGRATION
+
+    :type: :py:obj:`int`
+    :value: ``9437197``

python_terminusgps-20.5.1/docs/source/wialon/errors.rst

@@ -0,0 +1,8 @@
+Errors
+======
+
+.. currentmodule:: wialon.api
+
+.. py:exception:: WialonError
+
+    Raised when something goes wrong calling the Wialon API.

python_terminusgps-20.5.1/docs/source/wialon/examples.rst

@@ -0,0 +1,118 @@
+Usage Examples
+==============
+
+===============================
+Create a new unit and rename it
+===============================
+
+1. Import :py:obj:`~terminusgps.wialon.session.WialonSession` and :py:obj:`~terminusgps.wialon.items.WialonUnit`.
+
+Let's also import :py:obj:`~terminusgps.wialon.utils.generate_wialon_password` so we don't have to come up with a valid Wialon password ourselves.
+
+.. code:: python
+
+    from terminusgps.wialon.session import WialonSession
+    from terminusgps.wialon.items import WialonUnit
+    from terminusgps.wialon.utils import generate_wialon_password
+
+2. Open the session in a context manager and instantiate a unit.
+
+.. code:: python
+
+    with WialonSession(token="my_wialon_api_token") as session:
+        unit = WialonUnit(
+            id=None,
+            session=session,
+            creator_id="123",
+            name="test_user",
+            password=generate_wialon_password(32)
+        )
+        print(f"{unit.name = }") # unit.name = "test_user"
+
+3. Within the context manager, :py:obj:`~terminusgps.wialon.items.WialonUnit` methods can be executed.
+
+.. code:: python
+
+    with WialonSession(token="my_secure_wialon_token") as session:
+        ...
+
+        unit.rename("super_test_user")
+        # Session is logged out after exiting scope
+
+-----------------
+Full code example
+-----------------
+
+.. code:: python
+
+    from terminusgps.wialon.session import WialonSession
+    from terminusgps.wialon.items import WialonUnit
+    from terminusgps.wialon.utils import generate_wialon_password
+
+    with WialonSession(token="my_secure_wialon_token") as session:
+        unit = WialonUnit(
+            id=None,
+            session=session,
+            creator_id="123",
+            name="test_user",
+            password=generate_wialon_password(32)
+        )
+        unit.rename("super_test_user")
+
+
+============================================
+Create an account and migrate a unit into it
+============================================
+
+1. Import :py:obj:`~terminusgps.wialon.session.WialonSession` and :py:obj:`~terminusgps.wialon.items`.
+
+.. code:: python
+
+    from terminusgps.wialon.session import WialonSession
+    from terminusgps.wialon import items
+
+2. Create an account user.
+
+.. code:: python
+
+   with WialonSession(token="my_secure_wialon_token") as session:
+
+
+-----------------
+Full code example
+-----------------
+
+.. code:: python
+
+    from django.conf import settings
+
+    from terminusgps.wialon import items, constants
+    from terminusgps.wialon.session import WialonSession
+    from terminusgps.wialon.utils import generate_wialon_password, get_hw_type_id
+
+    with WialonSession(token="my_secure_wialon_token") as session:
+        hw_type_id = get_hw_type_id("Test HW", session)
+
+        account_user = items.WialonUser(
+            id=None,
+            session=session,
+            creator_id=settings.WIALON_ADMIN_ID,
+            name="account_user",
+            password=generate_wialon_password(32),
+        )
+        account_resource = items.WialonResource(
+            id=None,
+            session=session,
+            creator_id=account_user.id, # Use the new account user to create this resource
+            name="account_resource",
+        )
+        unit = WialonUnit(
+            id=None,
+            session=session,
+            creator_id=settings.WIALON_ADMIN_ID, # Account user CANNOT create the unit
+            name="test_unit",
+            hw_type_id=hw_type_id,
+        )
+
+        account_user.grant_access(unit, access_mask=constants.ACCESSMASK_UNIT_MIGRATION)
+        account_resource.migrate_unit(unit)

python_terminusgps-20.5.1/docs/source/wialon/flags.rst

@@ -0,0 +1,190 @@
+Flags
+=====
+
+.. automodule:: terminusgps.wialon.flags
+
+.. currentmodule:: terminusgps.wialon.flags
+
+============
+Access Flags
+============
+
+-------
+General
+-------
+
+`Wialon API Reference <https://sdk.wialon.com/wiki/en/sidebar/remoteapi/apiref/core/check_items_billing#general>`_
+
+.. py:data:: ACCESSFLAG_VIEW_ITEM_BASIC
+.. py:data:: ACCESSFLAG_VIEW_ITEM_DETAILED
+.. py:data:: ACCESSFLAG_MANAGE_ITEM_ACCESS
+.. py:data:: ACCESSFLAG_DELETE_ITEM
+.. py:data:: ACCESSFLAG_RENAME_ITEM
+.. py:data:: ACCESSFLAG_VIEW_CUSTOM_FIELDS
+.. py:data:: ACCESSFLAG_MANAGE_CUSTOM_FIELDS
+.. py:data:: ACCESSFLAG_MANAGE_UNMENTIONED_FIELDS
+.. py:data:: ACCESSFLAG_MANAGE_ICON
+.. py:data:: ACCESSFLAG_QUERY_REPORTS
+.. py:data:: ACCESSFLAG_MANAGE_ACL
+.. py:data:: ACCESSFLAG_MANAGE_ITEM_LOG
+.. py:data:: ACCESSFLAG_VIEW_ADMIN_FIELDS
+.. py:data:: ACCESSFLAG_MANAGE_ADMIN_FIELDS
+.. py:data:: ACCESSFLAG_VIEW_ATTACHED_FILES
+.. py:data:: ACCESSFLAG_MANAGE_ATTACHED_FILES
+
+---------------
+Unit/Unit Group
+---------------
+
+`Wialon API Reference <https://sdk.wialon.com/wiki/en/sidebar/remoteapi/apiref/core/check_items_billing#units_and_unit_groups>`_
+
+.. py:data:: ACCESSFLAG_UNIT_MANAGE_CONNECTIVITY
+.. py:data:: ACCESSFLAG_UNIT_MANAGE_SENSORS
+.. py:data:: ACCESSFLAG_UNIT_MANAGE_COUNTERS
+.. py:data:: ACCESSFLAG_UNIT_DELETE_MESSAGES
+.. py:data:: ACCESSFLAG_UNIT_EXECUTE_COMMANDS
+.. py:data:: ACCESSFLAG_UNIT_REGISTER_EVENTS
+.. py:data:: ACCESSFLAG_UNIT_VIEW_CONNECTIVITY
+.. py:data:: ACCESSFLAG_UNIT_VIEW_SERVICE_INTERVALS
+.. py:data:: ACCESSFLAG_UNIT_MANAGE_SERVICE_INTERVALS
+.. py:data:: ACCESSFLAG_UNIT_IMPORT_MESSAGES
+.. py:data:: ACCESSFLAG_UNIT_EXPORT_MESSAGES
+.. py:data:: ACCESSFLAG_UNIT_VIEW_COMMANDS
+.. py:data:: ACCESSFLAG_UNIT_MANAGE_COMMANDS
+.. py:data:: ACCESSFLAG_UNIT_MANAGE_TRIP_DETECTOR
+.. py:data:: ACCESSFLAG_UNIT_MANAGE_ASSIGNMENTS
+
+----
+User
+----
+
+`Wialon API Reference <https://sdk.wialon.com/wiki/en/sidebar/remoteapi/apiref/core/check_items_billing#users>`_
+
+.. py:data:: ACCESSFLAG_USER_MANAGE_ACCESS_RIGHTS
+.. py:data:: ACCESSFLAG_USER_ACT_AS_OTHER
+.. py:data:: ACCESSFLAG_USER_MANAGE_FLAGS
+.. py:data:: ACCESSFLAG_USER_VIEW_PUSH_MESSAGES
+.. py:data:: ACCESSFLAG_USER_MANAGE_PUSH_MESSAGES
+
+------------
+Retranslator
+------------
+
+`Wialon API Reference <https://sdk.wialon.com/wiki/en/sidebar/remoteapi/apiref/core/check_items_billing#retranslators>`_
+
+.. py:data:: ACCESSFLAG_RETRANSLATOR_MANAGE_PROPERTIES
+.. py:data:: ACCESSFLAG_RETRANSLATOR_MANAGE_UNITS
+
+------------------
+Resources/Accounts 
+------------------
+
+`Wialon API Reference <https://sdk.wialon.com/wiki/en/sidebar/remoteapi/apiref/core/check_items_billing#resources_accounts>`_
+
+.. py:data:: ACCESSFLAG_RESOURCE_VIEW_NOTIFICATIONS
+.. py:data:: ACCESSFLAG_RESOURCE_MANAGE_NOTIFICATIONS
+.. py:data:: ACCESSFLAG_RESOURCE_VIEW_POIS
+.. py:data:: ACCESSFLAG_RESOURCE_MANAGE_POIS
+.. py:data:: ACCESSFLAG_RESOURCE_VIEW_GEOFENCES
+.. py:data:: ACCESSFLAG_RESOURCE_MANAGE_GEOFENCES
+.. py:data:: ACCESSFLAG_RESOURCE_VIEW_JOBS
+.. py:data:: ACCESSFLAG_RESOURCE_MANAGE_JOBS
+.. py:data:: ACCESSFLAG_RESOURCE_VIEW_REPORT_TEMPLATES
+.. py:data:: ACCESSFLAG_RESOURCE_MANAGE_REPORT_TEMPLATES
+.. py:data:: ACCESSFLAG_RESOURCE_VIEW_DRIVERS
+.. py:data:: ACCESSFLAG_RESOURCE_MANAGE_DRIVERS
+.. py:data:: ACCESSFLAG_RESOURCE_MANAGE_ACCOUNT
+.. py:data:: ACCESSFLAG_RESOURCE_VIEW_ORDERS
+.. py:data:: ACCESSFLAG_RESOURCE_MANAGE_ORDERS
+.. py:data:: ACCESSFLAG_RESOURCE_VIEW_TRAILERS
+.. py:data:: ACCESSFLAG_RESOURCE_MANAGE_TRAILERS
+
+------
+Routes
+------
+
+`Wialon API Reference <https://sdk.wialon.com/wiki/en/sidebar/remoteapi/apiref/core/check_items_billing#routes>`_
+
+.. py:data:: ACCESSFLAG_ROUTE_MANAGE_ROUTE
+
+-----
+Other
+-----
+
+`Wialon API Reference <https://sdk.wialon.com/wiki/en/sidebar/remoteapi/apiref/core/check_items_billing#other>`_
+
+.. py:data:: ACCESSFLAG_FULL_ACCESS
+
+==========
+Data Flags
+==========
+
+------------
+Retranslator
+------------
+
+`Wialon API Reference <https://sdk.wialon.com/wiki/en/sidebar/remoteapi/apiref/format/retranslator>`_
+
+.. py:data:: DATAFLAG_RETRANSLATOR_BASE
+.. py:data:: DATAFLAG_RETRANSLATOR_CUSTOM_PROPERTIES
+.. py:data:: DATAFLAG_RETRANSLATOR_BILLING_PROPERTIES
+.. py:data:: DATAFLAG_RETRANSLATOR_GUID
+.. py:data:: DATAFLAG_RETRANSLATOR_ADMIN_FIELDS
+.. py:data:: DATAFLAG_RETRANSLATOR_CONFIGURATION
+.. py:data:: DATAFLAG_RETRANSLATOR_UNITS
+.. py:data:: DATAFLAG_RETRANSLATOR_ALL
+
+
+-----------------
+Resource/Accounts
+-----------------
+
+`Wialon API Reference <https://sdk.wialon.com/wiki/en/sidebar/remoteapi/apiref/format/resource>`_
+
+.. py:data:: DATAFLAG_RESOURCE_BASE
+.. py:data:: DATAFLAG_RESOURCE_CUSTOM_PROPERTIES
+.. py:data:: DATAFLAG_RESOURCE_BILLING_PROPERTIES
+.. py:data:: DATAFLAG_RESOURCE_CUSTOM_FIELDS
+.. py:data:: DATAFLAG_RESOURCE_MESSAGES
+.. py:data:: DATAFLAG_RESOURCE_GUID
+.. py:data:: DATAFLAG_RESOURCE_ADMIN_FIELDS
+.. py:data:: DATAFLAG_RESOURCE_DRIVERS
+.. py:data:: DATAFLAG_RESOURCE_JOBS
+.. py:data:: DATAFLAG_RESOURCE_NOTIFICATIONS
+.. py:data:: DATAFLAG_RESOURCE_POIS
+.. py:data:: DATAFLAG_RESOURCE_GEOFENCES
+.. py:data:: DATAFLAG_RESOURCE_REPORT_TEMPLATES
+.. py:data:: DATAFLAG_RESOURCE_DRIVER_ATTACHABLE_UNITS
+.. py:data:: DATAFLAG_RESOURCE_DRIVER_GROUPS
+.. py:data:: DATAFLAG_RESOURCE_TRAILERS
+.. py:data:: DATAFLAG_RESOURCE_TRAILER_GROUPS
+.. py:data:: DATAFLAG_RESOURCE_TRAILER_ATTACHABLE_UNITS
+.. py:data:: DATAFLAG_RESOURCE_ORDERS
+.. py:data:: DATAFLAG_RESOURCE_GEOFENCE_GROUPS
+.. py:data:: DATAFLAG_RESOURCE_TAGS
+.. py:data:: DATAFLAG_RESOURCE_TAG_ATTACHABLE_UNITS
+.. py:data:: DATAFLAG_RESOURCE_TAG_GROUPS
+.. py:data:: DATAFLAG_RESOURCE_ALL
+
+-----
+Route
+-----
+
+`Wialon API Reference <https://sdk.wialon.com/wiki/en/sidebar/remoteapi/apiref/format/route>`_
+
+.. py:data:: DATAFLAG_ROUTE_BASE
+.. py:data:: DATAFLAG_ROUTE_CUSTOM_PROPERTIES
+.. py:data:: DATAFLAG_ROUTE_BILLING_PROPERTIES
+.. py:data:: DATAFLAG_ROUTE_GUID
+.. py:data:: DATAFLAG_ROUTE_ADMIN_FIELDS
+.. py:data:: DATAFLAG_ROUTE_CONFIGURATION
+.. py:data:: DATAFLAG_ROUTE_CHECKPOINTS
+.. py:data:: DATAFLAG_ROUTE_SCHEDULES
+.. py:data:: DATAFLAG_ROUTE_ROUNDS
+.. py:data:: DATAFLAG_ROUTE_ALL
+
+---------------
+Unit/Unit Group
+---------------
+
+`Wialon API Reference <https://sdk.wialon.com/wiki/en/sidebar/remoteapi/apiref/format/unit>`_

{python_terminusgps-20.4.1 → python_terminusgps-20.5.1}/docs/source/wialon/index.rst

@@ -1,8 +1,3 @@
-.. python-terminusgps documentation master file, created by
-   sphinx-quickstart on Wed Feb 19 10:39:57 2025.
-   You can adapt this file completely to your liking, but it should at least
-   contain the root `toctree` directive.
-
 Wialon API
 ==========
 
@@ -13,6 +8,10 @@ Wialon API
     :caption: Contents:
 
     constants.rst
+    errors.rst
+    examples.rst
     flags.rst
-    glossary.rst
+    items.rst
+    session.rst
+    settings.rst
     utils.rst

python_terminusgps-20.5.1/docs/source/wialon/items.rst

@@ -0,0 +1,29 @@
+Items
+=====
+
+.. autoclass:: terminusgps.wialon.items.base.WialonBase
+   :members:
+
+.. autoclass:: terminusgps.wialon.items.geofence.WialonGeofence
+   :members:
+
+.. autoclass:: terminusgps.wialon.items.notification.WialonNotification
+   :members:
+
+.. autoclass:: terminusgps.wialon.items.resource.WialonResource
+   :members:
+   
+.. autoclass:: terminusgps.wialon.items.retranslator.WialonRetranslator
+   :members:
+
+.. autoclass:: terminusgps.wialon.items.route.WialonRoute
+   :members:
+
+.. autoclass:: terminusgps.wialon.items.unit.WialonUnit
+   :members:
+
+.. autoclass:: terminusgps.wialon.items.unit_group.WialonUnitGroup
+   :members:
+
+.. autoclass:: terminusgps.wialon.items.user.WialonUser
+   :members:

python_terminusgps-20.5.1/docs/source/wialon/session.rst

@@ -0,0 +1,37 @@
+Wialon API Sessions
+===================
+
+.. autoclass:: terminusgps.wialon.session.WialonSession
+   :members:
+
+.. autoclass:: terminusgps.wialon.session.WialonSessionManager
+   :members:
+
+
+=====
+Usage
+=====
+
+.. code:: python
+
+    from terminusgps.wialon.session import WialonSession
+
+    # Create a session and login to it
+    session = WialonSession()
+    session.login(token="my_secure_token")
+
+    # Use the logged in session to perform API actions
+    session.wialon_api.core_search_item(**{"id": "123", "flags": 1})
+
+    # Don't forget to logout of the session
+    # Sessions are destroyed after 5min of inactivity
+    session.logout()
+
+    # Alternatively, use a context manager
+    # The context manager handles logging in and out of the session.
+    with WialonSession() as session:
+        session.wialon_api.core_search_item(**{"id": "123", "flags": 1})
+
+    # If you already have a session id, no need to login again
+    session = WialonSession(sid="my_valid_session_id")
+    session.wialon_api.core_search_item(**{"id": "123", "flags": 1})

python_terminusgps-20.5.1/docs/source/wialon/settings.rst

@@ -0,0 +1,59 @@
+Settings
+========
+
+.. confval:: DEBUG
+
+    :type: :py:obj:`bool`
+    :default: :py:obj:`True`
+
+    Debug mode enabled.
+
+.. confval:: MERCHANT_AUTH_LOGIN_ID
+
+    :type: :py:obj:`str`
+
+    An authorizenet merchant authentication login id.
+
+.. confval:: MERCHANT_AUTH_TRANSACTION_KEY
+
+    :type: :py:obj:`str`
+
+    An authorizenet merchant authentication transaction key.
+
+    This key signs all Authorizenet transactions.
+
+.. confval:: TWILIO_FROM_NUMBER
+
+    :type: :py:obj:`str`
+
+    A phone number to send Twilio notifications from.
+
+.. confval:: TWILIO_MESSAGING_SID
+
+    :type: :py:obj:`str`
+
+    A Twilio API messaging session id.
+
+.. confval:: TWILIO_SID
+
+    :type: :py:obj:`str`
+
+    A Twilio API session id.
+
+.. confval:: TWILIO_TOKEN
+
+    :type: :py:obj:`str`
+
+    A Twilio API token.
+
+.. confval:: WIALON_ADMIN_ID
+
+    :type: :py:obj:`str`
+
+    A Wialon user id to operate as during Wialon API session.
+
+.. confval:: WIALON_TOKEN
+
+    :type: :py:obj:`str`
+
+    An active Wialon API token.

{python_terminusgps-20.4.1 → python_terminusgps-20.5.1}/docs/source/wialon/utils.rst

@@ -5,16 +5,9 @@ Utilities
 Functions
 =========
 
-.. currentmodule:: terminusgps.wialon.utils
-
-.. autosummary::
-
-   get_hw_type_id
-   get_id_from_iccid
-   get_wialon_cls
-   get_vin_info
-   is_unique
-   generate_wialon_password
+.. automodule:: terminusgps.wialon.utils
+   :members:
+   :exclude-members: gen_wialon_password
 
 =====
 Usage

{python_terminusgps-20.4.1 → python_terminusgps-20.5.1}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "python-terminusgps"
-version = "20.4.1"
+version = "20.5.1"
 description = "Provides abstractions/utilities for working with Wialon API, Authorize.NET API, AWS API, and more."
 readme = "README.md"
 authors = [ {name = "Blake Nall", email = "blake@terminusgps.com" } ]

{python_terminusgps-20.4.1 → python_terminusgps-20.5.1}/terminusgps/wialon/session.py

@@ -342,20 +342,3 @@ class WialonSessionManager:
             if not self._session:
                 self._session = WialonSession(sid=sid, log_level=log_level)
         return self._session
-
-
-def main() -> None:
-    # Usage example
-    session = WialonSession(log_level=logging.DEBUG)  # Instantiate session
-    session.login(settings.WIALON_TOKEN)  # Login to session
-    session.wialon_api.avl_evts()  # Call Wialon API
-    session.logout()  # Logout of session
-
-    # Alternatively, use a context manager to handle logging in and out
-    with WialonSession() as session:
-        session.wialon_api.avl_evts()  # Call Wialon API, logout when scope ends
-    return
-
-
-if __name__ == "__main__":
-    main()

{python_terminusgps-20.4.1 → python_terminusgps-20.5.1}/uv.lock

@@ -504,7 +504,7 @@ wheels = [
 
 [[package]]
 name = "python-terminusgps"
-version = "20.4.1"
+version = "20.5.1"
 source = { editable = "." }
 dependencies = [
     { name = "argparse" },

python_terminusgps-20.4.1/docs/source/wialon/constants.rst

@@ -1,6 +0,0 @@
-Constants
-=========
-
-.. autosummary::
-
-   terminusgps.wialon.constants

python_terminusgps-20.4.1/docs/source/wialon/flags.rst

@@ -1,6 +0,0 @@
-Flags
-=====
-
-.. autosummary::
-
-   terminusgps.wialon.flags

python_terminusgps-20.4.1/docs/source/wialon/glossary.rst

@@ -1,2 +0,0 @@
-Glossary
-========