canonical / canonicalwebteam.store-api

Canonical Store Api - Python package

How to install

To install this extension as a requirement in your project, you can use PIP:

pip install canonicalwebteam.store-api

See also the documentation for pip install.

Development

The package leverages poetry for dependency management.

Testing

All tests can be run with poetry run python3 -m unittest discover tests.

Note: You might have to do poetry install before runnning the command above.

canonicalwebteam.store-api's Issues

Rename "publisher" argument to "publisher_identifier" in "get_publisher_items"

See: https://github.com/canonical-web-and-design/canonicalwebteam.store-api/pull/6/files#r359937648

Integrate latest version of the category endpoint

See spec

Size and page parameters not working as expected

The get_publisher_items method allows to specify the number of items that we want with the size parameter.

https://github.com/canonical-web-and-design/canonicalwebteam.store-api/blob/d320d727519555003c2a54b46d1fd15c30018b52/canonicalwebteam/store_api/store.py#L112-L118

It turns out the Snapcraft API will ignore the size parameter when getting snaps from a specific publisher.

This is an example URL, as we can see we have specified size=2 but we will get all the snaps from this publisher:
https://api.snapcraft.io/api/v1/snaps/search?q=publisher:28zEonXNoBLvIB7xneRbltOsp0Nf7DwS&size=2&page=1&scope=wide&arch=wide&confinement=strict,classic&fields=package_name

Rename SnapcraftStoreAPI to SnapStore

https://github.com/canonical-web-and-design/canonicalwebteam.store-api/blob/cecb225836ab5dd535aac3d6d027ddee4265dd38/canonicalwebteam/store_api/stores/snapcraft.py#L6

As mention here it will make more sense to be called SnapStore.

Action Required: Fix Renovate Configuration

There is an error with this repository's Renovate configuration that needs to be fixed. As a precaution, Renovate will stop PRs until it is resolved.

Error type: undefined

Add support for environment variables

We need to use the staging API sometimes so we need to allow environment variables in order to change the API URLs

Add support for collaboration endpoints

Change publisher parameter in get_publisher_items

What's this hash-like string? Is that an identifier for the publisher? Or an actual publisher's name?

If it's a hash of some sort, I think the argument name should be changed to make this clearer. But again, that should be out of scope for this PR, as it makes sense to just focus on testing in this PR.

Originally posted by @nottrobin in #6

Fix live tests

We shouldn't be searching for snaps called "toto" to test the search method because the number of results are going to be continually changing.

Originally posted by @jkfran in #25

Hide API nastiness inside get_all_items

see: https://github.com/canonical-web-and-design/canonicalwebteam.store-api/pull/6/files#r359937648

Update API URL

The API needs to consume api.charmhub.io instead of api.snapcraft.io as it will stop working for charms.