Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

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

Open
bfirsh opened this issue Nov 24, 2016 · 0 comments

Comments

Projects
None yet
2 participants
@bfirsh
Copy link
Contributor

commented Nov 24, 2016

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". #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.

bfirsh added a commit to bfirsh/docker-py that referenced this issue Nov 28, 2016

Start to rename docker-py to docker-sdk-python
Pretty much everything except renaming the GitHub repo and
documentation, which is not actually done yet. Nearer the release
we can do a search/replace for all that stuff.

Ref docker#1310

Signed-off-by: Ben Firshman <ben@firshman.co.uk>

@bfirsh bfirsh changed the title Proposal/epic: Rename "docker-py" to "Docker SDK for Python" [Epic] Rename "docker-py" to "Docker SDK for Python" Nov 28, 2016

@shin- shin- added this to the 2.0.0 milestone Nov 28, 2016

shin- added a commit that referenced this issue Dec 8, 2016

Start to rename docker-py to docker-sdk-python
Pretty much everything except renaming the GitHub repo and
documentation, which is not actually done yet. Nearer the release
we can do a search/replace for all that stuff.

Ref #1310

Signed-off-by: Ben Firshman <ben@firshman.co.uk>

@shin- shin- modified the milestones: 2.1.0, 2.0.0 Dec 12, 2016

@shin- shin- modified the milestones: 2.1.0, 2.2.0 Feb 16, 2017

@shin- shin- modified the milestones: 2.3.0, 2.2.0 Mar 21, 2017

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
You can’t perform that action at this time.