Skip to main content

Python wrapper for Helloasso APIV5

Project description

HelloAsso API Wrapper

versions license Pydantic v2

A Python wrapper for the HelloAsso API, using Pydantic for models validation.

Usage

from HelloAssoAPIWrapper import HelloAssoAPIWrapper

Notification result webhooks

You should configure a webhook to receive the notification results. HelloAsso will make a POST request to the URL you provided with a JSON payload corresponding to a NotificationResultContent object.

HelloAsso sandbox

HelloAsso provide a sandbox: api.helloasso-sandbox.com

Development

Models when first generated using HelloAsso swagger documentation, and then adapted to include additional models, use stricter types and add documentation

Add new methods

todo

Models auto-generation

Download the swagger file from the HelloAsso API documentation. It use an old swagger 2 version. You need to convert it to OpenAPI 3.0.0 version. You can use the online tool Swagger Editor.

Then you can use the datamodel-codegen tool to generate the models:

datamodel-codegen --input HelloAssoV5OpenAPI.json --output HelloAssoAPIWrapper

Make a release on Pypi

You need to edit HelloAssoAPIWrapper version in helloasso_api_wrapper/__about__.py. Then make a release on GitHub and add a tag. The tag should match v*.*.*.

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

helloassoapiwrapper-0.0.1.tar.gz (11.2 kB view hashes)

Uploaded Source

Built Distribution

helloassoapiwrapper-0.0.1-py3-none-any.whl (23.3 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