manuelcortez/python-funkwhale
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Updated readme [Skip CI]

Browse Source
This commit is contained in:
Manuel Cortez 2019-05-20 09:01:25 -05:00
parent 397f785232
commit f266e247dc
1 changed files with 9 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

16
README.md
View File

@ -18,17 +18,19 @@ So far, the API wrapper is still considered unstable, a proper setup file is in
# Use the demo server and credentials. # Use the demo server and credentials.
>>> session = api.Session() >>> session = api.Session()
# Or provide your own data. # Or provide your own data.
>>> session = api.Session(instance_url="https://demo.funkwhale.audio", username="demo", password="demo") >>> session = api.Session(instance_endpoint="https://demo.funkwhale.audio", username="demo", password="demo")
# Alternatively, if you already have a JWT token you can pass it to the session class # Alternatively, if you already have a JWT token you can pass it to the session class
>>> session = api.Session(instance_url="https://demo.funkwhale.audio", token="xxxxxxxxx") >>> session = api.Session(instance_endpoint="https://demo.funkwhale.audio", token="xxxxxxxxx")
# Do a login. # Do login.
>>> session.login() >>> session.login()
# If username and password were provided, the login method generated already the JWT token. you can save this somewhere for passing it later. # If username and password were provided, the login method generated already the JWT token.
# You can save this somewhere for passing it later.
>>> print(session.token) >>> print(session.token)
xxxxxxxxx xxxxxxxxx
# Create the API object, that will be responsible for calling the funkwhale's server. # Create the API object, that will be responsible for calling the funkwhale's server.
>>> api = session.get_api() >>> api = session.get_api()
# all API calls follow the format "path.to.api.method(key=value, other_key=other_value)" (where method can be get and post). # all API calls follow the format "path.to.api.method(key=value, other_key=other_value)"
# where method can be get and post.
# Retrieve only 5 artists in the current instance. # Retrieve only 5 artists in the current instance.
>>> artists = api.artists.get(page_size=5) >>> artists = api.artists.get(page_size=5)
# the data is always a dictionary and we can do something with it already. # the data is always a dictionary and we can do something with it already.
@ -41,8 +43,8 @@ Cortéz
Solar Phasing Solar Phasing
Professor Kliq Professor Kliq
# Some methods have been modified a little from the original API paths due to pytohn's syntax. # Some methods have been modified a little from the original API paths due to pytohn's syntax.
# For example, for retrieving all the libraries where an artist is added you should use /api/v1/artists/{id}/libraries # For example, for calling /api/v1/artists/{id}/libraries
# but in python-funkwhale it will be translated as the following call, just removing the {id} part from the path and passing it as an argument to the function. # in python-funkwhale it will be translated as the following call, just removing the {id} part from the path and passing it as an argument to the function.
>>> libraries = api.artists.libraries.get(1) >>> libraries = api.artists.libraries.get(1)
>>> for i in libraries["results"]: >>> for i in libraries["results"]:
... print(i["name"]) ... print(i["name"])