Skip to content

Commit b45f265

Browse files
committed
Rename non-URL occurrences of docker-py to "Docker SDK for Python"
Signed-off-by: Joffrey F <[email protected]>
1 parent 514291c commit b45f265

File tree

5 files changed

+24
-22
lines changed

5 files changed

+24
-22
lines changed

CONTRIBUTING.md

Lines changed: 14 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
# Contributing guidelines
22

33
See the [Docker contributing guidelines](https://github.com/docker/docker/blob/master/CONTRIBUTING.md).
4-
The following is specific to docker-py.
4+
The following is specific to Docker SDK for Python.
55

66
Thank you for your interest in the project. We look forward to your
77
contribution. In order to make the process as fast and streamlined as possible,
@@ -10,28 +10,29 @@ here is a set of guidelines we recommend you follow.
1010
## Reporting issues
1111

1212
We do our best to ensure bugs don't creep up in our releases, but some may
13-
still slip through. If you encounter one while using docker-py, please create
14-
an issue [in the tracker](https://github.com/docker/docker-py/issues/new) with
13+
still slip through. If you encounter one while using the SDK, please
14+
create an issue
15+
[in the tracker](https://github.com/docker/docker-py/issues/new) with
1516
the following information:
1617

17-
- docker-py version, docker version and python version
18+
- SDK version, Docker version and python version
1819
```
19-
pip freeze | grep docker-py && python --version && docker version
20+
pip freeze | grep docker && python --version && docker version
2021
```
2122
- OS, distribution and OS version
2223
- The issue you're encountering including a stacktrace if applicable
2324
- If possible, steps or a code snippet to reproduce the issue
2425

2526
To save yourself time, please be sure to check our
2627
[documentation](https://docker-py.readthedocs.io/) and use the
27-
[search function](https://github.com/docker/docker-py/search) to find out if
28-
it has already been addressed, or is currently being looked at.
28+
[search function](https://github.com/docker/docker-py/search) to find
29+
out if it has already been addressed, or is currently being looked at.
2930

3031
## Submitting pull requests
3132

3233
Do you have a fix for an existing issue, or want to add a new functionality
33-
to docker-py? We happily welcome pull requests. Here are a few tips to make
34-
the review process easier on both the maintainers and yourself.
34+
to the SDK? We happily welcome pull requests. Here are a few tips to
35+
make the review process easier on both the maintainers and yourself.
3536

3637
### 1. Sign your commits
3738

@@ -87,11 +88,10 @@ to reach out and ask questions. We will do our best to answer and help out.
8788

8889
## Development environment
8990

90-
If you're looking contribute to docker-py but are new to the project or Python,
91-
here are the steps to get you started.
91+
If you're looking contribute to Docker SDK for Python but are new to the
92+
project or Python, here are the steps to get you started.
9293

93-
1. Fork [https://github.com/docker/docker-py](https://github.com/docker/docker-py)
94-
to your username.
94+
1. Fork https://github.com/docker/docker-py to your username.
9595
2. Clone your forked repository locally with
9696
`git clone [email protected]:yourusername/docker-py.git`.
9797
3. Configure a
@@ -110,8 +110,7 @@ To get the source source code and run the unit tests, run:
110110
```
111111
$ git clone git://github.com/docker/docker-py.git
112112
$ cd docker-py
113-
$ pip install tox
114-
$ tox
113+
$ make test
115114
```
116115

117116
## Building the docs

MAINTAINERS

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# Docker-py maintainers file
1+
# Docker SDK for Python maintainers file
22
#
33
# This file describes who runs the docker/docker-py project and how.
44
# This is a living document - if you see something out of date or missing, speak up!

README.md

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,15 +2,17 @@
22

33
[![Build Status](https://travis-ci.org/docker/docker-py.svg?branch=master)](https://travis-ci.org/docker/docker-py)
44

5-
**Warning:** This readme is for the development version of docker-py, which is significantly different to the stable version. [Documentation for the stable version is here.](https://docker-py.readthedocs.io/)
5+
**Warning:** This README is for the development version of the Docker SDK for
6+
Python, which is significantly different to the stable version.
7+
[Documentation for the stable version is here.](https://docker-py.readthedocs.io/)
68

79
A Python library for the Docker Engine API. It lets you do anything the `docker` command does, but from within Python apps – run containers, manage containers, manage Swarms, etc.
810

911
## Installation
1012

1113
The latest stable version [is available on PyPi](https://pypi.python.org/pypi/docker/). Either add `docker` to your `requirements.txt` file or install with pip:
1214

13-
pip install docker-py
15+
pip install docker
1416

1517
## Usage
1618

docker/transport/npipeconn.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -96,7 +96,7 @@ def request_url(self, request, proxies):
9696
# doesn't have a hostname, like is the case when using a UNIX socket.
9797
# Since proxies are an irrelevant notion in the case of UNIX sockets
9898
# anyway, we simply return the path URL directly.
99-
# See also: https://github.com/docker/docker-py/issues/811
99+
# See also: https://github.com/docker/docker-sdk-python/issues/811
100100
return request.path_url
101101

102102
def close(self):

docker/utils/json_stream.py

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -13,10 +13,11 @@
1313

1414

1515
def stream_as_text(stream):
16-
"""Given a stream of bytes or text, if any of the items in the stream
16+
"""
17+
Given a stream of bytes or text, if any of the items in the stream
1718
are bytes convert them to text.
18-
This function can be removed once docker-py returns text streams instead
19-
of byte streams.
19+
This function can be removed once we return text streams
20+
instead of byte streams.
2021
"""
2122
for data in stream:
2223
if not isinstance(data, six.text_type):

0 commit comments

Comments
 (0)