Open-EO / Open-EO/openeo-python-client

job manager: rename "start_job" to "create_job"

Open
#724 2 comments 0 reactions 1 assignee View on GitHub

@soxofaan is already working on this.

Since Feb 17, 2025.

architecture clean up collect feedback documentation job manager technical debt usability
Dominant language
Python
Stars
217
Forks
56
Avg merge
1d 22h
Merged PRs (30d)
2

Description

The job manager API has this "start_job" callable:

https://github.com/Open-EO/openeo-python-client/blob/29a3276d86071f2f6ae3100e663a1d740dcc56b8/openeo/extra/job_management/__init__.py#L319-L322

This callable allows the user to just create a job, or also start it.
The current name encourages the user to start it,
but I think we should actually recommend against that because that undermines the possibilities to handle the job starting in a smarter way (e.g. do the "start job" request in a worker thread for more efficient time management)

Contributor guide

No contributing guide indexed for this repository

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.

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.