package version 1.0.0

Author: drdmitry

.gitignore

@@ -0,0 +1,5 @@
+__pycache__/
+*.py[cod]
+build/
+dist/
+*.egg-info/

README.md

@@ -0,0 +1,77 @@
+# [Conversion Tools](https://conversiontools.io) API Python Client
+
+[Conversion Tools](https://conversiontools.io) is an online service that offers a fast and easy way to convert documents between different formats, like XML, Excel, PDF, Word, Text, CSV and others.
+
+This Client allows to integrate the conversion of the files into Python applications.
+
+To convert the files Python Client uses the public [Conversion Tools REST API](https://conversiontools.io/api-documentation).
+
+## Installation
+
+```bash
+pip install --upgrade conversiontools
+```
+
+or when building from the sources:
+
+```bash
+python setup.py install
+```
+
+## Examples
+
+To use REST API - get API Token from the Profile page at https://conversiontools.io/profile.
+
+See example `test.py` in the `./examples/` folder.
+
+```python
+from conversiontools import ConversionClient
+
+# put token here from your Profile page at https://conversiontools.io/profile
+token = ''
+
+# files
+fileInput = 'test.xml'
+fileOutput = 'test.csv'
+
+client = ConversionClient(token)
+try:
+    client.convert('convert.xml_to_csv', fileInput, fileOutput, { 'delimiter': 'tabulation' })
+except Exception as error:
+    print(error)
+```
+
+## API
+
+### Create `ConversionClient` instance with a token.
+```python
+from conversiontools import ConversionClient
+client = ConversionClient('<token>')
+```
+
+Where `<token>` is API token from the account's Profile page https://conversiontools.io/profile.
+
+### Convert input file and download the result
+```python
+try:
+    client.convert('<conversion type>', fileInput, fileOutput, '<options>')
+except Exception as error:
+    print(error)
+```
+
+Where
+- `<conversion type>` is a specific type of conversion, from [API Documentation](https://conversiontools.io/api-documentation).
+- `<options>` is a Python dict with options for a corresponding converter, for example:
+```python
+options = { 'delimiter': 'tabulation' }
+```
+
+## Documentation
+
+List of available Conversion Types and corresponding conversion options can be found on the [Conversion Tools API Documentation](https://conversiontools.io/api-documentation) page.
+
+## License
+
+Licensed under [MIT](./LICENSE).
+
+Copyright (c) 2020 [Conversion Tools](https://conversiontools.io)

conversiontools/__init__.py

@@ -0,0 +1,2 @@
+__version__ = "1.0.0"
+from .client import *

conversiontools/api.py

@@ -0,0 +1,40 @@
+from .request import requestAPI, uploadAPI, downloadAPI
+
+base_url = 'https://api.conversiontools.io/v1'
+
+def uploadFile(token, name):
+    fd = open(name, 'rb')
+    file = { 'file': fd }
+    result = uploadAPI(base_url + '/files', token, file)
+    if result['error'] != None:
+        raise Exception(result['error'])
+    return result['file_id']
+
+def createTask(token, type, file_id, options=None):
+    data = {
+        'type': type,
+        'options': {
+            'file_id': file_id
+        }
+    }
+    data['options'].update(options)
+
+    result = requestAPI('POST', base_url + '/tasks', token, data)
+    if result['error'] != None:
+        raise Exception(result['error'])
+    return result['task_id']
+
+def getTaskStatus(token, task_id):
+    result = requestAPI('GET', base_url + '/tasks/' + task_id, token)
+    errorMessage = result['error']
+    status = result['status']
+    file_id = result['file_id']
+    if errorMessage != None:
+        raise Exception(errorMessage)
+    return { "status": status, "file_id": file_id }
+
+def downloadFile(token, file_id, filename):
+    result = downloadAPI(base_url + '/files/' + file_id, token)
+    fd = open(filename, 'wb')
+    fd.write(result)
+    fd.close()

conversiontools/client.py

@@ -0,0 +1,22 @@
+import time
+from .api import *
+
+class ConversionClient:
+
+    def __init__(self, token):
+      self.token = token
+
+    def convert(self, type, input, output, options=None):
+        token = self.token
+        file_id = uploadFile(token, input)
+        task_id = createTask(token, type, file_id, options)
+        while True:
+            taskStatus = getTaskStatus(token, task_id)
+            status = taskStatus['status']
+            file_id = taskStatus['file_id']
+            if status == 'SUCCESS':
+                downloadFile(token, file_id, output)
+                break
+            if status == 'ERROR':
+                break
+            time.sleep(5)

conversiontools/request.py

@@ -0,0 +1,28 @@
+import conversiontools
+import requests
+
+user_agent = 'conversiontools-python/' + conversiontools.__version__
+
+def prepareHeaders(token):
+    headers = {
+        'Authorization': 'Bearer ' + token,
+        'User-Agent': user_agent
+    }
+    return headers
+
+def requestAPI(method, url, token, data=None):
+    headers = prepareHeaders(token)
+    response = requests.request(method, url, headers=headers, json=data)
+    data = response.json()
+    return data
+
+def uploadAPI(url, token, files):
+    headers = prepareHeaders(token)
+    response = requests.request('POST', url, headers=headers, files=files)
+    data = response.json()
+    return data
+
+def downloadAPI(url, token):
+    headers = prepareHeaders(token)
+    response = requests.request('GET', url, headers=headers)
+    return response.content

examples/test.py

@@ -0,0 +1,14 @@
+from conversiontools import ConversionClient
+
+# put token here from your Profile page at https://conversiontools.io/profile
+token = ''
+
+# files
+fileInput = 'test.xml'
+fileOutput = 'test.csv'
+
+client = ConversionClient(token)
+try:
+    client.convert('convert.xml_to_csv', fileInput, fileOutput, { 'delimiter': 'tabulation' })
+except Exception as error:
+    print(error)

examples/test.xml

@@ -0,0 +1,33 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<breakfast_menu>
+  <food>
+    <name>Belgian Waffles</name>
+    <price>$5.95</price>
+    <description>Two of our famous Belgian Waffles with plenty of real maple syrup</description>
+    <calories>650</calories>
+  </food>
+  <food>
+    <name>Strawberry Belgian Waffles</name>
+    <price>$7.95</price>
+    <description>Light Belgian waffles covered with strawberries and whipped cream</description>
+    <calories>900</calories>
+  </food>
+  <food>
+    <name>Berry-Berry Belgian Waffles</name>
+    <price>$8.95</price>
+    <description>Light Belgian waffles covered with an assortment of fresh berries and whipped cream</description>
+    <calories>900</calories>
+  </food>
+  <food>
+    <name>French Toast</name>
+    <price>$4.50</price>
+    <description>Thick slices made from our homemade sourdough bread</description>
+    <calories>600</calories>
+  </food>
+  <food>
+    <name>Homestyle Breakfast</name>
+    <price>$6.95</price>
+    <description>Two eggs, bacon or sausage, toast, and our ever-popular hash browns</description>
+    <calories>950</calories>
+  </food>
+</breakfast_menu>

requirements.txt

@@ -0,0 +1 @@
+requests>=2.4.2

setup.cfg

@@ -0,0 +1,7 @@
+[bdist_wheel]
+universal = 1
+
+[easy_install]
+
+[metadata]
+description-file = README.md