Skip to main content
This is a pre-production deployment of Warehouse. Changes made here affect the production instance of PyPI (pypi.python.org).
Help us improve Python packaging - Donate today!

SD Element Tools: A collection of SD Elements integration tools built around SD Elements API.

Project Description
.. image:: https://codeclimate.com/github/sdelements/sdetools/badges/gpa.svg
:target: https://codeclimate.com/github/sdelements/sdetools

.. image:: https://travis-ci.org/sdelements/sdetools.svg?branch=master
:target: https://travis-ci.org/sdelements/sdetools

.. image:: https://ci.appveyor.com/api/projects/status/wwjae8ser722tte0/branch/master?svg=true&passingText=master%20-%20OK&failingText=master%20-%20failing
:target: https://ci.appveyor.com/project/sdelements/sdetools/branch/master

Requirements
============

- Python 2.6 or 2.7

This project is intended to be ultra lightweight, and portable.
The only requirement is to have Python 2.6 or 2.7 installed.

The console usage
-----------------

**sde.py**

The command line tool to run SD Elements integration modules. Use ``python
sde.py help`` to see usage and ``python sde.py help <cmd>`` to see usage for
specific module.

For example, to run command ``sync_tfs`` - which syncs a TFS server with an SDE server:

``python sde.py sync_tfs -c tfs.conf``

where ``tfs.conf`` is a file containing the settings associated with both services.

Additional command-line options:

- Enable verbose output ``-v``
- Enable debugging ``-d``
- Specify which module to debug ``--debugmods=MODULENAME``

For example, to enable verbose output and debug information for ``sdetools.sdelib.restclient``,

``python sde.py sync_tfs -v --debugmods=sdetools.sdelib.restclient -d -c tfs.txt``


The package usage
-----------------

.. code-block:: python

import sdetools

sdetools.call('api_proxy', {'api_func': 'get_applications'})


SDE Library (sdelib/)
---------------------

A light weight library that provides an interface to SD Elements RESTful API.

- **apiclient**: The base API provider for calls to SD Elements.
- **interactive_plugin**: This module provides the interactive experience
needed for the SDE Lint tool and other similar usecases. This includes:
- Password collection and retry
- Application selection
- Project selection

- **conf_mgr**: Configuration Manager provides support for parsing command
line arguments, reading variables from config file, and allows for extended
options to be defined for each usecase.

Testing
-------

Tests can be invoked using ``nosetests``:
``nosetests <flags> <testsFile>``

Simply running ``nosetests`` will run all tests in the current directory and its subdirectories. The flag ``-e live`` is useful for excluding the live tests.

Live tests should be run individually:
``nosetests --tests=$TESTS_FILE_PATH --tc=sdetools.config_path:$CONFIG_TESTS``
where $CONFIG_TESTS is the path to the file containing the appropriate configuration settings for running the life tests

**Writing new tests**

Modules typically have two types of tests, mock and live. Both inherit from
``alm_integration.tests.alm_plugin_test_base.AlmPluginTestBase``
and
``alm_integration.tests.alm_plugin_live_test_base.AlmPluginLiveTestBase``
respectively.

New test classes should be stored in a test folder of the module which they test and should extend these two classes. New tests may not neccesarily need to be extended further than simply initializing the base classes with the corresponding module connectors, generators and settings.

Response Generators are used in generating the api call return values when running mock tests. As such, each module test suite requires a new response generator that extends the base class
``sdetools.sdelib.testlib.response_generator.ResponseGenerator``
The response generator class must declare rest_api_targets (if dealing with a REST API). Mocking an API endpoint consists of adding a regex matching the url, and mapping it to a new function to handle the response. Each function must return objects, consisting of the headers and the response returned by the API call.

JSON templates can also be created and loaded by the response generator to create mock responses. These are typically stored in the response directory of the test directory.
Release History

Release History

This version
History Node

5.12.6

History Node

5.12.5

History Node

5.12.4

History Node

5.12.3

History Node

5.12.2

History Node

5.12.1

History Node

5.12.0

History Node

5.11.2

History Node

5.11.1

History Node

5.11.0

History Node

5.10.51

History Node

5.10.8

History Node

5.10.7

History Node

5.10.6

History Node

5.10.5

History Node

5.10.2

History Node

5.10.1

History Node

5.10.0

History Node

5.9.11

History Node

5.9.10

History Node

5.9.9

History Node

5.9.8

History Node

5.9.7

History Node

5.9.6

History Node

5.9.5

History Node

5.9.4

History Node

5.9.3

History Node

5.9.2

History Node

5.9.1

History Node

5.9.0

History Node

5.8.3

History Node

5.8.2.3

History Node

5.8.2.2

History Node

5.8.2.1

History Node

5.8.2

History Node

5.8.1.2

History Node

5.8.1.1

History Node

5.8.1

History Node

5.8.0

History Node

5.8.0b1

History Node

5.7.2

History Node

5.7.1

History Node

5.7.0

History Node

5.6.0

History Node

5.5.6

History Node

5.5.5

History Node

5.5.4

History Node

5.5.3

History Node

5.5.2

History Node

5.5.1

History Node

5.5.0

History Node

5.4.1

History Node

5.4.0

History Node

5.3.5

History Node

5.3.4

History Node

5.3.3

History Node

5.3.2

History Node

5.3.1

History Node

5.3.0

History Node

5.2.10.13

History Node

5.2.10.12

History Node

5.2.10.11

History Node

5.2.10.10

History Node

5.2.10.9

History Node

5.2.10.8

History Node

5.2.10.7

History Node

5.2.10.6

History Node

5.2.10.5

History Node

5.2.10.4

History Node

5.2.10.3

History Node

5.2.10.2

History Node

5.2.10.1

History Node

5.2.10

History Node

5.2.9

History Node

5.2.8

History Node

5.2.7

History Node

5.2.5

History Node

5.2.4

History Node

5.2.3

History Node

5.2.2

History Node

5.2.1

History Node

5.2.0

History Node

5.1.2

History Node

5.1.1

History Node

5.1.0

History Node

5.0.15.2

History Node

5.0.15.1

History Node

5.0.15

History Node

5.0.14.4

History Node

5.0.14.3

History Node

5.0.14.2

History Node

5.0.14.1

History Node

5.0.14

History Node

5.0.13

History Node

5.0.12

History Node

5.0.11

History Node

5.0.9

History Node

5.0.7

History Node

5.0.6

History Node

5.0.5.4

History Node

5.0.5.3

History Node

5.0.5.1

History Node

5.0.5

History Node

5.0.4

History Node

5.0.3

History Node

5.0.2

History Node

5.0.1

History Node

5.0.0

History Node

4.9.0

History Node

4.8.7

History Node

4.8.6

History Node

4.8.5

History Node

4.8.4

History Node

4.8.3

History Node

4.8.2

History Node

4.8.1

History Node

4.8.0

History Node

4.7.3

History Node

4.7.2

History Node

4.7.1

History Node

4.7.0

History Node

4.6.3

History Node

4.6.2

History Node

4.6.1.1

History Node

4.6.1

History Node

4.5.3

History Node

4.5.2

History Node

4.5.1

History Node

4.5.0

History Node

4.4.24

History Node

4.4.23

History Node

4.4.22

History Node

4.4.21

History Node

4.4.20

History Node

4.4.19

History Node

4.4.18

History Node

4.4.17.1

History Node

4.4.17

History Node

4.4.16

History Node

4.4.15

History Node

4.4.14

History Node

4.4.12

History Node

4.4.11

History Node

4.4.10

History Node

4.4.9

History Node

4.4.8

History Node

4.4.7

History Node

4.4.6

History Node

4.4.5

History Node

4.4.4

History Node

4.4.3

History Node

4.4.2

History Node

4.4.1

History Node

4.4.0

History Node

4.3.3

History Node

4.3.2

History Node

4.3.1

History Node

4.3.0

History Node

4.2.3

History Node

4.2.2

History Node

4.2.1

History Node

4.2.0

History Node

4.1.0

History Node

4.0.0

History Node

3.10.6

History Node

3.10.5

History Node

3.10.4

History Node

3.10.3

History Node

3.10.2

History Node

3.10.1

History Node

3.10.0

History Node

3.9.7

History Node

3.9.6

History Node

3.9.5

History Node

3.9.4

History Node

3.9.3

History Node

3.9.2.1

History Node

3.9.2

History Node

3.8.2

History Node

3.8.1

History Node

3.8.0

History Node

3.7.5

History Node

3.7.4

History Node

3.7.3

History Node

3.7.2

History Node

3.7.1

History Node

3.7.0

History Node

3.6.4

History Node

3.6.3

History Node

3.6.2

History Node

3.6.1

History Node

3.6.0

History Node

3.5.1

History Node

3.5.0

History Node

3.4.1

History Node

3.4.0

History Node

3.3.7

History Node

3.3.6

History Node

3.3.5

History Node

3.3.4

History Node

3.3.3

History Node

3.3.2

History Node

3.2.0

History Node

3.1.0

History Node

3.0.5

History Node

3.0.4

History Node

3.0.3

History Node

3.0.2

History Node

4.4.4e

History Node

4.4.4d

Download Files

Download Files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

File Name & Checksum SHA256 Checksum Help Version File Type Upload Date
sdetools-5.12.6.tar.gz (840.1 kB) Copy SHA256 Checksum SHA256 Source Sep 14, 2017

Supported By

WebFaction WebFaction Technical Writing Elastic Elastic Search Pingdom Pingdom Monitoring Dyn Dyn DNS Sentry Sentry Error Logging CloudAMQP CloudAMQP RabbitMQ Heroku Heroku PaaS Kabu Creative Kabu Creative UX & Design Fastly Fastly CDN DigiCert DigiCert EV Certificate Rackspace Rackspace Cloud Servers DreamHost DreamHost Log Hosting