Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

README.md not up-to-date #13

Open
ctmbl opened this issue Jun 12, 2023 · 1 comment
Open

README.md not up-to-date #13

ctmbl opened this issue Jun 12, 2023 · 1 comment

Comments

@ctmbl
Copy link

ctmbl commented Jun 12, 2023

The README.md is missleading the user, we can read:
in Usage section

api = HaApiV5(
        api_base='api.helloasso.com',
        client_id=XXXXXX,
        client_secret=XXXXXX,
        timeout=60
    )

And
in Usage Exemple section

api = ApiV5(
        api_base='api.helloasso.com',
        client_id=XXXXXX,
        client_secret=XXXXXX,
        timeout=60
    )

api.call("url", method="POST", data={...})

Two different names are given ApiV5 and HaApiV5 for the main class, I found out that HaApiV5 was the right one

In Authorization section
We can read

from apiv5 import ApiV5

Where, from my experience, it should be,

from helloasso_api import HaApiV5
@ctmbl
Copy link
Author

ctmbl commented Jun 12, 2023

I could propose a PR to update the documentation if you wish!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant