FeaturesClient list_items does not support filtering

Open
#1,221 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
3/5
Estimated time
1-2 days
Newbie friendliness
65/100
Issue type
Feature
Clarity
Mostly clear
Activity status
Quiet
Tech stack
python
Domain
api

Research direction

Start at the FeaturesAPI.list_items method and compare its parameters with the Feature API List Features endpoint linked in the issue. Add support for bbox, datetime, id fuzzy matching, hashid, and sort, then verify that each filter is passed through correctly and covered by the relevant SDK tests.

Written by the indexing model from the issue text.

Description

proposal

Is your feature request related to a problem? Please describe.
The FeaturesAPI.list_items method exposes the capabilities of the Feature API List Features endpoint.
This endpoint supports a number of filter options, including:

  • bbox
  • datetime (single or interval)
  • id, supporting fuzzy matching
  • hashid
  • sort order

The list_items method supports none of these.

Describe the solution you'd like
Each of the supported filter criteria should also be supported by the SDK

Describe alternatives you've considered
Handling API queries without using the SDK for use cases like this

Additional context

Dominant language
Python
Stars
299
Forks
100
Avg merge
7d 8h
Merged PRs (30d)
2

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from planetlabs/planet-client-python

All issues in planetlabs/planet-client-python

Similar issues

More Python issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.