Skip to main content

A light-weight python wrapper for the Datawrapper API

Project description

datawrapper

PyPI Version Monthly downloads Build status Python Version Dependencies Status

Code style: black Pre-commit Semantic Versions License

A light-weight python wrapper for the Datawrapper API (v3). While it is not developed by Datawrapper officially, you can use it with your API credentials from datawrapper.de

🚀 Features

  • Retrieve your account information (including folders).
  • Add data to charts, tables or maps.
  • Create charts, tables or maps - and add data from a pandas.DataFrame in one call!
  • Update chart descriptions.
  • Publish charts, tables or maps.
  • Retrieve chart properties, update its metadata, and other information.
  • Display a chart (as output of notebook cell - it gets weird because interactivity ¯\(ツ)/¯ )
  • Retrieve a chart, table or map's iframe code to embed.
  • Export chart as png (still working on the svg and pdf parts).
  • Move charts across folders and organizations.
  • Delete charts.
  • Get a list of all your charts.

Installation

pip install -U datawrapper

or pipenv

pipenv install datawrapper

or install with Poetry

poetry add datawrapper

Contributing

Clone the repository. Move into the directory on your terminal.

Install dependencies for development.

pipenv install --dev

Install pre-commit to run a battery of automatic quick fixes against your work.

pipenv run pre-commit install

📈 Releases

You can see the list of available releases on the GitHub Releases page.

We follow Semantic Versions specification. When you're ready to make a new release, visit the releases page and create a new entry. Set the tags and press publish. That will trigger a GitHub Action that automatically deploys the code to the Python Package Index.

🛡 License

License

This project is licensed under the terms of the MIT license. See LICENSE for more details.

📃 Citation

@misc{datawrapper,
  author = {chekos},
  title = {A light-weight python wrapper for the Datawrapper API (v3). While it is not developed by Datawrapper officially, you can use it with your API credentials from datawrapper.de},
  year = {2021},
  publisher = {GitHub},
  journal = {GitHub repository},
  howpublished = {\url{https://github.com/chekos/datawrapper}}
}

Credits

This project was generated with python-package-template.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

datawrapper-0.5.5.tar.gz (159.9 kB view hashes)

Uploaded Source

Built Distribution

datawrapper-0.5.5-py3-none-any.whl (10.0 kB view hashes)

Uploaded Python 3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page