Package for PyPI publication
Assessment
- Difficulty
- 5/5
- Estimated time
- Over a week
- Newbie friendliness
- 35/100
- Issue type
- Feature
- Clarity
- Mostly clear
- Activity status
- Quiet
- Tech stack
- huggingface, python
- Domain
- build-system, cli, documentation, release
Research direction
Start by deciding the package name and narrowing the listed changes to what PyPI publication requires. Review the proposed cli.py entry point, README and data/ updates, dependency and model-weight handling, and the PyPI Actions workflow. Done means the project can be installed from PyPI with documented entry points and a tagged release.
Written by the indexing model from the issue text.
Description
Packaging SST for publication and installation via PyPI has been expressed as a desirable update to the project in a few contexts.
The first decision that would be needed for this though is a package name because bare sst is claimed.
And changes that seem appropriate:
- Drop GroundingDINO (or excise it into a branch for further exploration of text-based segmentation, perhaps for evaluation alongside SAM3)
- Migrate local SAM2 copy use to sam2 imports and default configs
- Specify
from sst importto avoid ambiguous imports - Retrieve model weights from HF automatically rather than as a manual step
- Set entry points and a simple
cli.pymodule, with launching the GUI as its own subcommand - Pin down dependencies a bit
- PyPI Actions workflow
- README and demo updates for
data/ - Housekeeping DOI, Zenodo, etc.
This should be most of what's needed for packaging. Scope here should probably be limited to just what's needed for PyPI publication.
This would obviously be a breaking change for anyone currently using the scripts from the cloned repo. We should probably want to tag a release for the current 'scripts era' at v1.1.0 and release the updated PyPI as v2.0.0.
Any/all of the above is available for discussion!
- Dominant language
- Jupyter Notebook
- Stars
- 16
- Forks
- 4
- PR merge metrics
- No merged PRs in 30d
Getting set up
This project ships no dev container, Dockerfile or contributing guide, so setting up is up to you: start from its README, and see our first-contribution guide for the general steps.
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 Imageomics/SST
-
napari-sst plugin: integrate reference mask annotation into napariMay be free again @sahasra-yikuntam claimed this 59 days ago, and no pull request is open. Open
Imageomics/SST#30 · 1 assignee ·
-
Create initial documentation site contentsMay be free again @sahasra-yikuntam claimed this 75 days ago, and no pull request is open. Opendocumentation
Imageomics/SST#29 · 1 assignee ·
-
Set PR preview builds (and site hosting) to go through Cloudflare to prevent gh-pages branch bloat.May be free again @thompsonmj claimed this 75 days ago, and no pull request is open. Open
Imageomics/SST#28 · 1 assignee ·
-
documentation
Difficulty 4/5 3-5 days Newbie friendliness 45/100
Imageomics/SST#24 · 2 reactions ·
Similar issues
-
Difficulty 2/5 1-3 hours Newbie friendliness 78/100
inabagumi/shinju-date#7406 ·
Maintainers usually reply within 1 day
-
chore
Difficulty 2/5 1-3 hours Newbie friendliness 70/100
-
bug
Difficulty 2/5 1-3 hours Newbie friendliness 82/100
sebastian-software/ardo#572 ·
Maintainers usually reply within 1 day
-
Difficulty 2/5 1-3 hours Newbie friendliness 78/100
-
Issue PRL on WindowsOpen
Difficulty 2/5 1-3 hours Newbie friendliness 78/100
Maintainers usually reply within 1 day