Skip to main content
/docs/_static/sphinx_needs_codebeamer_logo.png

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: support@intland.com.

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.

Metadata

Release files for sphinx-needs-capri 0.1.0

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for sphinx-needs-capri 0.1.0
File Size Uploaded
sphinx-needs-capri-0.1.0.tar.gz 6.0 kB Details

Built distribution (wheel)

Table of built distributions (wheels) for sphinx-needs-capri 0.1.0
File Interpreter ABI Platform
sphinx_needs_capri-0.1.0-py3-none-any.whl Python 3 none any Details

Total release size: 12.6 kB

Release files / sphinx-needs-capri-0.1.0.tar.gz

Download URL sphinx-needs-capri-0.1.0.tar.gz
Size 6.0 kB
Tags Source
SHA-256 checksum
How to use checksums
dab06d5ccbc8b2997a113f8a3f62b08309317d0aa6ee5e09bf3cceed68963723
BLAKE2b-256 checksum
How to use checksums
52071a6a82b2d0f2a588ef4fc968e07833a0f268fc6f5d1defefc9ad2118fb0d
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via poetry/1.1.8 CPython/3.9.6 Linux/5.13.1-3-MANJARO

Release files / sphinx_needs_capri-0.1.0-py3-none-any.whl

Download URL sphinx_needs_capri-0.1.0-py3-none-any.whl
Size 6.7 kB
Tags Python 3
SHA-256 checksum
How to use checksums
fb4fb2600fbcda1b30d900f7fd653ab33d63e4cab8691f95fc6e2f8326dfe2a8
BLAKE2b-256 checksum
How to use checksums
c905260df19ba9acad6ee3c29598386106642a4d89ba3b574d0d7b5bbe3e9a8b
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via poetry/1.1.8 CPython/3.9.6 Linux/5.13.1-3-MANJARO

Release history Release notifications | RSS feed

This release

0.1.0 This release

2 release files

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page