Refactor robosat to be a proper library with utility tools on top of it
Nobody has claimed this yet.
Assessment
- Difficulty
- 5/5
- Estimated time
- Over a week
- Newbie friendliness
- 25/100
Research direction
Start by inspecting the robosat.tools command-line utilities, especially convert and masks, and identify functionality that belongs in robosat packages. Move mask splitting and soft-voting behind reusable library entry points, then verify that the tools only parse arguments and delegate to them. Done means the robosat package can be installed and imported independently of the tools.
Written by the indexing model from the issue text.
Description
At the moment we almost have a clean split in place: we have command line utilities in robosat.tools and everything else split off of it. What we should do is making sure all functionality is in packages and not in robosat.tools: all the command line tools should do is parse command line arguments and then delegate to robosat library functions.
Here are an examples where this is not the case currently:
- The convert tool has the functionality for splitting off masks
- And the masks tool has the functionality to do the soft-voting
These features should be encapsulated in robosat packages and then only getting called in the tools.
Why are we doing this? We want to create a Python robosat package folks can install and re-use. Think:
pip install robosat
from robosat.ensemble import softvote
....
Our tools should have a dependency on this robosat package; but not the other way around.
- Dominant language
- Python
- Stars
- 2.1k
- Forks
- 385
- PR merge metrics
- No merged PRs in 30d
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
More from mapbox/robosat
-
Difficulty 1/5 Under an hour Newbie friendliness 35/100
-
Difficulty 5/5 Over a week Newbie friendliness 20/100
-
Difficulty 4/5 3-5 days Newbie friendliness 32/100
-
Difficulty 3/5 1-2 days Newbie friendliness 30/100
-
Bringin own data Open
Difficulty 5/5 Over a week Newbie friendliness 20/100
Similar issues
-
Difficulty 2/5 1-3 hours Newbie friendliness 88/100
-
Difficulty 2/5 1-3 hours Newbie friendliness 82/100
-
Difficulty 2/5 1-3 hours Newbie friendliness 78/100
-
enhancement
Difficulty 2/5 1-3 hours Newbie friendliness 72/100
-
Difficulty 2/5 1-3 hours Newbie friendliness 74/100