4.4.2

Fixed an issue with share_edit's stream parameter

5.1.1

Minor update for a misspelled parameter value in localplay and some missing new parameters in API5

• playlists: add parameter show_dupes if true ignore 'api_hide_dupe_searches' setting
• get_art: add parameter fallback if true return default art ('blankalbum.png') instead of an error

Check out the official docs on ampache.org for more information. https://ampache.org/api/

4.4.1

Minor update to fix up some missing parameters.

Visit the official docs for more info about parameters and functions available.

https://ampache.org/api/api-4

4.4.0

Bugfixes that weren't caught before api5 was released.

• get_indexes
• localplay
• playlist_edit
• ping
• democratic

5.1.0

Ready for Ampache 5

A python3 library for interaction with your Ampache 5.x.x server using the XML & JSON API

• Additional methods in this release match up with the Ampache 5.1.0
• The structural changes to the lib do not support Ampache 4 and do not support old versions of the lib.
• Version 4 will be maintained along with Ampache 4 until the end of PHP 7.4 support.

Changes in this release

• Fixed scrobble parameters
• Added live_streams method
• Added live_stream method

5.0.1

Quick fire bug fixes

Bug fixes from initial release found when updating.

• If you ping a session and it's successful, set the session without requiring a handshake
• All docs and examples are updated and fully functional
• set_key would overwrite your session instead of setting AMPACHE_KEY
• artists was missing the album_artist parameter
• docs/MANUAL.md added to the repo with a breakdown of the class structure

Ready for Ampache 5

A python3 library for interaction with your Ampache 5.x.x server using the XML & JSON API

• Additional methods in this release match up with the current develop branch (soon to be Ampache 5.0.0)
• Password auth is available instead of just API Keys
• The structural changes to the lib do not support Ampache 4 and do not support old versions of the lib.
• Version 4 will be maintained along with Ampache 4 until the end of PHP 7.4 support.

Changes in this release

There has been a pretty significant change in the library between Ampache 4 and Ampache 5.

For anyone wanting to stay on v4 the branch has been separated into it's own branch.

Once you connect with your passphrase or api key the url and auth token are stored for most methods allowing you to call methods without them.

Below is a quick example of the changes.

    import ampache
    import time

    # load up the lib
    ampacheConnection = ampache.API()

    # if using password auth use encrypt_password
    mytime = int(time.time())
    passphrase = ampacheConnection.encrypt_password('mypassword', mytime)
    auth = ampacheConnection.handshake('https://music.com.au', passphrase, 'my username', mytime)

    # if using an API key auth keep using encrypt_string
    passphrase = ampacheConnection.encrypt_string('my apikey', 'my username')
    auth = ampacheConnection.handshake('https://music.com.au', passphrase)

    # now you can call methods without having to keep putting in the url and userkey
    ampacheConnection.label(1677)
    
    # ping has always allowed empty calls so you have to ping with a url and session still
    ampacheConnection.ping('https://music.com.au', auth)

5.0.0

Ready for Ampache 5

A python3 library for interaction with your Ampache 5.x.x server using the XML & JSON API

• Additional methods in this release match up with the current develop branch (soon to be Ampache 5.0.0)
• Password auth is available instead of just API Keys
• The structural changes to the lib do not support Ampache 4 and do not support old versions of the lib.
• Version 4 will be maintained along with Ampache 4 until the end of PHP 7.4 support.

Changes in this release

There has been a pretty significant change in the library between Ampache 4 and Ampache 5.

For anyone wanting to stay on v4 the branch has been separated into it's own branch.

Once you connect with your passphrase or api key the url and auth token are stored for most methods allowing you to call methods without them.

Below is a quick example of the changes.

    import ampache
    import time

    # load up the lib
    ampacheConnection = ampache.API()

    # if using password auth use encrypt_password
    mytime = int(time.time())
    passphrase = ampacheConnection.encrypt_password('mypassword', mytime)
    auth = ampacheConnection.handshake('https://music.com.au', passphrase, 'my username', mytime)

    # if using an API key auth keep using encrypt_string
    passphrase = ampacheConnection.encrypt_string('my apikey', 'my username')
    auth = ampacheConnection.handshake('https://music.com.au', passphrase)

    # now you can call methods without having to keep putting in the url and userkey
    ampacheConnection.label(1677)
    
    # ping has always allowed empty calls so you have to ping with a url and session still
    ampacheConnection.ping('https://music.com.au', auth)

4.2.2

update with fixes from the 4.2.2 release

4.2.0

After a lot of testing JSON and XML are working well.
The library can/should be able to do anything API related that Ampache provides.

• Follow Ampache release numbering.
• Windows support for writing debug information
• Example documentation is exactly what the API returns so is great for use as a reference.

1.0.4

JSON support and many changes to processes. new calls and methods as well.

Have a look at build_docs.py and run_tests.py to get an idea of whats changed and how to use these examples in live code.