swimlane


Nameswimlane JSON
Version 10.18.3 PyPI version JSON
download
home_pagehttps://github.com/swimlane/swimlane-python
SummaryPython driver for the Swimlane API
upload_time2024-10-21 10:40:26
maintainerNone
docs_urlNone
authorSwimlane
requires_python>=3.6
licenseAGPLv3
keywords
VCS
bugtrack_url
requirements cachetools certifi pendulum pendulum pyjwt pyuri requests six sortedcontainers shortid
Travis-CI No Travis.
coveralls test coverage No coveralls.
            .. image:: https://raw.githubusercontent.com/swimlane/swimlane-python/master/docs/logo.png

Swimlane Python
===============

.. image:: https://img.shields.io/pypi/v/swimlane.svg
    :target: https://pypi.python.org/pypi/swimlane
.. image:: https://img.shields.io/pypi/pyversions/swimlane.svg
    :target: https://pypi.python.org/pypi/swimlane
.. image:: https://travis-ci.org/swimlane/swimlane-python.svg?branch=master
    :target: https://travis-ci.org/swimlane/swimlane-python
.. image:: https://readthedocs.org/projects/swimlane-python-driver/badge/?version=latest
    :target: http://swimlane-python-driver.readthedocs.io/
.. image:: https://api.codacy.com/project/badge/Grade/215d8281290749bba687a08db1d59d8b
    :target: https://www.codacy.com/app/Swimlane/swimlane-python?utm_source=github.com&utm_medium=referral&utm_content=swimlane/swimlane-python&utm_campaign=Badge_Grade
.. image:: https://api.codacy.com/project/badge/Coverage/215d8281290749bba687a08db1d59d8b
    :target: https://www.codacy.com/app/Swimlane/swimlane-python?utm_source=github.com&utm_medium=referral&utm_content=swimlane/swimlane-python&utm_campaign=Badge_Grade

Python driver for the Swimlane_ API

.. _Swimlane: http://swimlane.com


Installation
------------

Install from public repository

::

    pip install swimlane


Or use correct offline installer with bundled dependencies from `releases page`_

.. _releases page: https://github.com/swimlane/swimlane-python/releases

::

    python swimlane-python-offline-installer-<platform>-<python_version>.pyz


Documentation
-------------

See the `Docs on RTD`_ for examples and full documentation

.. _Docs on RTD: http://swimlane-python-driver.readthedocs.io/


Functional Tests
----------------

To run the Functional Tests, start by navigating into the *functional_tests* directory.

Install the required PIP packages with the command

::

    pip install -r requirements.txt


## Executing

The test suite allows for overriding the target server and user parameters via the following arguments:
 ::
    pytest 
    --url default="https://localhost"
    --user default="admin"
    --pass This is the password for the user defined above.
    --skipverify This is for allowing the version of PyDriver to not match the version of Swimlane.

To run a specific test and skip the version verification:

::
    pytest driver_tests/test_app_adaptor.py --skipverify

To run all the tests against 10.20.30.40:
 ::
    pytest --url "https://10.20.30.40"

.. NOTE::
    All of the data created for testing purposes is cleaned up.

    No preset data is needed beyond the base user.

    These tests are Python 3.6+ compatible.

Issues
------

Open any bug reports or feature requests through the `Swimlane support portal`_

.. _Swimlane support portal: https://support.swimlane.com/helpdesk/tickets/new

            

Raw data

            {
    "_id": null,
    "home_page": "https://github.com/swimlane/swimlane-python",
    "name": "swimlane",
    "maintainer": null,
    "docs_url": null,
    "requires_python": ">=3.6",
    "maintainer_email": null,
    "keywords": null,
    "author": "Swimlane",
    "author_email": "info@swimlane.com",
    "download_url": "https://files.pythonhosted.org/packages/59/fa/aae626b4ca76088c82060fdcf3980d78a668f676476ad969aa7b36f7ce71/swimlane-10.18.3.tar.gz",
    "platform": null,
    "description": ".. image:: https://raw.githubusercontent.com/swimlane/swimlane-python/master/docs/logo.png\n\nSwimlane Python\n===============\n\n.. image:: https://img.shields.io/pypi/v/swimlane.svg\n    :target: https://pypi.python.org/pypi/swimlane\n.. image:: https://img.shields.io/pypi/pyversions/swimlane.svg\n    :target: https://pypi.python.org/pypi/swimlane\n.. image:: https://travis-ci.org/swimlane/swimlane-python.svg?branch=master\n    :target: https://travis-ci.org/swimlane/swimlane-python\n.. image:: https://readthedocs.org/projects/swimlane-python-driver/badge/?version=latest\n    :target: http://swimlane-python-driver.readthedocs.io/\n.. image:: https://api.codacy.com/project/badge/Grade/215d8281290749bba687a08db1d59d8b\n    :target: https://www.codacy.com/app/Swimlane/swimlane-python?utm_source=github.com&amp;utm_medium=referral&amp;utm_content=swimlane/swimlane-python&amp;utm_campaign=Badge_Grade\n.. image:: https://api.codacy.com/project/badge/Coverage/215d8281290749bba687a08db1d59d8b\n    :target: https://www.codacy.com/app/Swimlane/swimlane-python?utm_source=github.com&amp;utm_medium=referral&amp;utm_content=swimlane/swimlane-python&amp;utm_campaign=Badge_Grade\n\nPython driver for the Swimlane_ API\n\n.. _Swimlane: http://swimlane.com\n\n\nInstallation\n------------\n\nInstall from public repository\n\n::\n\n    pip install swimlane\n\n\nOr use correct offline installer with bundled dependencies from `releases page`_\n\n.. _releases page: https://github.com/swimlane/swimlane-python/releases\n\n::\n\n    python swimlane-python-offline-installer-<platform>-<python_version>.pyz\n\n\nDocumentation\n-------------\n\nSee the `Docs on RTD`_ for examples and full documentation\n\n.. _Docs on RTD: http://swimlane-python-driver.readthedocs.io/\n\n\nFunctional Tests\n----------------\n\nTo run the Functional Tests, start by navigating into the *functional_tests* directory.\n\nInstall the required PIP packages with the command\n\n::\n\n    pip install -r requirements.txt\n\n\n## Executing\n\nThe test suite allows for overriding the target server and user parameters via the following arguments:\n ::\n    pytest \n    --url default=\"https://localhost\"\n    --user default=\"admin\"\n    --pass This is the password for the user defined above.\n    --skipverify This is for allowing the version of PyDriver to not match the version of Swimlane.\n\nTo run a specific test and skip the version verification:\n\n::\n    pytest driver_tests/test_app_adaptor.py --skipverify\n\nTo run all the tests against 10.20.30.40:\n ::\n    pytest --url \"https://10.20.30.40\"\n\n.. NOTE::\n    All of the data created for testing purposes is cleaned up.\n\n    No preset data is needed beyond the base user.\n\n    These tests are Python 3.6+ compatible.\n\nIssues\n------\n\nOpen any bug reports or feature requests through the `Swimlane support portal`_\n\n.. _Swimlane support portal: https://support.swimlane.com/helpdesk/tickets/new\n",
    "bugtrack_url": null,
    "license": "AGPLv3",
    "summary": "Python driver for the Swimlane API",
    "version": "10.18.3",
    "project_urls": {
        "Homepage": "https://github.com/swimlane/swimlane-python"
    },
    "split_keywords": [],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "a059f886aecb70e58013038fb09d2c5ca67a5f545ff9e24c77be21105ec78f11",
                "md5": "60c3e0d8347dbde2fc0052c509eb047a",
                "sha256": "2c58768122b09a44ed05ba8861efe7bb132900f35bec9937f3a8a1753bf4e431"
            },
            "downloads": -1,
            "filename": "swimlane-10.18.3-py2.py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "60c3e0d8347dbde2fc0052c509eb047a",
            "packagetype": "bdist_wheel",
            "python_version": "py2.py3",
            "requires_python": ">=3.6",
            "size": 69601,
            "upload_time": "2024-10-21T10:40:25",
            "upload_time_iso_8601": "2024-10-21T10:40:25.022732Z",
            "url": "https://files.pythonhosted.org/packages/a0/59/f886aecb70e58013038fb09d2c5ca67a5f545ff9e24c77be21105ec78f11/swimlane-10.18.3-py2.py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "59faaae626b4ca76088c82060fdcf3980d78a668f676476ad969aa7b36f7ce71",
                "md5": "24ff28e267e16d5c804456701b3ed28a",
                "sha256": "04fc8f3e979d8f2da87c42c1009c65551e6885b27e50c0885cffee29057756f2"
            },
            "downloads": -1,
            "filename": "swimlane-10.18.3.tar.gz",
            "has_sig": false,
            "md5_digest": "24ff28e267e16d5c804456701b3ed28a",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.6",
            "size": 57117,
            "upload_time": "2024-10-21T10:40:26",
            "upload_time_iso_8601": "2024-10-21T10:40:26.776515Z",
            "url": "https://files.pythonhosted.org/packages/59/fa/aae626b4ca76088c82060fdcf3980d78a668f676476ad969aa7b36f7ce71/swimlane-10.18.3.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2024-10-21 10:40:26",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "swimlane",
    "github_project": "swimlane-python",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": true,
    "requirements": [
        {
            "name": "cachetools",
            "specs": [
                [
                    ">=",
                    "4.2.4"
                ]
            ]
        },
        {
            "name": "certifi",
            "specs": [
                [
                    "==",
                    "2024.7.4"
                ]
            ]
        },
        {
            "name": "pendulum",
            "specs": [
                [
                    "==",
                    "2.1.2"
                ]
            ]
        },
        {
            "name": "pendulum",
            "specs": [
                [
                    "==",
                    "3.0.0"
                ]
            ]
        },
        {
            "name": "pyjwt",
            "specs": [
                [
                    ">=",
                    "2.4.0"
                ]
            ]
        },
        {
            "name": "pyuri",
            "specs": [
                [
                    ">=",
                    "0.3"
                ],
                [
                    "<",
                    "0.4"
                ]
            ]
        },
        {
            "name": "requests",
            "specs": [
                [
                    ">=",
                    "2"
                ],
                [
                    "<",
                    "3"
                ]
            ]
        },
        {
            "name": "six",
            "specs": [
                [
                    ">=",
                    "1.12.0"
                ]
            ]
        },
        {
            "name": "sortedcontainers",
            "specs": [
                [
                    "==",
                    "2.4.0"
                ]
            ]
        },
        {
            "name": "shortid",
            "specs": [
                [
                    "==",
                    "0.1.2"
                ]
            ]
        }
    ],
    "tox": true,
    "lcname": "swimlane"
}
        
Elapsed time: 0.53971s