Hacktoberfest 2026:メンテナが10月に向けて印を付けた、オープンで初心者向けの issue。 Hacktoberfest の issue を見る

Large order support in SDK & CLI

オープン
#746 コメント 1 件 リアクション 0 件 担当者 0 名 GitHub で見る

まだ誰も着手していません。

評価

難易度
5/5
見積もり時間
1週間以上
初心者へのやさしさ
25/100
issue の種類
機能追加
明瞭さ
説明が足りない
活発さ
停滞
技術スタック
python
領域
api, cli

調査の方向性

Start by tracing the SDK and CLI order-submission entry points and the orders API limit described here. Resolve the bulk-order behavior for both interfaces, including opt-in handling, 100-item chunking, order naming, and returned order IDs. Done means large requests can be split into usable orders through the SDK and CLI.

索引モデルが issue の本文から書いたものです。

説明

CLI/SDK Interface feedback orders api

A couple users have reported one of the more tedious parts of using the SDK and CLI is putting all the requests together when ordering a large number of items.

The orders API allows a maximum of 500 items at once (and works best if it's a 100 or less), but many use cases involving larger AOI's and/or deep time stacks involve more than that. A user has to break it up into a number of different requests and then download all of them.

We could offer the ability to break up an order on behalf of the user. In discussion with @jreiberkyle we decided (if I remember right) that the smoothest path (from a CLI perspective) would be to let a user provide an arbitrary long list of id's, but if it's over the limit then we'd have an interactive prompt informing them that their order is past the limit, and it needs to be broken up into smaller orders, and ask them if they'd like that done automatically. We'd then issue as many orders as needed to fulfill the request, returning a list of order id's. The default would likely be that we just then let the user decide if they want to wait and download each, but we could also explore some sort of new bulk wait and download request.

From the python API perspective we also want to offer some sort of bulk offering, with an 'opt-in' step, but @jreiberkyle was going to think of the best way to do that, perhaps another method that takes a longer list of orders and returns a list of order ids, etc.

In both cases we would have to provide 'names' for each order, but both paths would take an order name as an argument, so we could likely just append the order number.

Talking to the core API team at Planet it sounds like breaking orders up into 100 items or less gets the highest chance of success. Right now I'm thinking we could 'offer' this at any order over 100, but if it's under 500 we'd still let them place the order. But I think either way when we break it up we should do chunks of 100 items, for the highest chance of success.

主要言語
Python
スター
300
フォーク
99
PR マージ指標
30日以内にマージされた PR はありません

環境構築

はじめの一歩

  1. issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
  2. 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
  3. リポジトリをフォークし、ブランチを切って変更します。
  4. issue 番号を参照したプルリクエストを送ります。

planetlabs/planet-client-python のほかの issue

planetlabs/planet-client-python の issue をすべて見る

似ている issue

Python の issue をもっと見る

新しい issue をメールで受け取る

初心者向けの GitHub issue を短くまとめたダイジェスト。