Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/digitronik/sitreps-python-api
Sitreps Python API
https://github.com/digitronik/sitreps-python-api
Last synced: 27 days ago
JSON representation
Sitreps Python API
- Host: GitHub
- URL: https://github.com/digitronik/sitreps-python-api
- Owner: digitronik
- License: mit
- Created: 2022-09-23T16:22:35.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2022-09-29T14:58:30.000Z (over 2 years ago)
- Last Synced: 2024-11-28T03:06:44.573Z (about 1 month ago)
- Language: Python
- Size: 3.29 MB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# sitreps-python-api
No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
This Python package is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:
- API version: 0.1.0
- Package version: 1.2.1
- Build package: org.openapitools.codegen.languages.PythonClientCodegen
## Requirements.
Python >=3.6
## Installation & Usage
### pip install
If the python package is hosted on a repository, you can install directly using:
```sh
pip install git+https://github.com/GIT_USER_ID/GIT_REPO_ID.git
```
(you may need to run `pip` with root permission: `sudo pip install git+https://github.com/GIT_USER_ID/GIT_REPO_ID.git`)
Then import the package:
```python
import sitreps_python_api
```
### Setuptools
Install via [Setuptools](http://pypi.python.org/pypi/setuptools).
```sh
python setup.py install --user
```
(or `sudo python setup.py install` to install the package for all users)
Then import the package:
```python
import sitreps_python_api
```
## Getting Started
Please follow the [installation procedure](#installation--usage) and then run the following:
```python
import time
import sitreps_python_api
from pprint import pprint
from sitreps_python_api.api import code_coverage_api
from sitreps_python_api.model.code_coverage_create import CodeCoverageCreate
from sitreps_python_api.model.http_validation_error import HTTPValidationError
# Defining the host is optional and defaults to http://localhost
# See configuration.py for a list of all supported configuration parameters.
configuration = sitreps_python_api.Configuration(
host = "http://localhost"
)
# Enter a context with an instance of the API client
with sitreps_python_api.ApiClient(configuration) as api_client:
# Create an instance of the API class
api_instance = code_coverage_api.CodeCoverageApi(api_client)
code_coverage_create = CodeCoverageCreate(
time=dateutil_parser('1970-01-01T00:00:00.00Z'),
coverage=3.14,
repository_id=1,
) # CodeCoverageCreate |
try:
# Create Code Coverage
api_response = api_instance.create_code_coverage(code_coverage_create)
pprint(api_response)
except sitreps_python_api.ApiException as e:
print("Exception when calling CodeCoverageApi->create_code_coverage: %s\n" % e)
```
## Documentation for API Endpoints
All URIs are relative to *http://localhost*
Class | Method | HTTP request | Description
------------ | ------------- | ------------- | -------------
*CodeCoverageApi* | [**create_code_coverage**](docs/CodeCoverageApi.md#create_code_coverage) | **POST** /api/v1/coverage/ | Create Code Coverage
*CodeCoverageApi* | [**read_code_coverage**](docs/CodeCoverageApi.md#read_code_coverage) | **GET** /api/v1/coverage/ | Read Code Coverage
*CountLineOfCodeApi* | [**create_cloc**](docs/CountLineOfCodeApi.md#create_cloc) | **POST** /api/v1/cloc/ | Create Cloc
*CountLineOfCodeApi* | [**read_cloc**](docs/CountLineOfCodeApi.md#read_cloc) | **GET** /api/v1/cloc/ | Read Cloc
*IntegrationTestsApi* | [**create_integration_test**](docs/IntegrationTestsApi.md#create_integration_test) | **POST** /api/v1/integrationtest/ | Create Integration Test
*IntegrationTestsApi* | [**read_integration_test**](docs/IntegrationTestsApi.md#read_integration_test) | **GET** /api/v1/integrationtest/ | Read Integration Test
*JiraApi* | [**create_jira**](docs/JiraApi.md#create_jira) | **POST** /api/v1/jira/ | Create Jira
*JiraApi* | [**read_jira**](docs/JiraApi.md#read_jira) | **GET** /api/v1/jira/ | Read Jira
*ProjectGroupsApi* | [**create_project_group**](docs/ProjectGroupsApi.md#create_project_group) | **POST** /api/v1/projectgroups/ | Create Project Group
*ProjectGroupsApi* | [**delete_project_group**](docs/ProjectGroupsApi.md#delete_project_group) | **DELETE** /api/v1/projectgroups/{id} | Delete Project Group
*ProjectGroupsApi* | [**read_project_group**](docs/ProjectGroupsApi.md#read_project_group) | **GET** /api/v1/projectgroups/{id} | Read Project Group
*ProjectGroupsApi* | [**read_project_groups**](docs/ProjectGroupsApi.md#read_project_groups) | **GET** /api/v1/projectgroups/ | Read Project Groups
*ProjectGroupsApi* | [**update_project_group**](docs/ProjectGroupsApi.md#update_project_group) | **PUT** /api/v1/projectgroups/{id} | Update Project Group
*ProjectsApi* | [**create_project**](docs/ProjectsApi.md#create_project) | **POST** /api/v1/projects/ | Create Project
*ProjectsApi* | [**delete_project**](docs/ProjectsApi.md#delete_project) | **DELETE** /api/v1/projects/{id} | Delete Project
*ProjectsApi* | [**read_project**](docs/ProjectsApi.md#read_project) | **GET** /api/v1/projects/ | Read Project
*ProjectsApi* | [**read_project_id**](docs/ProjectsApi.md#read_project_id) | **GET** /api/v1/projects/{id} | Read Project Id
*ProjectsApi* | [**update_project**](docs/ProjectsApi.md#update_project) | **PUT** /api/v1/projects/{id} | Update Project
*RepositoriesApi* | [**create_repository**](docs/RepositoriesApi.md#create_repository) | **POST** /api/v1/repositories/ | Create Repository
*RepositoriesApi* | [**delete_repository**](docs/RepositoriesApi.md#delete_repository) | **DELETE** /api/v1/repositories/{id} | Delete Repository
*RepositoriesApi* | [**read_repository**](docs/RepositoriesApi.md#read_repository) | **GET** /api/v1/repositories/ | Read Repository
*RepositoriesApi* | [**read_repository_id**](docs/RepositoriesApi.md#read_repository_id) | **GET** /api/v1/repositories/{id} | Read Repository Id
*RepositoriesApi* | [**update_repository**](docs/RepositoriesApi.md#update_repository) | **PUT** /api/v1/repositories/{id} | Update Repository
*SonarQubeApi* | [**create_sonarqube**](docs/SonarQubeApi.md#create_sonarqube) | **POST** /api/v1/sonarqube/ | Create Sonarqube
*SonarQubeApi* | [**read_sonarqube**](docs/SonarQubeApi.md#read_sonarqube) | **GET** /api/v1/sonarqube/ | Read Sonarqube
*UnitTestsApi* | [**create_unittests**](docs/UnitTestsApi.md#create_unittests) | **POST** /api/v1/unittests/ | Create Unittests
*UnitTestsApi* | [**read_unittests**](docs/UnitTestsApi.md#read_unittests) | **GET** /api/v1/unittests/ | Read Unittests
*DefaultApi* | [**dump_data**](docs/DefaultApi.md#dump_data) | **POST** /api/v1/ | Dump Data
*DefaultApi* | [**get_status**](docs/DefaultApi.md#get_status) | **GET** /api/v1/ | Get Status
## Documentation For Models
- [CLOCCreate](docs/CLOCCreate.md)
- [CodeCoverageCreate](docs/CodeCoverageCreate.md)
- [Data](docs/Data.md)
- [HTTPValidationError](docs/HTTPValidationError.md)
- [IntegrationTestCreate](docs/IntegrationTestCreate.md)
- [JiraCreate](docs/JiraCreate.md)
- [LocationInner](docs/LocationInner.md)
- [ProjectCreate](docs/ProjectCreate.md)
- [ProjectGroupCreate](docs/ProjectGroupCreate.md)
- [ProjectGroupUpdate](docs/ProjectGroupUpdate.md)
- [RepositoryCreate](docs/RepositoryCreate.md)
- [RepositoryUpdate](docs/RepositoryUpdate.md)
- [SonarQubeCreate](docs/SonarQubeCreate.md)
- [UnitTestCreate](docs/UnitTestCreate.md)
- [ValidationError](docs/ValidationError.md)
## Documentation For Authorization
All endpoints do not require authorization.
## Author
## Notes for Large OpenAPI documents
If the OpenAPI document is large, imports in sitreps_python_api.apis and sitreps_python_api.models may fail with a
RecursionError indicating the maximum recursion limit has been exceeded. In that case, there are a couple of solutions:
Solution 1:
Use specific imports for apis and models like:
- `from sitreps_python_api.api.default_api import DefaultApi`
- `from sitreps_python_api.model.pet import Pet`
Solution 2:
Before importing the package, adjust the maximum recursion limit as shown below:
```
import sys
sys.setrecursionlimit(1500)
import sitreps_python_api
from sitreps_python_api.apis import *
from sitreps_python_api.models import *
```