{"id":20823000,"url":"https://github.com/systems-modeling/sysml-v2-api-python-client","last_synced_at":"2025-10-20T07:35:15.206Z","repository":{"id":53009596,"uuid":"186477811","full_name":"Systems-Modeling/SysML-v2-API-Python-Client","owner":"Systems-Modeling","description":"Python client software for the Systems Modeling API.","archived":false,"fork":false,"pushed_at":"2021-10-14T23:21:26.000Z","size":269,"stargazers_count":19,"open_issues_count":1,"forks_count":2,"subscribers_count":16,"default_branch":"master","last_synced_at":"2023-03-06T00:50:06.643Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"lgpl-3.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/Systems-Modeling.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2019-05-13T18:53:31.000Z","updated_at":"2023-02-07T18:08:06.000Z","dependencies_parsed_at":"2022-09-08T08:20:20.982Z","dependency_job_id":null,"html_url":"https://github.com/Systems-Modeling/SysML-v2-API-Python-Client","commit_stats":null,"previous_names":[],"tags_count":null,"template":null,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Systems-Modeling%2FSysML-v2-API-Python-Client","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Systems-Modeling%2FSysML-v2-API-Python-Client/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Systems-Modeling%2FSysML-v2-API-Python-Client/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Systems-Modeling%2FSysML-v2-API-Python-Client/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/Systems-Modeling","download_url":"https://codeload.github.com/Systems-Modeling/SysML-v2-API-Python-Client/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":225096536,"owners_count":17420293,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-11-17T22:16:51.561Z","updated_at":"2025-10-20T07:35:10.167Z","avatar_url":"https://github.com/Systems-Modeling.png","language":"Python","readme":"# sysml-v2-api-client\nREST/HTTP binding (PSM) for the SysML v2 standard API.\n\nThis Python package is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:\n\n- API version: 1.0.0\n- Package version: 2021-09\n- Build package: org.openapitools.codegen.languages.PythonClientCodegen\n\n## Requirements.\n\nPython 2.7 and 3.4+\n\n## Installation \u0026 Usage\n### pip install\n\nIf the python package is hosted on a repository, you can install directly using:\n\n```sh\npip install git+https://github.com/GIT_USER_ID/GIT_REPO_ID.git\n```\n(you may need to run `pip` with root permission: `sudo pip install git+https://github.com/GIT_USER_ID/GIT_REPO_ID.git`)\n\nThen import the package:\n```python\nimport sysml_v2_api_client\n```\n\n### Setuptools\n\nInstall via [Setuptools](http://pypi.python.org/pypi/setuptools).\n\n```sh\npython setup.py install --user\n```\n(or `sudo python setup.py install` to install the package for all users)\n\nThen import the package:\n```python\nimport sysml_v2_api_client\n```\n\n## Getting Started\n\nPlease follow the [installation procedure](#installation--usage) and then run the following:\n\n```python\nfrom __future__ import print_function\n\nimport time\nimport sysml_v2_api_client\nfrom sysml_v2_api_client.rest import ApiException\nfrom pprint import pprint\n\n# Defining the host is optional and defaults to http://localhost\n# See configuration.py for a list of all supported configuration parameters.\nconfiguration = sysml_v2_api_client.Configuration(\n    host = \"http://localhost\"\n)\n\n\n\n# Enter a context with an instance of the API client\nwith sysml_v2_api_client.ApiClient(configuration) as api_client:\n    # Create an instance of the API class\n    api_instance = sysml_v2_api_client.BranchApi(api_client)\n    project_id = 'project_id_example' # str | ID of the project\nbranch_id = 'branch_id_example' # str | ID of the branch\n\n    try:\n        # Delete branch by project and ID\n        api_response = api_instance.delete_branch_by_project_and_id(project_id, branch_id)\n        pprint(api_response)\n    except ApiException as e:\n        print(\"Exception when calling BranchApi-\u003edelete_branch_by_project_and_id: %s\\n\" % e)\n    \n```\n\n## Documentation for API Endpoints\n\nAll URIs are relative to *http://localhost*\n\nClass | Method | HTTP request | Description\n------------ | ------------- | ------------- | -------------\n*BranchApi* | [**delete_branch_by_project_and_id**](docs/BranchApi.md#delete_branch_by_project_and_id) | **DELETE** /projects/{projectId}/branches/{branchId} | Delete branch by project and ID\n*BranchApi* | [**get_branches_by_project**](docs/BranchApi.md#get_branches_by_project) | **GET** /projects/{projectId}/branches | Get branches by project\n*BranchApi* | [**get_branches_by_project_and_id**](docs/BranchApi.md#get_branches_by_project_and_id) | **GET** /projects/{projectId}/branches/{branchId} | Get branch by project and ID\n*BranchApi* | [**post_branch_by_project**](docs/BranchApi.md#post_branch_by_project) | **POST** /projects/{projectId}/branches | Create branch by project\n*CommitApi* | [**get_commit_by_project_and_id**](docs/CommitApi.md#get_commit_by_project_and_id) | **GET** /projects/{projectId}/commits/{commitId} | Get commit by project and ID\n*CommitApi* | [**get_commits_by_project**](docs/CommitApi.md#get_commits_by_project) | **GET** /projects/{projectId}/commits | Get commits by project\n*CommitApi* | [**post_commit_by_project**](docs/CommitApi.md#post_commit_by_project) | **POST** /projects/{projectId}/commits | Create commit by project\n*ElementApi* | [**get_element_by_project_commit_id**](docs/ElementApi.md#get_element_by_project_commit_id) | **GET** /projects/{projectId}/commits/{commitId}/elements/{elementId} | Get element by project, commit and ID\n*ElementApi* | [**get_elements_by_project_commit**](docs/ElementApi.md#get_elements_by_project_commit) | **GET** /projects/{projectId}/commits/{commitId}/elements | Get elements by project and commit\n*ElementApi* | [**get_roots_by_project_commit**](docs/ElementApi.md#get_roots_by_project_commit) | **GET** /projects/{projectId}/commits/{commitId}/roots | Get root elements by project and commit\n*ProjectApi* | [**delete_project_by_id**](docs/ProjectApi.md#delete_project_by_id) | **DELETE** /projects/{projectId} | Delete project by ID\n*ProjectApi* | [**get_project_by_id**](docs/ProjectApi.md#get_project_by_id) | **GET** /projects/{projectId} | Get project by ID\n*ProjectApi* | [**get_projects**](docs/ProjectApi.md#get_projects) | **GET** /projects | Get projects\n*ProjectApi* | [**post_project**](docs/ProjectApi.md#post_project) | **POST** /projects | Create project\n*ProjectApi* | [**put_project_by_id**](docs/ProjectApi.md#put_project_by_id) | **PUT** /projects/{projectId} | Update project by ID\n*QueryApi* | [**delete_query_by_project_and_id**](docs/QueryApi.md#delete_query_by_project_and_id) | **DELETE** /projects/{projectId}/queries/{queryId} | Delete query by project and ID\n*QueryApi* | [**get_queries_by_project**](docs/QueryApi.md#get_queries_by_project) | **GET** /projects/{projectId}/queries | Get queries by project\n*QueryApi* | [**get_query_by_project_and_id**](docs/QueryApi.md#get_query_by_project_and_id) | **GET** /projects/{projectId}/queries/{queryId} | Get query by project and ID\n*QueryApi* | [**get_query_results_by_project_id_query**](docs/QueryApi.md#get_query_results_by_project_id_query) | **GET** /projects/{projectId}/query-results | Get query results by project and query definition\n*QueryApi* | [**get_query_results_by_project_id_query_id**](docs/QueryApi.md#get_query_results_by_project_id_query_id) | **GET** /projects/{projectId}/queries/{queryId}/results | Get query results by project and query\n*QueryApi* | [**get_query_results_by_project_id_query_post**](docs/QueryApi.md#get_query_results_by_project_id_query_post) | **POST** /projects/{projectId}/query-results | Get query results by project and query definition via POST\n*QueryApi* | [**post_query_by_project**](docs/QueryApi.md#post_query_by_project) | **POST** /projects/{projectId}/queries | Create query by project\n*RelationshipApi* | [**get_relationships_by_project_commit_related_element**](docs/RelationshipApi.md#get_relationships_by_project_commit_related_element) | **GET** /projects/{projectId}/commits/{commitId}/elements/{relatedElementId}/relationships | Get relationships by project, commit, and related element\n*TagApi* | [**delete_tag_by_project_and_id**](docs/TagApi.md#delete_tag_by_project_and_id) | **DELETE** /projects/{projectId}/tags/{tagId} | Delete tag by project and ID\n*TagApi* | [**get_tag_by_project_and_id**](docs/TagApi.md#get_tag_by_project_and_id) | **GET** /projects/{projectId}/tags/{tagId} | Get tag by project and ID\n*TagApi* | [**get_tags_by_project**](docs/TagApi.md#get_tags_by_project) | **GET** /projects/{projectId}/tags | Get tags by project\n*TagApi* | [**post_tag_by_project**](docs/TagApi.md#post_tag_by_project) | **POST** /projects/{projectId}/tags | Create tag by project\n\n\n## Documentation For Models\n\n - [Branch](docs/Branch.md)\n - [BranchHead](docs/BranchHead.md)\n - [BranchOwningProject](docs/BranchOwningProject.md)\n - [Commit](docs/Commit.md)\n - [CompositeConstraint](docs/CompositeConstraint.md)\n - [Constraint](docs/Constraint.md)\n - [Data](docs/Data.md)\n - [DataIdentity](docs/DataIdentity.md)\n - [DataVersion](docs/DataVersion.md)\n - [Element](docs/Element.md)\n - [Error](docs/Error.md)\n - [Identified](docs/Identified.md)\n - [PrimitiveConstraint](docs/PrimitiveConstraint.md)\n - [Project](docs/Project.md)\n - [ProjectDefaultBranch](docs/ProjectDefaultBranch.md)\n - [Query](docs/Query.md)\n - [Relationship](docs/Relationship.md)\n - [Tag](docs/Tag.md)\n\n\n## Documentation For Authorization\n\n All endpoints do not require authorization.\n\n## Author\n\n\n\n\n","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsystems-modeling%2Fsysml-v2-api-python-client","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fsystems-modeling%2Fsysml-v2-api-python-client","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsystems-modeling%2Fsysml-v2-api-python-client/lists"}