PhrameAPI

Name	PhrameAPI JSON
Version	1.1.0 JSON
	download
home_page	None
Summary	Phrame API
upload_time	2025-01-29 12:47:36
maintainer	None
docs_url	None
author	David Atkins
requires_python	>=3.4
license	Copyright © 2025 3ADesign Limited Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the “Software”), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
keywords	openapi openapi-generator phrameapi
VCS
bugtrack_url
requirements	No requirements were recorded.
Travis-CI	No Travis.
coveralls test coverage	No coveralls.

            # PhrameAPI
Phrame API

This Python package is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:

- API version: 1.0.2
- Package version: 1.0.2
- Build package: org.openapitools.codegen.languages.PythonLegacyClientCodegen

## Requirements.

Python 2.7 and 3.4+

## 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 PhrameAPI
```

### 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 PhrameAPI
```

## Getting Started

Please follow the [installation procedure](#installation--usage) and then run the following:

```python
from __future__ import print_function

import time
import PhrameAPI
from PhrameAPI.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to http://localhost/PhrameServer
# See configuration.py for a list of all supported configuration parameters.
configuration = PhrameAPI.Configuration(
    host = "http://localhost/PhrameServer"
)



# Enter a context with an instance of the API client
with PhrameAPI.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = PhrameAPI.PhrameApi(api_client)
    component_name = 'component_name_example' # str | Name of component
version_id = 'version_id_example' # str | ID of component (optional)

    try:
        # DELETE Component
        api_instance.minio_delete_ui_component(component_name, version_id=version_id)
    except ApiException as e:
        print("Exception when calling PhrameApi->minio_delete_ui_component: %s\n" % e)
    
```

## Documentation for API Endpoints

All URIs are relative to *http://localhost/PhrameServer*

Class | Method | HTTP request | Description
------------ | ------------- | ------------- | -------------
*PhrameApi* | [**minio_delete_ui_component**](docs/PhrameApi.md#minio_delete_ui_component) | **DELETE** /components | DELETE Component
*PhrameApi* | [**minio_delete_ui_config**](docs/PhrameApi.md#minio_delete_ui_config) | **DELETE** /config | DELETE config
*PhrameApi* | [**minio_get_all_component_names**](docs/PhrameApi.md#minio_get_all_component_names) | **GET** /components/all | Get all components
*PhrameApi* | [**minio_get_all_config_names**](docs/PhrameApi.md#minio_get_all_config_names) | **GET** /config/all | GET all configs
*PhrameApi* | [**minio_get_ui_component**](docs/PhrameApi.md#minio_get_ui_component) | **GET** /components | GET Components
*PhrameApi* | [**minio_get_ui_config**](docs/PhrameApi.md#minio_get_ui_config) | **GET** /config | GET config
*PhrameApi* | [**minio_post_ui_component**](docs/PhrameApi.md#minio_post_ui_component) | **POST** /components | POST component
*PhrameApi* | [**minio_post_ui_config**](docs/PhrameApi.md#minio_post_ui_config) | **POST** /config | POST config


## Documentation For Models

 - [DbPhrameJSONStore](docs/DbPhrameJSONStore.md)
 - [DbPhrameUIConfiguration](docs/DbPhrameUIConfiguration.md)


## Documentation For Authorization

 All endpoints do not require authorization.

## Author

david@3adesign.co.uk



            

Raw data

            {
    "_id": null,
    "home_page": null,
    "name": "PhrameAPI",
    "maintainer": null,
    "docs_url": null,
    "requires_python": ">=3.4",
    "maintainer_email": null,
    "keywords": "OpenAPI, OpenAPI-Generator, PhrameAPI",
    "author": "David Atkins",
    "author_email": "Gustav Rodel <gustav.rodel@3adesign.co.uk>, David Atkins <david@3adesign.co.uk>",
    "download_url": "https://files.pythonhosted.org/packages/36/85/d5e78e7586e9bdaaf1839427bc869f093e9768f3e3fa2d40353e91735e17/phrameapi-1.1.0.tar.gz",
    "platform": null,
    "description": "# PhrameAPI\nPhrame API\n\nThis Python package is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:\n\n- API version: 1.0.2\n- Package version: 1.0.2\n- Build package: org.openapitools.codegen.languages.PythonLegacyClientCodegen\n\n## Requirements.\n\nPython 2.7 and 3.4+\n\n## Installation & 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 PhrameAPI\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 PhrameAPI\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 PhrameAPI\nfrom PhrameAPI.rest import ApiException\nfrom pprint import pprint\n\n# Defining the host is optional and defaults to http://localhost/PhrameServer\n# See configuration.py for a list of all supported configuration parameters.\nconfiguration = PhrameAPI.Configuration(\n    host = \"http://localhost/PhrameServer\"\n)\n\n\n\n# Enter a context with an instance of the API client\nwith PhrameAPI.ApiClient(configuration) as api_client:\n    # Create an instance of the API class\n    api_instance = PhrameAPI.PhrameApi(api_client)\n    component_name = 'component_name_example' # str | Name of component\nversion_id = 'version_id_example' # str | ID of component (optional)\n\n    try:\n        # DELETE Component\n        api_instance.minio_delete_ui_component(component_name, version_id=version_id)\n    except ApiException as e:\n        print(\"Exception when calling PhrameApi->minio_delete_ui_component: %s\\n\" % e)\n    \n```\n\n## Documentation for API Endpoints\n\nAll URIs are relative to *http://localhost/PhrameServer*\n\nClass | Method | HTTP request | Description\n------------ | ------------- | ------------- | -------------\n*PhrameApi* | [**minio_delete_ui_component**](docs/PhrameApi.md#minio_delete_ui_component) | **DELETE** /components | DELETE Component\n*PhrameApi* | [**minio_delete_ui_config**](docs/PhrameApi.md#minio_delete_ui_config) | **DELETE** /config | DELETE config\n*PhrameApi* | [**minio_get_all_component_names**](docs/PhrameApi.md#minio_get_all_component_names) | **GET** /components/all | Get all components\n*PhrameApi* | [**minio_get_all_config_names**](docs/PhrameApi.md#minio_get_all_config_names) | **GET** /config/all | GET all configs\n*PhrameApi* | [**minio_get_ui_component**](docs/PhrameApi.md#minio_get_ui_component) | **GET** /components | GET Components\n*PhrameApi* | [**minio_get_ui_config**](docs/PhrameApi.md#minio_get_ui_config) | **GET** /config | GET config\n*PhrameApi* | [**minio_post_ui_component**](docs/PhrameApi.md#minio_post_ui_component) | **POST** /components | POST component\n*PhrameApi* | [**minio_post_ui_config**](docs/PhrameApi.md#minio_post_ui_config) | **POST** /config | POST config\n\n\n## Documentation For Models\n\n - [DbPhrameJSONStore](docs/DbPhrameJSONStore.md)\n - [DbPhrameUIConfiguration](docs/DbPhrameUIConfiguration.md)\n\n\n## Documentation For Authorization\n\n All endpoints do not require authorization.\n\n## Author\n\ndavid@3adesign.co.uk\n\n\n",
    "bugtrack_url": null,
    "license": "Copyright \u00a9 2025 3ADesign Limited\n        \n        Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the \u201cSoftware\u201d), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:\n        \n        The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.\n        \n        THE SOFTWARE IS PROVIDED \u201cAS IS\u201d, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.\n        ",
    "summary": "Phrame API",
    "version": "1.1.0",
    "project_urls": null,
    "split_keywords": [
        "openapi",
        " openapi-generator",
        " phrameapi"
    ],
    "urls": [
        {
            "comment_text": null,
            "digests": {
                "blake2b_256": "9ac6aec28637cd3671cf3c9ad95385a2c70aa297d73c39357ed3e4e93538f91d",
                "md5": "27efb63d7ee2e1991bae598ea3e24ddc",
                "sha256": "8c550782539825c44b250eb48feae097497a4d708a71e7ad692f484f44c1b926"
            },
            "downloads": -1,
            "filename": "PhrameAPI-1.1.0-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "27efb63d7ee2e1991bae598ea3e24ddc",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.4",
            "size": 27746,
            "upload_time": "2025-01-29T12:47:34",
            "upload_time_iso_8601": "2025-01-29T12:47:34.109178Z",
            "url": "https://files.pythonhosted.org/packages/9a/c6/aec28637cd3671cf3c9ad95385a2c70aa297d73c39357ed3e4e93538f91d/PhrameAPI-1.1.0-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": null,
            "digests": {
                "blake2b_256": "3685d5e78e7586e9bdaaf1839427bc869f093e9768f3e3fa2d40353e91735e17",
                "md5": "3a410944433adb8bcbfca64a56fc8779",
                "sha256": "49599d83f8fac71567487d9f03a2d49082f776ce6e50d31ece4d765eab35e171"
            },
            "downloads": -1,
            "filename": "phrameapi-1.1.0.tar.gz",
            "has_sig": false,
            "md5_digest": "3a410944433adb8bcbfca64a56fc8779",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.4",
            "size": 26973,
            "upload_time": "2025-01-29T12:47:36",
            "upload_time_iso_8601": "2025-01-29T12:47:36.105391Z",
            "url": "https://files.pythonhosted.org/packages/36/85/d5e78e7586e9bdaaf1839427bc869f093e9768f3e3fa2d40353e91735e17/phrameapi-1.1.0.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2025-01-29 12:47:36",
    "github": false,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "lcname": "phrameapi"
}