Initial commit

Author: typpo

.gitignore

@@ -0,0 +1,130 @@
+venv
+
+### Vim ###
+[._]*.s[a-w][a-z]
+[._]s[a-w][a-z]
+*.un~
+Session.vim
+.netrwhist
+*~
+
+
+### OSX ###
+.DS_Store
+.AppleDouble
+.LSOverride
+
+# Icon must end with two \r
+Icon
+
+
+# Thumbnails
+._*
+
+# Files that might appear in the root of a volume
+.DocumentRevisions-V100
+.fseventsd
+.Spotlight-V100
+.TemporaryItems
+.Trashes
+.VolumeIcon.icns
+
+# Directories potentially created on remote AFP share
+.AppleDB
+.AppleDesktop
+Network Trash Folder
+Temporary Items
+.apdisk
+
+
+### Python ###
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[cod]
+*$py.class
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+env/
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+*.egg-info/
+.installed.cfg
+*.egg
+
+# PyInstaller
+#  Usually these files are written by a python script from a template
+#  before PyInstaller builds the exe, so as to inject date/other infos into it.
+*.manifest
+*.spec
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*,cover
+
+# Translations
+*.mo
+*.pot
+
+# Django stuff:
+*.log
+
+# Sphinx documentation
+docs/_build/
+
+# PyBuilder
+target/
+
+
+### Node ###
+# Logs
+logs
+*.log
+npm-debug.log*
+
+# Runtime data
+pids
+*.pid
+*.seed
+
+# Directory for instrumented libs generated by jscoverage/JSCover
+lib-cov
+
+# Coverage directory used by tools like istanbul
+coverage
+
+# Grunt intermediate storage (http://gruntjs.com/creating-plugins#storing-task-files)
+.grunt
+
+# node-waf configuration
+.lock-wscript
+
+# Compiled binary addons (http://nodejs.org/api/addons.html)
+build/Release
+
+# Dependency directory
+# https://docs.npmjs.com/misc/faq#should-i-check-my-node-modules-folder-into-git
+node_modules
+

.travis.yml

@@ -0,0 +1,8 @@
+language: python
+python:
+  - 3.7
+install:
+  - pip install poetry
+script:
+  - poetry install && poetry run python tests.py
+

README.md

@@ -1,2 +1,91 @@
 # quickchart-python
-Python client for quickchart.io image charts web service
+
+A Python client for the [quickchart.io](https://quickchart.io/) image charts web service.
+
+# Installation
+
+Use the `quickchart.py` library in this project, or install through pip:
+
+```
+pip install quickchart
+```
+
+# Usage
+
+This library provides a `QuickChart` class.  Import and instantiate it.  Then set properties on it and specify a [Chart.js](https://chartjs.org) config:
+
+```python
+from quickchart import QuickChart
+
+qc = QuickChart()
+qc.width = 500
+qc.height = 300
+qc.device_pixel_ratio = 2.0
+qc.config = {
+    "type": "bar",
+    "data": {
+        "labels": ["Hello world", "Test"],
+        "datasets": [{
+            "label": "Foo",
+            "data": [1, 2]
+        }]
+    }
+}
+
+Use `get_url()` on your quickchart object to get the encoded URL that renders your chart:
+
+```python
+print(qc.get_url())
+# https://quickchart.io/chart?c=%7B%22chart%22%3A+%7B%22type%22%3A+%22bar%22%2C+%22data%22%3A+%7B%22labels%22%3A+%5B%22Hello+world%22%2C+%22Test%22%5D%2C+%22datasets%22%3A+%5B%7B%22label%22%3A+%22Foo%22%2C+%22data%22%3A+%5B1%2C+2%5D%7D%5D%7D%7D%7D&w=600&h=300&bkg=%23ffffff&devicePixelRatio=2.0&f=png
+```
+
+If you have a long or complicated chart, use `get_short_url()` to get a fixed-length URL using the quickchart.io web service (note that these URLs only persist for a short time unless you have a subscription):
+
+```python
+print(qc.get_short_url())
+# https://quickchart.io/chart/render/f-a1d3e804-dfea-442c-88b0-9801b9808401
+```
+
+The URLs will render an image of a chart:
+
+<img src="https://quickchart.io/chart?c=%7B%22type%22%3A+%22bar%22%2C+%22data%22%3A+%7B%22labels%22%3A+%5B%22Hello+world%22%2C+%22Test%22%5D%2C+%22datasets%22%3A+%5B%7B%22label%22%3A+%22Foo%22%2C+%22data%22%3A+%5B1%2C+2%5D%7D%5D%7D%7D&w=600&h=300&bkg=%23ffffff&devicePixelRatio=2.0&f=png" width="500" />
+
+## Customizing your chart
+
+You can set the following properties:
+
+### config: dict
+The actual Chart.js chart configuration.
+
+### width: int
+Width of the chart image in pixels.  Defaults to 500
+
+### height: int
+Height of the chart image  in pixels.  Defaults to 300
+
+### format: str
+Format of the chart. Defaults to png. svg is also valid.
+
+### background_color: str
+The background color of the chart. Any valid HTML color works. Defaults to #ffffff (white). Also takes rgb, rgba, and hsl values.
+
+### device_pixel_ratio: float
+The device pixel ratio of the chart. This will multiply the number of pixels by the value. This is usually used for retina displays. Defaults to 1.0.
+
+## Getting URLs
+
+There are two ways to get a URL for your chart object.
+
+### getUrl(): string
+
+Returns a URL that will display the chart image when loaded.
+
+### getShortUrl(): Promise
+
+Uses the quickchart.io web service to create a fixed-length chart URL that displays the chart image.  The Promise resolves with a URL such as `https://quickchart.io/chart/render/f-a1d3e804-dfea-442c-88b0-9801b9808401`.
+
+Note that short URLs expire after a few days for users of the free service.  You can [subscribe](https://quickchart.io/pricing/) to keep them around longer.
+
+## More examples
+
+Checkout the `examples` directory to see other usage.

__init__.py

@@ -0,0 +1 @@
+from quickchart import *

examples/long_url_example.py

@@ -0,0 +1,17 @@
+from quickchart import QuickChart
+
+qc = QuickChart()
+qc.config = {
+    "type": "bar",
+    "data": {
+        "labels": ["Hello world", "Test"],
+        "datasets": [{
+            "label": "Foo",
+            # Count from 0 to 100
+            "data": list(range(0, 100)),
+        }]
+    }
+}
+
+print(qc.get_short_url())
+# https://quickchart.io/chart/render/f-b4bf9221-0499-4bc6-b1ae-6f7c78be9d93

examples/simple_example.py

@@ -0,0 +1,19 @@
+from quickchart import QuickChart
+
+qc = QuickChart()
+qc.width = 600
+qc.height = 300
+qc.device_pixel_ratio = 2.0
+qc.config = {
+    "type": "bar",
+    "data": {
+        "labels": ["Hello world", "Test"],
+        "datasets": [{
+            "label": "Foo",
+            "data": [1, 2]
+        }]
+    }
+}
+
+print(qc.get_url())
+# https://quickchart.io/chart?c=%7B%22type%22%3A+%22bar%22%2C+%22data%22%3A+%7B%22labels%22%3A+%5B%22Hello+world%22%2C+%22Test%22%5D%2C+%22datasets%22%3A+%5B%7B%22label%22%3A+%22Foo%22%2C+%22data%22%3A+%5B1%2C+2%5D%7D%5D%7D%7D&w=600&h=300&bkg=%23ffffff&devicePixelRatio=2.0&f=png

poetry.lock

@@ -0,0 +1,16 @@
+[tool.poetry]
+name = "quickchart"
+version = "0.1.0"
+description = "A client for quickchart.io, a service that generates static chart images"
+authors = ["Ian Webster <ianw_pypi@ianww.com>"]
+license = "MIT"
+
+[tool.poetry.dependencies]
+python = ">=2.7, !=3.0.*, !=3.1.*, !=3.2.*, !=3.3.*, !=3.4.*"
+requests = "^2.23.0"
+
+[tool.poetry.dev-dependencies]
+
+[build-system]
+requires = ["poetry>=0.12"]
+build-backend = "poetry.masonry.api"