/swimlane-python

🐍 Official Python library for the Swimlane API

Primary LanguagePythonGNU Affero General Public License v3.0AGPL-3.0

https://raw.githubusercontent.com/swimlane/swimlane-python/master/docs/logo.png

Swimlane Python

https://travis-ci.org/swimlane/swimlane-python.svg?branch=master https://readthedocs.org/projects/swimlane-python-driver/badge/?version=latest https://api.codacy.com/project/badge/Grade/215d8281290749bba687a08db1d59d8b https://api.codacy.com/project/badge/Coverage/215d8281290749bba687a08db1d59d8b

Python driver for the Swimlane API

Installation

Install from public repository

pip install swimlane

Or use correct offline installer with bundled dependencies from releases page

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

Documentation

See the Docs on RTD for examples and full documentation

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

The tests take the following arguments

--url The url to a running Swimlane Instance. The default is https://localhost
--user This is a user to run the tests as. The user needs Administrator privileges. The default is admin
--pass This is the password for the user provided.
--skipverify This is for allowing the version of PyDriver to not match the version of Swimlane.

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 2 and 3 compatible.

Issues

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