Git Product home page Git Product logo

api-python's Introduction

Usabilla API - Python Client

Build Status PyPI version Coverage Status

The Usabilla Python client allows users to access data from their Usabilla accounts. It makes use of the API to request the following products and resources:

Usabilla for Websites

  • Buttons
  • Feedback items
  • Campaigns
  • Campaign results
  • Campaign statistics
  • In-Page widgets
  • In-Page feedback

Usabilla for Email

  • Buttons
  • Feedback items

Usabilla for Apps

  • Apps
  • Feedback items
  • Campaigns
  • Campaign results

For more information on resources, authorization and available API calls, please visit our documentation.

Installation:

Requires Python 3. Support for Python 2.7 is expected but not tested or validated.

pip install usabilla-api

Examples

The example folder contains an example of the client, which gives an idea how the client can be used and what is possible.

Iterators

When working with the limit parameters (default value is 100) you can request resources using the item_iterator() function. The API returns data in pages. This function returns a Generator which traverses these pages for you and yields each result in the current page before retrieving the next page.

Support

The Usabilla Python Client API is maintained by Usabilla Development Team. Everyone is encouraged to file bug reports, feature requests, and pull requests through GitHub. This input is critical and will be carefully considered, but we can’t promise a specific resolution or time frame for any request. For more information please email our Support Team at [email protected].

Releasing [internal]

In order to release a new version of this library, follow these steps:

  • bump version in setup.py
  • merge and tag the new release with v<versio>
  • run python -m build
  • upload release to pypi-test: python -m twine upload --repository testpypi dist/*
  • upload release to pypi: python -m twine upload --repository pypi dist/*

api-python's People

Contributors

rdohms avatar spirosikmd avatar shuisman avatar ryaanwells avatar dan11218 avatar josja avatar torkvell avatar bmwilly avatar gvisniuc avatar ricardofontanelli avatar stevenjm avatar gwkunze avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.