Skip to content

Develop #4

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
wobrschalek merged 2 commits into from
Feb 26, 2026
Merged

Develop #4

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
eb77652
Update README.md
wobrschalek Feb 25, 2026
d0a93c5
test with python 3.12.9
wobrschalek Feb 26, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
32 changes: 28 additions & 4 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,9 +15,7 @@ A basic Python client library for interacting with a SysML v2 API server, specif
* Includes basic error handling and custom exceptions.

## Setup

### 1. Run Flexo SysMLv2 Service Locally

This client is designed to work with a running instance of the OpenMBEE Flexo SysMLv2 service.

* **Prerequisites:** Docker and Docker Compose installed.
Expand All @@ -31,7 +29,6 @@ This client is designed to work with a running instance of the OpenMBEE Flexo Sy

### 2. Install Client (Development)


```python
# Example: Add src to path if running scripts/notebooks from project root
import sys
Expand All @@ -42,7 +39,6 @@ from sysmlv2_client import SysMLV2Client
```

## Basic Usage

```python
from sysmlv2_client import SysMLV2Client, SysMLV2Error
from pprint import pprint
Expand Down Expand Up @@ -122,3 +118,31 @@ Unit tests are implemented using `pytest` and `requests-mock`.
```bash
pytest
```

## API
### Basic v2 API
* get_projects
* create_project
* delete_project
* get_project_by_id
* get_element
* get_owned_elements
* create_commit
* get_commit_by_id
* list_commits
* list_branches
* create_branch
* get_branch_by_id
* list_tags
* create_tag
* get_tag_by_id
* list_elements
* list_relationships

### Convenience functions
* create_sysml_project
* get_project_by_name
* commit_to_project
* get_last_commit_from_project
* create_branch

4 changes: 2 additions & 2 deletions examples/basic_usage.ipynb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -777,7 +777,7 @@
],
"metadata": {
"kernelspec": {
"display_name": "Python 3",
"display_name": ".venv (3.12.9)",
"language": "python",
"name": "python3"
},
Expand All @@ -791,7 +791,7 @@
"name": "python",
"nbconvert_exporter": "python",
"pygments_lexer": "ipython3",
"version": "3.9.7"
"version": "3.12.9"
}
},
"nbformat": 4,
Expand Down