Outdated Readme.md

[aviel08]

Describe the problem

Documentation on Readme.md is outdated.

Reproduction

from auth0.authentication import Database

database = Database('my-domain.us.auth0.com', 'my-client-id')

database.signup(email='[email protected]', password='secr3t', connection='Username-Password-Authentication')

The above code produces:
ModuleNotFoundError: No module named 'auth0.authentication'

I think it should be:

from auth0.v3.authentication import Database

database = Database('my-domain.us.auth0.com')

database.signup(email='[email protected]', password='secr3t', connection='Username-Password-Authentication', client_id ='client_id')

Same for the rest of the examples. Login requires token.login to pass scope and audience.

I'm using Python 3.9 and the latest pip install auth0-python

[marcusmotill]

v3 folder was removed in the 4.0.0 release docs seem correct for those using v4

[aviel08]

That is correct, I must have installed V3 before and pip install auth0-python will not upgrade to the latest version unless specified, my bad, but If I run the example for login:

from auth0.authentication import GetToken

token = GetToken('my-domain.us.auth0.com', 'my-client-id', client_secret='my-client-secret')

token.login(username='[email protected]', password='secr3t', realm='Username-Password-Authentication')

I get:
TypeError: login() missing 2 required positional arguments: 'scope' and 'audience' Which is not a problem, I can pass those 2 arguments, I'm just wondering what's wrong.
I have auth0_python-4.1.0-py2.py3-none-any.whl

[adamjmcgrath]

Hi @aviel08 - thanks for raising this

The signature of GetToken#login hasn't changed between v3 and v4 and that doc hasn't changed. So I think this is an old issue with the GetToken API. Strictly speaking audience, scope and realm should be optional https://auth0.com/docs/api/authentication#resource-owner-password

Will raise a PR to change those positional arguments to keyword arguments, which should fix that example.

[githubisagit]

Have run into same exact problem.