Metadata-Version: 2.1
Name: sealights-python-agent
Version: 0.2.130
Summary: Python Agent
Home-page: https://github.com/Sealights/SL.OnPremise.Agents.Python
Author: Shai Cantor
Author-email: shai@sealights.io
License: Other/Proprietary License
Keywords: sealights python agent setuptools development
Platform: UNKNOWN
Classifier: Development Status :: 3 - Alpha
Classifier: Intended Audience :: Developers
Classifier: Topic :: Software Development :: Build Tools
Classifier: License :: Other/Proprietary License
Classifier: Programming Language :: Python :: 2.7
Classifier: Programming Language :: Python :: 2.6
Provides-Extra: test
Provides-Extra: dev
Requires-Dist: APScheduler (==3.0.6)
Requires-Dist: coverage (==4.4.2)
Requires-Dist: unittest2 (==1.1.0)
Requires-Dist: cryptography (==2.1.4)
Requires-Dist: future (==0.16.0)
Requires-Dist: gitpython (==2.1.8)
Provides-Extra: dev
Requires-Dist: check-manifest; extra == 'dev'
Provides-Extra: test
Requires-Dist: coverage; extra == 'test'

======================
sealights-python-agent
======================


The sealights-python-agent package integrates with the Sealights` Continuous Testing Platform.


****************
Language Support
****************
* Python 2.6
* Python 2.7


****************
Installation
****************

To install sealights-python-agent:
.. code-block::

    $ pip install sealights-python-agent

*****
Usage
*****

Build Scan
==========

To run the build scanner:
.. code-block::

    $ sealignts-admin --customer_id <customer_id> --app_name <app_name> --server https://prod-sealights-gw.sealights.co/api --branch <branch> --build <build> --env <env> build


1. Required
------------------
- customer_id
- app_name
- server

2. Optional
------------------
- env (default is "Unit Tests")
- build (default is "1")
- branch (default is "master")
- source - list of packages to scan (default is current working directory)
- include - Include only files whose paths match one of these patterns (default is empty)
- omit - Omit files whose paths match one of these patterns (default is empty)

Test Listener
=============

1. Supported Test Frameworks:
------------------------------
- unittest
- unittest2
- py.test

2. To run the Test Listener:
------------------------------

One Participant Mode (Tests and application on the same server)
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
.. code-block::

    $ sealignts-admin --customer_id <customer_id> --app_name <app_name> --server https://prod-sealights-gw.sealights.co/api --branch <branch> --build <build> --env <env> <unittest/unit2/pytest> <tests>

Multiple Participants (Tests on one server application on a second server)
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

Test Server
"""""""""""
.. code-block::

    $ sealignts-admin --test_phase <test_phase> --customer_id <customer_id> --app_name <app_name> --server https://prod-sealights-gw.sealights.co/api --branch <branch> --build <build> --env <env> <unittest/unit2/pytest> <tests>

Application Server
"""""""""""""""""""
- Run Build Scan
- Run Program using sealights-admin

.. code-block::

    $ sealignts-admin --test_phase <test_phase> --customer_id <customer_id> --app_name <app_name> --server https://prod-sealights-gw.sealights.co/api --branch <branch> --build <build> --env <env> run_program <program>


