This issue tracks the release note for the following F26 Change:
https://fedoraproject.org/wiki/Changes/Docker_SDK_For_Python_Version_2
If you want to write this release note, then:
Note that sometimes, the contact people are unresponsive. Try to do your best, but if nobody gets back to you, it's not the end of the world.
Once you're done with the above, make sure to either commit the relnote to an appropriate section of the Release Notes book, or, if you're not familiar with Git, DocBook, or whatever else, just add it to this issue as a comment and let pbokoc[1] know that you're done with this one and you'd like the note included. Be sure to do this at least one day before the final release (so the limit is July 10 according to the current schedule). Also make sure to do this even for relnotes that haven't been checked by the change owner.
[0] You can do that by asking the change owner listed on the wiki page; alternatively you can infer it by checking the tracker bug (linked in Wiki) in Bugzilla and looking at its status; see bug comments for details. Ask someone on the mailing list or on IRC if you're not sure. [1] In #fedora-docs on FreeNode (UTC+1 timezone, online mostly during the day on weekdays), or pbokoc@redhat.com if you can't get a hold of me on IRC.
Metadata Update from @yoanaruseva: - Issue assigned to yoanaruseva
@yoanaruseva status? Was @ttomecek able to provide what we need?
I didn't provide any docs. I'm not sure it makes sense to document this much. tl;dr upstream released version 2, it changed a lot, here are the upstream release notes: https://docker-py.readthedocs.io/en/stable/change-log.html#
@ttomecek can you provide 2-3 highlights of the changes and any cautions that a user of the previous version should know? We can combine that with the upstream notes.
Highlights:
A new, high-level, user-focused API provided as docker.DockerClient.
docker.DockerClient
The package was renamed from docker-py to docker at PyPI meaning that in Fedora it's available now as python2-docker or python3-docker.
docker-py
docker
python2-docker
python3-docker
docker.Client class has been renamed to docker.APIClient.
docker.Client
docker.APIClient
The software is not backwards compatible with python-docker-py <= 1.10.6 due to the changes mentioned above.
Thanks @ttomecek, is this note OK?
A new version of Docker SDK for Python, the Python library which communicates with the Docker engine API, has been added to Fedora 26. It provides a new, ligh-level, user-focused API provided as docker.DockerClient. This obsoletes the existing python-docker-py package. The functionality is now provided by the "python2-docker" and "python3-docker" packages. The "docker.Client" class has been renamed to "docker.APIClient". Note that the version 2 of Docker SDK is not backwards compatible with the versions earlier than 1.10.6 of the library.
-ligh-level +high-level
just this typo, otherwise LGTM, thank you!
Metadata Update from @yoanaruseva: - Issue close_status updated to: Fixed - Issue status updated to: Closed (was: Open)
(the typo is fixed btw, no worries :)
Metadata Update from @pbokoc: - Issue status updated to: Open (was: Closed)
Adding a new comment reopens issues? That's interesting.
Metadata Update from @pbokoc: - Issue close_status updated to: Fixed - Issue status updated to: Closed (was: Open)
Login to comment on this ticket.