docker / docker/docker-py

[Epic] Rename "docker-py" to "Docker SDK for Python"

Open
#1,310 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
Python
Stars
7.2k
Forks
1.7k
Avg merge
13d 8h
Merged PRs (30d)
2

Description

Proposal

As part of a wider initiative, we're creating some properly supported SDKs for the Engine API.

docker-py was the first official-ish library, all that time ago. Go is now the second. However, if we're going to continue to create ones for other languages, it'd be nice if they had consistent naming, roughly consistent APIs, and so on. It is also helpful to be able to refer them as a collective product, rather than the wishy-washy "client libraries for the Engine API".

Hence, the "Docker SDKs". Each particular language will be "Docker SDK for X": Docker SDK for Python, Docker SDK for Go, etc. There will be centralised documentation with a getting started guide for multiple languages (and curl!), which link off to each library's respective reference documentation.

Tasks
  • Make it really clear that "docker-py" is now "Docker SDK for Python". All old URLs should redirect, all landing pages should mention that it has renamed, and so on.
  • Replace all mentions of "docker-py" in the source code with "Docker SDK for Python" or "docker-sdk-python". https://github.com/docker/docker-py/pull/1315
  • Move the GitHub repository to docker/docker-sdk-python. (Update Travis, Jenkins, etc, too.)
  • Move the documentation to https://docker-sdk-python.readthedocs.io. Ensure the old documentation redirects correctly.
  • Fix all URLs that have changed above in source code and docs. #1332
  • Release 2.0 as the PyPi package "docker", not "docker-py". "docker-py" will remain for 1.x.

Contributor guide

Open the contributing guide

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.

Research direction

Start by reviewing the unchecked tasks: repository and documentation moves, redirects, URL updates, and Travis/Jenkins changes. Check the source code and docs for old URLs and names, then verify that the new repository, Read the Docs site, and redirects consistently use Docker SDK for Python or docker-sdk-python.

Written by the indexing model from the issue text.

Assessment

Tech stack
docker, python
Domain
devops, documentation, release
Issue type
Refactor
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.