File tree Expand file tree Collapse file tree
Expand file tree Collapse file tree Original file line number Diff line number Diff line change @@ -15,9 +15,7 @@ A basic Python client library for interacting with a SysML v2 API server, specif
1515* Includes basic error handling and custom exceptions.
1616
1717## Setup
18-
1918### 1. Run Flexo SysMLv2 Service Locally
20-
2119This client is designed to work with a running instance of the OpenMBEE Flexo SysMLv2 service.
2220
2321* ** Prerequisites:** Docker and Docker Compose installed.
@@ -31,7 +29,6 @@ This client is designed to work with a running instance of the OpenMBEE Flexo Sy
3129
3230# ## 2. Install Client (Development)
3331
34-
3532` ` ` python
3633# Example: Add src to path if running scripts/notebooks from project root
3734import sys
@@ -42,7 +39,6 @@ from sysmlv2_client import SysMLV2Client
4239` ` `
4340
4441# # Basic Usage
45-
4642` ` ` python
4743from sysmlv2_client import SysMLV2Client, SysMLV2Error
4844from pprint import pprint
@@ -122,3 +118,31 @@ Unit tests are implemented using `pytest` and `requests-mock`.
122118 ` ` ` bash
123119 pytest
124120 ` ` `
121+
122+ # # API
123+ # ## Basic v2 API
124+ * get_projects
125+ * create_project
126+ * delete_project
127+ * get_project_by_id
128+ * get_element
129+ * get_owned_elements
130+ * create_commit
131+ * get_commit_by_id
132+ * list_commits
133+ * list_branches
134+ * create_branch
135+ * get_branch_by_id
136+ * list_tags
137+ * create_tag
138+ * get_tag_by_id
139+ * list_elements
140+ * list_relationships
141+
142+ # ## Convenience functions
143+ * create_sysml_project
144+ * get_project_by_name
145+ * commit_to_project
146+ * get_last_commit_from_project
147+ * create_branch
148+
You can’t perform that action at this time.
0 commit comments