sphinx-needs-capri 0.1.0

Synchronize codebeamer with Sphinx-Needs

This Sphinx extension provides scripts and directives to synchronize data between codebeamer from Intland and the Requirement Engineering extension Sphinx-Needs from useblocks.

License

This software is licensed under BSL 1.1 and it can be used and distributed for free as long as it is not used for and inside commercial projects, products or documentations.

A commercial license can be obtained by contacting the useblocks team.

See our License file for details. Or take a look into the general BSL FAQ.

Development

Codebeamer - Docker

To start a codebeamer server local, you can use docker-compose up -d under /docker. This will download, create and run a codebeamer and a mysql container.

After that open http://127.0.0.1:8080 in your browser and use the default codebeamer user bond with password 007.

To stop everything, run docker-compose down under /docker.

For more information take a look into Codebeamer’s Docker documentation.

License

codebeamer gets executed with an evaluation license, which is valid for 7 days.

If you need a more suitable license, you can request one from the codebeamer support team: [e-mail].

The support team will need your Host-ID, which should be by default LIN-02:42:AC:16:00:03 for most docker installations. You can check this and other License details under: http://127.0.0.1:8080/sysadmin/configLicense.spr

To add your own license, create /docker/.env and add the following content:

# Your MAC Address
CB_MAC_ADDRESS=02:42:AC:16:00:03
CB_LICENSE=<license ...> ... </license>  #All in one line

REST access

The default user bond has already all needed privileges to access the codebeamer REST API under http://127.0.0.1:8080/rest.

For a quick test, execute curl --user bond:007 http://127.0.0.1:8080/rest/user/bond.

Return value should be:

{
  "uri" : "/user/1",
  "name" : "bond",
  "firstName" : "Default",
  "lastName" : "System Administrator",
  "dateFormat" : "MMM dd yyyy",
  "status" : "Activated"
}

There is also a swagger-ui available to analyse the complete REST-API: http://127.0.0.1:8080/v3/swagger/editor.spr.