Skip to content

Commit 4199ef7

Browse files
authored
Standardized readme.md
1 parent 19b545a commit 4199ef7

File tree

1 file changed

+42
-57
lines changed

1 file changed

+42
-57
lines changed

README.md

Lines changed: 42 additions & 57 deletions
Original file line numberDiff line numberDiff line change
@@ -1,59 +1,62 @@
1-
# Aspose.Tasks Cloud SDK for Python
2-
This repository contains Aspose.Tasks Cloud SDK for Python source code. This SDK allows you to work with Aspose.Tasks Cloud REST APIs in your Python applications quickly and easily, with zero initial cost.
1+
![](https://img.shields.io/badge/api-v3.0-lightgrey) ![PyPI](https://img.shields.io/pypi/v/aspose-tasks-cloud) ![PyPI - Format](https://img.shields.io/pypi/format/aspose-tasks-cloud) ![PyPI - Downloads](https://img.shields.io/pypi/dm/aspose-tasks-cloud) ![PyPI - Python Version](https://img.shields.io/pypi/pyversions/aspose-tasks-cloud) [![GitHub license](https://img.shields.io/github/license/aspose-tasks-cloud/aspose-tasks-cloud-php)](https://github.com/aspose-tasks-cloud/aspose-tasks-cloud-php/blob/master/LICENSE) ![GitHub last commit](https://img.shields.io/github/last-commit/Aspose-tasks-Cloud/aspose-tasks-cloud-php)
32

4-
[Aspose.Tasks Cloud](https://products.aspose.cloud/tasks/family "Aspose.Tasks Cloud")
5-
[API Reference](https://apireference.aspose.cloud/tasks/)
3+
# Python SDK to Manage Tasks in the Cloud
64

7-
## Key Features
8-
* Conversion between various file formats, including MPP->PDF conversion
9-
* Read, change and write Microsoft Project® documents
10-
* Create, update and write projects in XML project format
11-
* Manage extended attributes
12-
* Define weekdays for calendars and calendar exceptions
13-
* Manage task baseline scheduling and duration
14-
* Create and manage links between tasks
15-
* Manage resources costs and variances
16-
* Access assignment costs and budget
5+
Aspose.Tasks for Cloud offers the ability to manipulate and convert Microsoft Project MPT, MPP, MPX & Oracle Primavera XER, XML, and PrimaveraP6XML files in the Cloud. [Aspose.Tasks Cloud SDK for Python](https://products.aspose.cloud/tasks/python) wraps the REST API to make it easier for Python developers to integrate Task Management features in their own applications.
176

18-
## How to use the SDK?
19-
The complete source code is available in this repository folder. You can either directly use it in your project via source code or get [PyPi](https://pypi.org/project/aspose-tasks-cloud ) (recommended). For more details, please visit our [documentation website](https://docs.aspose.cloud/tasks/available-sdks/).
7+
## REST API for Task Management
208

21-
### Prerequisites
9+
* [Convert Microsoft Project & Oracle Primavera files](https://docs.aspose.cloud/tasks/convert-project-document-to-the-specified-format/) to other formats including MPP to PDF conversion.
10+
* Read, change and write Microsoft Project documents.
11+
* Create, update and write projects in XML project format.
12+
* Manage extended attributes.
13+
* [Define weekdays for calendars](https://docs.aspose.cloud/tasks/working-with-calendars/) and calendar exceptions.
14+
* [Manage tasks](https://docs.aspose.cloud/tasks/working-with-tasks/), baseline scheduling and duration.
15+
* Create and [manage task links](https://docs.aspose.cloud/tasks/working-with-task-links/).
16+
* Manage resources costs and variances.
17+
* Access assignment costs and budget.
2218

23-
To use Aspose Tasks for Cloud Python SDK you need to register an account with [Aspose Cloud](https://www.aspose.cloud/) and lookup/create App Key and SID at [Cloud Dashboard](https://dashboard.aspose.cloud/#/apps). There is free quota available. For more details, see [Aspose Cloud Pricing](https://purchase.aspose.cloud/pricing).
19+
## Read & Write Project Data
2420

25-
## Installation & Usage
26-
### pip install
21+
**Microsoft Project** MPP, XML, MPT **Primavera** MPX
2722

28-
If the python package is hosted on Github, you can install directly from Github
23+
## Save Project Data As
24+
25+
XER, XLSX, HTML, XML, TXT, TIF, SVG, PNG, JPEG
26+
27+
## Get Started with Aspose.Tasks Cloud SDK for Python
28+
29+
Register an account at [Aspose Cloud Dashboard](https://dashboard.aspose.cloud/#/apps) to get you application information. Next, either directly use the source from this repository in your project or get the package from [PyPi](https://pypi.org/project/aspose-tasks-cloud).
30+
31+
### Install via PIP
2932

3033
```sh
3134
pip install aspose-tasks-cloud
3235
```
33-
(you may need to run `pip` with root permission: `sudo pip install aspose-tasks-cloud`)
3436

35-
Then import the package:
37+
You may need to run `pip` command with root permission as `sudo pip install aspose-tasks-cloud`.
38+
39+
Then import the package as follows.
40+
3641
```python
3742
import asposetaskscloud
3843
```
3944

40-
### Setuptools
41-
42-
Install via [Setuptools](http://pypi.python.org/pypi/setuptools).
45+
### Install via Setuptools
4346

4447
```sh
4548
python setup.py install --user
4649
```
47-
(or `sudo python setup.py install` to install the package for all users)
4850

49-
Then import the package:
51+
Alternatively, execute `sudo python setup.py install` to install the package for all users.
52+
53+
Then import the package as follows.
54+
5055
```python
5156
import asposetaskscloud
5257
```
5358

54-
## Getting Started
55-
56-
Please follow the [installation procedure](#installation--usage) and then run the following:
59+
## Extract MPP Document Properties via Python
5760

5861
```python
5962
import asposetaskscloud
@@ -72,31 +75,13 @@ self.assertTrue(upload_result.code == 200, 'Error has occurred while uploading p
7275
request = asposetaskscloud.models.requests.GetDocumentPropertiesRequest(remote_name)
7376
result = tasks_api.get_document_properties(request)
7477
self.assertTrue(result.code == 200, 'Error has occurred while getting document properties')
75-
7678
```
7779

78-
[Test](test/) contain various examples of using the SDK.
79-
80-
## Dependencies
81-
- Python 2.7(End of Life in 2020) and 3.7
82-
- referenced packages (see [here](setup.py) for more details)
83-
84-
## Licensing
85-
86-
All Aspose.Tasks Cloud SDKs, helper scripts and templates are licensed under [MIT License](https://github.com/aspose-tasks-cloud/aspose-tasks-cloud-python/blob/master/LICENSE).
87-
88-
## Contact Us
89-
Your feedback is very important to us. Please feel free to contact us using our [Support Forums](https://forum.aspose.cloud/c/tasks).
90-
91-
## Resources
92-
93-
[Website](https://www.aspose.cloud/)
94-
[Product Home](https://products.aspose.cloud/tasks/family)
95-
[API Reference](https://apireference.aspose.cloud/tasks/)
96-
[Documentation](https://docs.aspose.cloud/tasks/)
97-
[Blog](https://blog.aspose.cloud/category/tasks/)
98-
99-
## Other languages
100-
We generate our SDKs in different languages so you may check if yours is available in our [list](https://github.com/aspose-tasks-cloud).
101-
102-
If you don't find your language in the list, feel free to request it from us, or use raw REST API requests as you can find it [here](https://products.aspose.cloud/tasks/curl).
80+
## Aspose.Tasks Cloud SDKs in Popular Languages
81+
82+
| .NET | PHP | Python | Node.js |
83+
|---|---|---|---|
84+
| [GitHub](https://github.com/aspose-tasks-cloud/aspose-tasks-cloud-dotnet) | [GitHub](https://github.com/aspose-tasks-cloud/aspose-tasks-cloud-php) | [GitHub](https://github.com/aspose-tasks-cloud/aspose-tasks-cloud-python) | [GitHub](https://github.com/aspose-tasks-cloud/aspose-tasks-cloud-node) |
85+
| [NuGet](https://www.nuget.org/packages/Aspose.Tasks-Cloud/) | [Composer](https://packagist.org/packages/aspose/tasks-sdk-php) | [PIP](https://pypi.org/project/aspose-tasks-cloud/) | [NPM](https://www.npmjs.com/package/@asposecloud/aspose-tasks-cloud) |
86+
87+
[Home](https://www.aspose.cloud) | [Product Page](https://products.aspose.cloud/tasks/python) | [Documentation](https://docs.aspose.cloud/tasks/) | [Live Demo](https://products.aspose.app/tasks/family) | [API Reference](https://apireference.aspose.cloud/tasks/) | [Code Samples](https://github.com/aspose-tasks-cloud/aspose-tasks-cloud-python/tree/master/test) | [Blog](https://blog.aspose.cloud/category/tasks/) | [Free Support](https://forum.aspose.cloud/c/tasks) | [Free Trial](https://dashboard.aspose.cloud/#/apps)

0 commit comments

Comments
 (0)