replicate/cog

If Docker is not installed, explain how to install Docker

Closed

#152 opened on Jul 19, 2021

View on GitHubContributor guide
 (1 comment) (0 reactions) (0 assignees)Python (356 forks)batch import
enhancementgood first issue

Repository metrics

Stars
 (5,724 stars)
PR merge metrics
 (Avg merge 7d 8h) (19 merged PRs in 30d)

Description

Cog depends on Docker to package models. The installation instructions in our docs specify that installing Docker is a prerequisite to using Cog, but it is still possible to install Cog without installing Docker. Let's update the cog CLI to check whether Docker is installed, and exit with a helpful error message if Docker is not installed.

edited by @zeke

Contributor guide

Research direction
Examine the cog CLI source code, likely in a file like `cog/cli.py` or similar, to identify the main entry point. Use Python's `subprocess` module to check if Docker is installed by calling `docker version`. If Docker is not found, exit with a clear error message explaining how to install Docker. Reference existing error handling patterns in the codebase for consistency. Consider cross platform compatibility for the Docker binary path.
Tech stack
python
Domain
clideveloper experience
Issue type
Feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
Under 1 hour
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Stale
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
Python
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
80