|
1 |
| -# aspose-Diagram-cloud-python |
2 |
| - |
3 |
| -Aspose.Diagram Cloud SDK for Python allows you to use Aspose.Diagram APIs in your Python applications |
4 |
| - |
5 |
| -- Package version: 18.10 |
6 |
| -- Build package: io.swagger.codegen.languages.PythonClientCodegen |
7 |
| - |
8 |
| -## Requirements. |
9 |
| - |
10 |
| -Python 2.7 and 3.5 |
11 |
| - |
12 |
| -## Installation & Usage |
13 |
| -### pip install |
14 |
| - |
15 |
| -```sh |
16 |
| -pip install asposediagramcloud |
17 |
| -``` |
18 |
| -(you may need to run `pip` with root permission: `sudo pip install asposediagramcloud`) |
19 |
| - |
20 |
| -Then import the package: |
21 |
| -```python |
22 |
| -import asposediagramcloud |
| 1 | +[Aspose.Diagram Cloud](https://products.aspose.cloud/Diagram) helps you develop diagrams manipulation applications. Our REST API based Diagram Cloud SDK allows your applications to work with Microsoft Visio Object Model. |
| 2 | + |
| 3 | +This repository contains Aspose.Diagram Cloud SDK source code. This SDK allows you to work with Aspose.Diagram Cloud REST APIs in your applications quickly and easily, with zero initial cost. |
| 4 | + |
| 5 | +To use this SDK, you will need App SID and App Key which can be looked up at [Aspose Cloud Dashboard](https://dashboard.aspose.cloud/#/apps) (free registration in Aspose Cloud is required for this). |
| 6 | + |
| 7 | + |
| 8 | +# Features |
| 9 | + |
| 10 | +### Support Import Formats |
| 11 | +* VSDX |
| 12 | +* VDX |
| 13 | +* VSD |
| 14 | +* VSX |
| 15 | +* VTX |
| 16 | +* VSSX |
| 17 | +* VSTX |
| 18 | +* VSDM |
| 19 | +* VSSM |
| 20 | +* VSTM |
| 21 | +* VDW |
| 22 | +* VSS |
| 23 | +* VST |
| 24 | + |
| 25 | +### Support Export Formats |
| 26 | +* VSDX |
| 27 | +* VDX |
| 28 | +* VSX |
| 29 | +* VTX |
| 30 | +* VSSX |
| 31 | +* VSTX |
| 32 | +* VSDM |
| 33 | +* VSSM |
| 34 | +* VSTM |
| 35 | +* PDF |
| 36 | +* XPS |
| 37 | +* SWF |
| 38 | +* SVG |
| 39 | +* EMF |
| 40 | +* JPEG |
| 41 | +* PNG |
| 42 | +* BMP |
| 43 | +* TIFF |
| 44 | +* HTML |
| 45 | + |
| 46 | +### Supported Operations |
| 47 | +* Convert document format |
| 48 | +* Create new document |
| 49 | +* Upload document and save it with supported format |
| 50 | +* Download document with supported format |
| 51 | + |
| 52 | +For the complete list of use-cases, please refer to [common operations format support map](https://docs.aspose.cloud/display/diagramcloud/Supported+File+Formats#SupportedFileFormats-CommonOperationsFormatSupportMap) to see what you can achieve! |
| 53 | + |
| 54 | + |
| 55 | +# Storage API support |
| 56 | +#### Since version 19.10, SDK includes support of storage operations for better user experience and unification, so now there's no need to use 2 different SDKs! |
| 57 | + |
| 58 | +It gives you an ability to: |
| 59 | +* Upload, download, copy, move and delete files, including versions handling (if you are using Cloud storage that supports this feature - true by default) |
| 60 | +* Create, copy, move and delete folders |
| 61 | +* Copy and move files and folders accross separate storages in scope of a single operation |
| 62 | +* Check if certain file, folder or storage exists |
| 63 | + |
| 64 | +# Usage |
| 65 | +Please, add the following [NuGet package](https://www.nuget.org/packages/Aspose.Diagram-Cloud/) to your project. |
| 66 | + |
| 67 | +# Examples |
| 68 | +Please, look at [Examples](EXAMPLES.md) document for basic usage or use the [Examples](Examples) folder for more sophisticated scenarios. |
| 69 | + |
| 70 | +### Aspose Cloud-hosted service VS on-premise deployment (*experimental feature*) |
| 71 | +Starting from v19.10, you can choose either to use Aspose Cloud-hosted image processing service (the standard way) or the Docker image from Docker Hub deployed on-premise to serve the requests. |
| 72 | +The details about key differences and deployment process will be described on the dedicated Docker Hub page as soon as it's released. |
| 73 | + |
| 74 | +To succeed with your on-premise service usage by the SDK, you need to: |
| 75 | +1. Use the new API class constructor with grantType parameter, clientId and clientSecret parameters. |
23 | 76 | ```
|
24 |
| - |
25 |
| -### Setuptools |
26 |
| - |
27 |
| -Install via [Setuptools](http://pypi.python.org/pypi/setuptools). |
28 |
| - |
29 |
| -```sh |
30 |
| -python setup.py install --user |
31 |
| -``` |
32 |
| -(or `sudo python setup.py install` to install the package for all users) |
33 |
| - |
34 |
| -Then import the package: |
35 |
| -```python |
36 |
| -import asposediagramcloud |
37 |
| -``` |
38 |
| - |
39 |
| -## Getting Started |
40 |
| - |
41 |
| -Please follow the [installation procedure](#installation--usage) and then run the following: |
42 |
| - |
43 |
| -```python |
44 |
| -from __future__ import print_function |
45 |
| -import time |
46 |
| -import asposediagramcloud |
47 |
| -from asposediagramcloud.rest import ApiException |
48 |
| -from pprint import pprint |
49 |
| -# create an instance of the API class |
50 |
| -api_instance = asposediagramcloud.DiagramFileApi() |
51 |
| -name = 'name_example' # str | The document name. |
52 |
| -format = 'format_example' # str | The exported file format. (optional) |
53 |
| -folder = 'folder_example' # str | The document folder. (optional) |
54 |
| -storage = 'storage_example' # str | storage name. (optional) |
55 |
| - |
56 |
| -try: |
57 |
| - # Read document info or export. |
58 |
| - api_response = api_instance.diagram_file_get_diagram(name, format=format, folder=folder, storage=storage) |
59 |
| - pprint(api_response) |
60 |
| -except ApiException as e: |
61 |
| - print("Exception when calling DiagramFileApi->diagram_file_get_diagram: %s\n" % e) |
62 |
| - |
| 77 | +diagramApi=DiagramApi(grantType,clientId,clientSecret) |
63 | 78 | ```
|
| 79 | +2. Set *storage* or *storageName* parameters for each request where they're present (mandatory!). |
64 | 80 |
|
65 |
| -## Documentation for API Endpoints |
66 |
| - |
67 |
| -All URIs are relative to *https://api.aspose.cloud/v1.1/* |
68 |
| - |
69 |
| -Class | Method | HTTP request | Description |
70 |
| ------------- | ------------- | ------------- | ------------- |
71 |
| -*DiagramFileApi* | [**diagram_file_get_diagram**](docs/DiagramFileApi.md#diagram_file_get_diagram) | **GET** /diagram/{name} | Read document info or export. |
72 |
| -*DiagramFileApi* | [**diagram_file_post_save_as**](docs/DiagramFileApi.md#diagram_file_post_save_as) | **POST** /diagram/{name}/SaveAs | Convert document and save result to storage. |
73 |
| -*DiagramFileApi* | [**diagram_file_put_create**](docs/DiagramFileApi.md#diagram_file_put_create) | **PUT** /diagram/{name} | Create new diagram and save result to storage. |
74 |
| -*DiagramFileApi* | [**diagram_file_put_upload**](docs/DiagramFileApi.md#diagram_file_put_upload) | **PUT** /diagram/{name}/upload | Upload file and save result to storage. |
75 |
| -*OAuthApi* | [**o_auth_post**](docs/OAuthApi.md#o_auth_post) | **POST** /oauth2/token | Get Access token |
76 |
| - |
77 |
| - |
78 |
| -## Documentation For Models |
79 |
| - |
80 |
| - - [AccessTokenResponse](docs/AccessTokenResponse.md) |
81 |
| - - [DiagramModel](docs/DiagramModel.md) |
82 |
| - - [FileFormatRequest](docs/FileFormatRequest.md) |
83 |
| - - [Link](docs/Link.md) |
84 |
| - - [PageModel](docs/PageModel.md) |
85 |
| - - [SaaSposeResponse](docs/SaaSposeResponse.md) |
86 |
| - - [SaveResult](docs/SaveResult.md) |
87 |
| - - [SharpModel](docs/SharpModel.md) |
88 |
| - - [DiagramResponse](docs/DiagramResponse.md) |
89 |
| - - [SaveResponse](docs/SaveResponse.md) |
90 |
| - |
91 |
| - |
92 |
| -## Documentation For Authorization |
| 81 | +# Tests |
| 82 | +Tests are intended for internal usage only. |
93 | 83 |
|
| 84 | +# Licensing |
| 85 | +All Aspose.Diagram Cloud SDKs, helper scripts and templates are licensed under [MIT License](LICENSE). |
94 | 86 |
|
95 |
| -## appsid |
96 |
| - |
97 |
| -- **Type**: API key |
98 |
| -- **API key parameter name**: appsid |
99 |
| -- **Location**: URL query string |
100 |
| - |
101 |
| -## oauth |
102 |
| - |
103 |
| -- **Type**: OAuth |
104 |
| -- **Flow**: implicit |
105 |
| -- **Authorization URL**: |
106 |
| -- **Scopes**: |
107 |
| - - **write:pets**: modify pets in your account |
108 |
| - |
109 |
| -## signature |
110 |
| - |
111 |
| -- **Type**: API key |
112 |
| -- **API key parameter name**: signature |
113 |
| -- **Location**: URL query string |
| 87 | +# Contact Us |
| 88 | +Your feedback is very important to us. Please feel free to contact via |
| 89 | ++ [**Free Support Forum**](https://forum.aspose.cloud/c/diagram) |
| 90 | ++ [**Paid Support Helpdesk**](https://helpdesk.aspose.cloud/) |
114 | 91 |
|
115 |
| -## Resources |
| 92 | +# Resources |
116 | 93 | + [**Website**](https://www.aspose.cloud)
|
117 | 94 | + [**Product Home**](https://products.aspose.cloud/diagram)
|
118 | 95 | + [**Documentation**](https://docs.aspose.cloud/display/diagramcloud/Home)
|
119 | 96 | + [**API Reference**](https://apireference.aspose.cloud/diagram/)
|
120 | 97 | + [**Free Support Forum**](https://forum.aspose.cloud/c/diagram)
|
121 | 98 | + [**Paid Support Helpdesk**](https://helpdesk.aspose.cloud/)
|
122 |
| -+ [**Blog**](https://blog.aspose.cloud/category/diagram/) |
| 99 | ++ [**Blog**](https://blog.aspose.cloud/category/diagram/ |
0 commit comments