### Build Project with Make

Source: https://github.com/ibm/elm-python-client/blob/master/elmclient/examples/seq/js-sequence-diagrams/README.md

Run this command to install development dependencies, build the project, and run tests. Ensure Make and npm are installed.

```bash
make
```

--------------------------------

### ETM: Get all test cases in a project

Source: https://github.com/ibm/elm-python-client/blob/master/elmclient/examples/OSLCQUERY.md

This example demonstrates how to query all test cases from an opt-out project in ETM. The -A option specifies the application context root.

```bash
oslcquery -J https://my.server:port -A qm:qm1 -U YOURUSERNAME -P YOURPASSWORD -p "My QM Project" -s dcterms:title -O qmresults.csv
```

--------------------------------

### License Header Example

Source: https://github.com/ibm/elm-python-client/blob/master/CONTRIBUTING.md

Example of a required license header for source files using SPDX format.

```text
#
# Copyright <holder> All Rights Reserved.
#
# SPDX-License-Identifier: MIT
#
```

--------------------------------

### Install elmclient using pip

Source: https://github.com/ibm/elm-python-client/blob/master/README.md

Use this command to install or update the elmclient library from PyPI. This is the quickest method for getting started and for easy updates.

```bash
pip install elmclient
```

```bash
pip install -U elmclient
```

--------------------------------

### HTML for Bower Installation

Source: https://github.com/ibm/elm-python-client/blob/master/elmclient/examples/seq/js-sequence-diagrams/README.md

Include these scripts when using Bower for installation to load necessary dependencies.

```html
<script src="{{ bower directory }}/bower-webfontloader/webfont.js" />
<script src="{{ bower directory }}/snap.svg/dist/snap.svg-min.js" />
<script src="{{ bower directory }}/underscore/underscore-min.js" />
<script src="{{ bower directory }}/js-sequence-diagrams/dist/sequence-diagram-min.js" />
```

--------------------------------

### Test elmclient installation

Source: https://github.com/ibm/elm-python-client/blob/master/README.md

Run this command after installation to verify that elmclient has been set up correctly. A successful execution will display version information and command options.

```bash
oslcquery -h
```

--------------------------------

### Basic Diagram Syntax Examples

Source: https://github.com/ibm/elm-python-client/blob/master/elmclient/examples/seq/js-sequence-diagrams/test/test.html

Illustrates various syntax elements for creating sequence diagrams, including notes positioned relative to actors and over multiple actors. Also shows how to create clickable elements.

```text
#Note left of A: Note to the\n left of A
```

```text
#Note right of A: Note to the\n right of A
```

```text
#Note over A: Note over A
```

```text
Note over A,B: Note over A,B
```

```text
Click Me!
```

--------------------------------

### RM Changeset Creation Example

Source: https://github.com/ibm/elm-python-client/blob/master/README.md

Shows the creation and delivery of a changeset for RM (Requirements Management) in DOORS Next. Note that the delivery result might not be immediately obvious, and these implementations are not fully finished.

```python
dn_simple_typesystemimport_cs.py
```

--------------------------------

### Example: Handling Different Context Roots

Source: https://github.com/ibm/elm-python-client/blob/master/README.md

Illustrates how to specify custom context roots for ELM applications using APPSTRINGs. This is necessary when applications are installed on non-standard paths, such as '/rm1' or '/scm'. Multiple applications can be specified in a comma-separated list.

```text
rm:rm1
```

```text
ccm:scm
```

```text
rm:rm1,jts:jts1
```

--------------------------------

### Query with Global Configuration and Component Contribution

Source: https://github.com/ibm/elm-python-client/blob/master/elmclient/examples/OSLCQUERY.md

This example demonstrates querying artifacts within a project that has components contributing to a global configuration. It uses '-A rm,gc' for global configuration context, '-E' for the GCM project, and '-G' for the global configuration name.

```bash
oslcquery rm_gc_p1 -E gcproj -G "gccomp Initial Development"
```

--------------------------------

### Get All Artifacts in a Project/Component

Source: https://github.com/ibm/elm-python-client/blob/master/elmclient/examples/OSLCQUERY.md

To retrieve all artifacts in a project or component, omit the '-q' option. Use with caution as it can place a significant load on the server.

```bash
oslcquery myproject
```

--------------------------------

### RM Folder Management Example

Source: https://github.com/ibm/elm-python-client/blob/master/README.md

Demonstrates creating a folder path in DOORS Next (DN) using the create_folders() function. This method avoids a forced reload of all folders by directly inserting the new folder into the internal folder information.

```python
dn_simple_createfolderpath.py
```

--------------------------------

### Install elmclient for development

Source: https://github.com/ibm/elm-python-client/blob/master/README.md

Install the elmclient library in editable mode for development. This method is preferred if you intend to modify the elmclient code. It requires forking the GitHub repository first.

```bash
pip install -e .
```

--------------------------------

### DN Resource Example

Source: https://github.com/ibm/elm-python-client/blob/master/README.md

Demonstrates accessing and modifying artifact properties as object attributes for DOORS Next (DN) resources. Print the resource to see modifiable and unmodifiable attributes. Use put() to update.

```python
req.Identifier
```

--------------------------------

### Get Module Resources

Source: https://github.com/ibm/elm-python-client/blob/master/elmclient/examples/REPREST.md

Retrieve all module resources from a specified project and development stream. Ensure the project name is quoted if it contains spaces.

```bash
represt -J https://myserver.com -U myuser -P mypassword rm modules "a project" -l "The Development Stream" --all
```

--------------------------------

### Example: Using Application Passwords for Authentication

Source: https://github.com/ibm/elm-python-client/blob/master/README.md

Demonstrates how to format the password string when using application passwords for authentication with ELM applications. This allows authentication to specific applications like RM or GC, optionally combined with a non-application password.

```text
ap:rm:AP1,gc:AP2,mypassword
```

--------------------------------

### Basic Sequence Diagram Syntax

Source: https://github.com/ibm/elm-python-client/blob/master/elmclient/examples/seq/seqcdn.html

A simple example of the syntax used to define a sequence diagram. This format is parsed by the js-sequence-diagrams library.

```sequence
A->B: Message
```

--------------------------------

### ETM: Specify application context root

Source: https://github.com/ibm/elm-python-client/blob/master/elmclient/examples/OSLCQUERY.md

Similar to EWM, if your ETM application is not on the default context root (e.g., /qm), use the -A option to specify the correct path. For example, -A qm:qm1 for context root /qm1.

```bash
oslcquery -A qm:qm1
```

--------------------------------

### Specify Component for Faster Startup

Source: https://github.com/ibm/elm-python-client/blob/master/elmclient/examples/OSLCQUERY.md

Reduce startup time by specifying a component using `-C`. This limits configuration reading to the specified component.

```bash
oslcquery -C MyComponent ...
```

--------------------------------

### Configure DOORS Next Connection Parameters

Source: https://github.com/ibm/elm-python-client/blob/master/elmclient/examples/DN_SIMPLE_MODULESTRUCTURE.md

Set up connection details for DOORS Next, including host, credentials, and context. Ensure precise capitalization and spacing for names as they appear in the browser.

```python
jazzhost = 'https://jazz.ibm.com:9443'
    
username = 'ibm'
password = 'ibm'

jtscontext = 'jts'
rmcontext  = 'rm'

proj = "rm_optout_p1"
comp = proj
conf =  f"{comp} Initial Stream"
mod = "AMR Stakeholder Requirements Specification"
```

--------------------------------

### Validate API Example

Source: https://github.com/ibm/elm-python-client/blob/master/README.md

An example of using the Validate API, which is available on all ELM applications. Refer to the oslcquery readme for most options.

```python
examples/validate.py
```

--------------------------------

### Signed-off-by Line Example

Source: https://github.com/ibm/elm-python-client/blob/master/CONTRIBUTING.md

Example of a Signed-off-by line to be included in commit messages, indicating acceptance of the Developer's Certificate of Origin (DCO).

```text
Signed-off-by: John Doe <john.doe@example.com>
```

--------------------------------

### Import ReqIF File using reqif_io

Source: https://context7.com/ibm/elm-python-client/llms.txt

Import a ReqIF file into a DOORS Next project using the reqif_io command-line tool. This requires specifying the project, server details, credentials, application, stream, the ReqIF file path, and the target definition name.

```bash
# Import a ReqIF file using an existing definition
reqif_io "My Requirements Project" \
  -J https://jazz.ibm.com:9443 \
  -U ibm -P ibm \
  -A rm \
  -F "Initial Stream" \
  --import --reqiffile mydata.reqifz --definition "My Definition"
```

--------------------------------

### Release Process Steps

Source: https://github.com/ibm/elm-python-client/blob/master/elmclient/examples/seq/js-sequence-diagrams/README.md

A sequence of commands to clean the project, build, stage, commit, tag, and push a new release. Remember to update version numbers in relevant files.

```bash
make clean
make
git add -f src/main.js bower.json dist/*
git commit -m "Released version 2.x.x"
git push origin master
git tag -a v2.x.x -m v2.x.x
git push origin v2.x.x
```

--------------------------------

### Query GCM Components

Source: https://github.com/ibm/elm-python-client/blob/master/elmclient/examples/OSLCQUERY.md

Example of querying for the `Component` resource type in GCM. The default resource type is `oslc_config:Configuration`.

```bash
oslcquery -r Component ...
```

--------------------------------

### Query GC Configurations in a Project

Source: https://github.com/ibm/elm-python-client/blob/master/elmclient/examples/OSLCQUERY.md

Retrieve details of all GC configurations within a specified project. Replace placeholders with your server details.

```bash
oslcquery -J https://my.server:port -U YOURUSERNAME -P YOURPASSWORD -A gc -p "My GC Project" -O gcmresults.csv
```

--------------------------------

### Navigate to Component and Configuration

Source: https://context7.com/ibm/elm-python-client/llms.txt

For configuration-management-enabled projects, use `find_local_component()` to retrieve a component and `set_local_config()` to specify the active stream, baseline, or changeset.

```python
proj = rmapp.find_project("rm_optin_p1")

# Load all components declared in this project
proj.load_components_and_configurations()

# Retrieve a specific component by name
comp = proj.find_local_component("rm_optin_p1")
if not comp:
    raise Exception("Component not found")

```

--------------------------------

### List ReqIF Definitions using reqif_io

Source: https://context7.com/ibm/elm-python-client/llms.txt

List all available ReqIF definitions within a specified project using the reqif_io command-line tool. Provide the project name, Jazz server URL, and user credentials.

```bash
# List all ReqIF definitions in a project
reqif_io "My Requirements Project" \
  -J https://jazz.ibm.com:9443 -U ibm -P ibm \
  --list
```

--------------------------------

### EWM: Query for new defect work items

Source: https://github.com/ibm/elm-python-client/blob/master/elmclient/examples/OSLCQUERY.md

Filter work items by their status. This example finds all 'Defect' work items where the 'Status' is 'New'.

```bash
oslcquery -q Defect.Status=New
```

--------------------------------

### Get Details of a Core Artifact

Source: https://github.com/ibm/elm-python-client/blob/master/elmclient/examples/REPREST.md

Retrieve details for a core artifact using its ID. Requires project, development stream, and core resource ID.

```bash
represt -J https://myserver.com -U myuser -P mypassword rm resources -p "a project" -l "The Development Stream" -s 123
```

--------------------------------

### Draw Text and Get Bounding Box

Source: https://github.com/ibm/elm-python-client/blob/master/elmclient/examples/seq/js-sequence-diagrams/test/align.html

Renders multi-line text with specified font and calculates its bounding box. Useful for positioning and layout calculations.

```javascript
var paper = Snap("#svg");
var RECT = { 'stroke': '#000000', 'stroke-width': 1, 'fill': "none" };

function draw_cross(x, y) {
  var SIZE = 25;
  paper.line(x, y - SIZE, x, y + SIZE).attr(RECT);
  paper.line(x - SIZE, y, x + SIZE, y).attr(RECT);
  draw_coord(x, y);
}

function draw_coord(x, y) {
  var p = paper.text(x, y, x.toFixed(0) + "," + y.toFixed(0));
  p.attr({'font-size': 10});
}

function draw_bb(bb) {
  paper.rect(bb.x, bb.y, bb.width, bb.height).attr(RECT);
  draw_coord(bb.x, bb.y);
  draw_coord(bb.x + bb.width, bb.y);
  draw_coord(bb.x, bb.y + bb.height);
  draw_coord(bb.x + bb.width, bb.y + bb.height);
}

function draw_text(x, y, text, font) {
  // TODO We can share code between this and draw_text
  text = _.invoke(text.split("\n"), 'trim');
  var t = paper.text(x, y, text);
  t.attr(font || {});
  // Every row after the first, set tspan to be 1.2em below the previous line
  t.selectAll("tspan:nth-child(n+2)").attr({ dy: "1em", x: x });
  return t;
}

var font = {'font-size': '64px'};
////////

draw_cross(100, 100);
var p = paper.text(100, 100, "Text\n100,100\nThird");
p.attr(font);
draw_bb( p.getBBox() );
console.log(p.getBBox());
////////

draw_cross(100, 200);
var p = draw_text(100, 200, "Text\n100,100\nThird", font);
draw_bb( p.getBBox() );
console.log(p.getBBox());
console.log(p.getBBox().height / 3);

/*
var font = paper.getFont('daniel')
var p = paper.print(100, 300, "Print\n100,300\nThird", font, 32, 'baseline');
draw_bb( p.getBBox() );
////////

var font = paper.getFont('daniel')
var p = paper.print_center(100, 500, "MyPrint\n100,500\nThird", font, 32);
draw_bb( p.getBBox() );
*/
```

--------------------------------

### Get Module Resources in a View

Source: https://github.com/ibm/elm-python-client/blob/master/elmclient/examples/REPREST.md

Retrieve module resources within a specific view (module) of a project. Requires project, development stream, and module name.

```bash
represt -J https://myserver.com -U myuser -P mypassword rm modules "a project" -l "The Development Stream" -m "The Module"
```

--------------------------------

### Run Tests with Make

Source: https://github.com/ibm/elm-python-client/blob/master/elmclient/examples/seq/js-sequence-diagrams/README.md

Execute tests using the Makefile. This command runs tests against multiple permutations of libraries and minification levels.

```bash
make test
```

--------------------------------

### Get Details of an Artifact (Core or Module)

Source: https://github.com/ibm/elm-python-client/blob/master/elmclient/examples/REPREST.md

Fetch details for a specific artifact (core or module) using its ID. Requires project, development stream, and resource ID.

```bash
represt -J https://myserver.com -U myuser -P mypassword rm resources -p "a project" -l "The Development Stream" -r 123
```

--------------------------------

### Export RM Artifacts with Type Information

Source: https://github.com/ibm/elm-python-client/blob/master/elmclient/examples/OSLCQUERY.md

This example shows how to include the 'rdf:type' in the select options to differentiate between artifact types like 'jazz_rm:Collection' and 'jazz_rm:Module'.

```bash
-s dcterms:title,rdf:type
```

--------------------------------

### Export All QM Configurations

Source: https://github.com/ibm/elm-python-client/blob/master/elmclient/examples/OSLCQUERY.md

This command exports all Quality Management (QM) configurations to a CSV file. This is the default behavior if no specific query is provided for configurations.

```bash
oslcquery -A qm -O allqmconfigs.csv
```

--------------------------------

### Get Details of a Reused Artifact in a Module

Source: https://github.com/ibm/elm-python-client/blob/master/elmclient/examples/REPREST.md

Fetch details for a reused artifact within a module using its ID. Requires project, development stream, and the reused resource ID.

```bash
represt -J https://myserver.com -U myuser -P mypassword rm resources -p "a project" -l "The Development Stream" -q 123
```

--------------------------------

### Securely Get DOORS Next Password

Source: https://github.com/ibm/elm-python-client/blob/master/elmclient/examples/DN_SIMPLE_MODULESTRUCTURE.md

Replace hardcoded password retrieval with a runtime prompt using `getpass` for enhanced security. This avoids embedding sensitive credentials directly in the script.

```python
import getpass
password = getpass.getpass( "ELM password?" )
```

--------------------------------

### ReqIF IO Optional Argument: CONFIGURATION

Source: https://github.com/ibm/elm-python-client/blob/master/elmclient/examples/REQIF_IO.md

Specifies the scope as the name of the local configuration. Requires the project name to be provided.

```bash
-F CONFIGURATION, --configuration CONFIGURATION
```

--------------------------------

### ReqIF IO Optional Argument: COMPONENT

Source: https://github.com/ibm/elm-python-client/blob/master/elmclient/examples/REQIF_IO.md

Specifies the local component. If used, the local configuration must also be specified using the -F argument.

```bash
-C COMPONENT, --component COMPONENT
```

--------------------------------

### Create Obfuscated Credentials with Runtime Password Prompt

Source: https://github.com/ibm/elm-python-client/blob/master/elmclient/examples/OSLCQUERY.md

Create an obfuscated credentials file and use a runtime prompt for the password with the -4 option. This is more secure as the password is not stored in plain text or command history.

```bash
oslcquery -J https://myserver:port -U measadmin -P secret -A rm:rm1,jts:jts23 -1 .mycreds -4
```

--------------------------------

### Specify GC Component and Local Configuration

Source: https://github.com/ibm/elm-python-client/blob/master/elmclient/examples/OSLCQUERY.md

Further optimize by specifying a GC component (`-E`, `-G`) and a local configuration (`-F`).

```bash
oslcquery -C MyComponent -E MyGC -G 26 -F MyLocalConfig ...
```