Python client for IBM Enterprise Lifecycle Management applications
(c) Copyright 2021- IBM Inc. All rights reserved
SPDX-License-Identifier: MIT
version="0.26.2"
11-Dec-2023
16-Aug-2023
4-May-2023
The aim of this code is to provide a Python client for the IBM Enterprise Lifecycle Management (ELM) applications.
IMPORTANT NOTES:
Included in this package are a few examples using elmclient
which are reasonably functional:
There are links to these examples below.
Either method of install described below installs the elmclient package and puts example commands (such as oslcquery
into your path so a) they can be run simply by typing the command, e.g. oslcquery
and b) as you edit the source code these commands automatically use the latest code.
Requirements: Python 3.11/3.10/3.9 - NOTE I'm developing using Python 3.11.4 and compatibility with older versions is NOT checked.
Step 1: Install Python so it can be run from a command prompt Either Step 2a: Quickest and easiest to get started: install elmclient from pypi Or Step 2b: If you want to change elmclient code
Install Python so you can run Python from the commandline - might be python3 if you're on *nix. On Windows the command is python
- you can find install guides all over the internet.
This method is also easiest to update with new versions of elmclient.
at a command prompt:
pip install elmclient
pip3 install elmclient
To update:
pip install -U elmclient
pip3 install -U elmclient
Using this method you could copy the examples from where they're lurking in your Python installation's library to a different folder, rename if using one of the commands such as oslcquery to a different name, and edit them in this folder separate from the elmclient install.
Test that all was successful by running oslcquery -h
you should get a version number then a swathe of text with all the options.
This method assumes you have developer knowledge how to modify and merge code.
By far the preferred method is to first fork the github repository. You'll then get a folder on your PC which has a sub-folder `elmclient'.
Open a command prompt in the folder which has a subfolder elmclient
and run the command (Windows) pip install -e .
or (*nix) pip3 install -e .
Test that all was successful by running oslcquery -h
you should get a version number then a swathe of text with all the options.
You code will import elmclient, then use it.
The basis of using the elmclient is to first create a "server", then add the needed application(s) to it - typically just one application such as rm, or perhaps more applications such as rm and gc.
Then you can use the API functions to find projects, components, configurations, etc.
The DN reportable REST example provides a simple functional example with hard-coded values for the project, configuration and the artifact ID to be queried. This is the easy way to get into using elmclient - by modifying this example.
The other examples add fairly complex details around the use of elmclient to provide a commandline interface and should provide again a starting point for further development.
The auth code works with:
Other authentication methods haven't been tested.
You'll have to provide a username and password; that username will determine the permissions to read/write data on your server, just as they would through a browser UI.
The examples oslcquery
and reqif_io
layer authentication enhancements on top of this to allow saving obfuscated credentials to a file so you don't have to provide these on the commandline every time. See the code for these examples.
It's possible to install the ELM applications to run on non-standard context roots like /rm1 for DOORS Next, or /scm for EWM. This is handled in elmclient
using APPSTRINGs. These specify the domain of an application using rm, jts, gc, ccm, qm, and the context root as a string without the leading /. So for example /rm1 would be specified as rm:rm1
, or /scm would be specified as ccm:scm
.
For example, if your DN is on /rm then just specify rm
. Or, if it's on /rm23 then specify rm:rm23
.
If more than one application is needed then use a comma separate list (without spaces). The main application is specified first, but if jts is also on /jts1 then your APPSTRING could be rm:rm1,jts:jts1
.
These examples drove the evolution of elmclient
:
elmclient
to access the DOORS Next Reportable REST API - hardcodedThis code provides examples of using various ELM APIs:
** Process - elmclient
** OSLC including OSLC Query - oslcquery.py
for user use, internally oslcqueryapi.py
implements OSLC Query parsing and querying
** Module Structure - dn_simple_modulestructure.py
- currently external to elmclient
** ReqIF - reqif_io.py
- currently reqif API is external to elmclient
** Reportable REST (incomplete for qm and ccm) - represt.py
for user use, internally for each application in _rm.py
, _ccm.py
, _qm.py
** Process - elmclient
** OSLC including OSLC Query - oslcquery.py
for user use, internally oslcqueryapi.py
implements OSLC Query parsing and querying
** Reportable REST (incomplete for qm and ccm) - represt.py
for user use, internally for each application in _rm.py
, _ccm.py
, _qm.py
** Process - elmclient
** OSLC including OSLC Query - oslcquery.py
for user use, internally oslcqueryapi.py
implements OSLC Query parsing and querying
** Reportable REST (incomplete for qm and ccm) - represt.py
for user use, internally for each application in _rm.py
, _ccm.py
, _qm.py
** Process - elmclient
** OSLC including OSLC Query - oslcquery.py
for user use, internally oslcqueryapi.py
implements OSLC Query parsing and querying
If you find a problem with elmclient you can report it on the github issues https://github.com/IBM/ELM-Python-Client/issues - note this is just for issues with elmclient code. All other issues will likely be closed immediately.
You can do a pull request to propose updates - there's no guarantee of if/when/how these will be merged but we certainly hope to benefit from contributions!