python-on-whales

What's Changed

• Fix links in images objects docs. by @valberg in https://github.com/gabrieldemarmiesse/python-on-whales/pull/582
• Change DockerException message to remove mention of "docker" by @LewisGaul in https://github.com/gabrieldemarmiesse/python-on-whales/pull/585
• fix: wheel includes tests and docs by @betaboon in https://github.com/gabrieldemarmiesse/python-on-whales/pull/586
• Allow podman exec with --interactive and no --tty by @jhc4318 in https://github.com/gabrieldemarmiesse/python-on-whales/pull/583
• Fix documentation and docstring issues by @pcharmoille in https://github.com/gabrieldemarmiesse/python-on-whales/pull/589
• Add support for 'docker version' and 'podman version' by @LewisGaul in https://github.com/gabrieldemarmiesse/python-on-whales/pull/593
• Set up command construction to support generic iterables and mappings by @LewisGaul in https://github.com/gabrieldemarmiesse/python-on-whales/pull/595
• Implement support for podman pods by @LewisGaul in https://github.com/gabrieldemarmiesse/python-on-whales/pull/544
• Make the test_cpus() testcase non-strict xfail for podman by @LewisGaul in https://github.com/gabrieldemarmiesse/python-on-whales/pull/597
• Fix merge issue in CONTRIBUTING.md by @LewisGaul in https://github.com/gabrieldemarmiesse/python-on-whales/pull/604
• Fix test_save_load() testcase to handle the case an image has multiple tags by @LewisGaul in https://github.com/gabrieldemarmiesse/python-on-whales/pull/596
• Replace unrecognised unicode characters rather than raising an exception by @LewisGaul in https://github.com/gabrieldemarmiesse/python-on-whales/pull/607
• Support generic iterables and mappings in the image component by @LewisGaul in https://github.com/gabrieldemarmiesse/python-on-whales/pull/598
• ✍️ Made the arguments part prettier in docs by @gabrieldemarmiesse in https://github.com/gabrieldemarmiesse/python-on-whales/pull/610
• Add test for rendering of docs by @gabrieldemarmiesse in https://github.com/gabrieldemarmiesse/python-on-whales/pull/611

New Contributors

• @valberg made their first contribution in https://github.com/gabrieldemarmiesse/python-on-whales/pull/582
• @pcharmoille made their first contribution in https://github.com/gabrieldemarmiesse/python-on-whales/pull/589

Full Changelog: https://github.com/gabrieldemarmiesse/python-on-whales/compare/v0.71.0...v0.72.0

What's Changed

• Add stream output for pruning by @anesmemisevic in https://github.com/gabrieldemarmiesse/python-on-whales/pull/566
• Improve typing for DockerClient.compose.config by @einarwar in https://github.com/gabrieldemarmiesse/python-on-whales/pull/572
• Function docker.compose.down does not accept optional list of service names #570 by @MisterOwlPT in https://github.com/gabrieldemarmiesse/python-on-whales/pull/571
• Fix time argument formatting to include time zone by @kamalmarhubi in https://github.com/gabrieldemarmiesse/python-on-whales/pull/574
• feat: Add --wait-timeout option for docker.compose.up by @Taragolis in https://github.com/gabrieldemarmiesse/python-on-whales/pull/573
• Emit a DeprecationWarning when downloading the docker client by @LewisGaul in https://github.com/gabrieldemarmiesse/python-on-whales/pull/577
• Support podman's --preserve-fds arg to container run/exec by @LewisGaul in https://github.com/gabrieldemarmiesse/python-on-whales/pull/576
• Added timezone argument to run and create by @tjd78 in https://github.com/gabrieldemarmiesse/python-on-whales/pull/579
• Docker Buildx Pruning Logs Streaming by @anesmemisevic in https://github.com/gabrieldemarmiesse/python-on-whales/pull/578

New Contributors

• @kamalmarhubi made their first contribution in https://github.com/gabrieldemarmiesse/python-on-whales/pull/574
• @Taragolis made their first contribution in https://github.com/gabrieldemarmiesse/python-on-whales/pull/573
• @tjd78 made their first contribution in https://github.com/gabrieldemarmiesse/python-on-whales/pull/579

Full Changelog: https://github.com/gabrieldemarmiesse/python-on-whales/compare/v0.70.1...v0.71.0

What's Changed

• fix repr return for Tasks by @anesmemisevic in https://github.com/gabrieldemarmiesse/python-on-whales/pull/565
• 🐛 Fix docker.buildx.list() for buildx 0.13 by @gabrieldemarmiesse in https://github.com/gabrieldemarmiesse/python-on-whales/pull/568

New Contributors

• @anesmemisevic made their first contribution in https://github.com/gabrieldemarmiesse/python-on-whales/pull/565

Full Changelog: https://github.com/gabrieldemarmiesse/python-on-whales/compare/v0.70.0...v0.70.1

This update contains (hopefully) all fixes for the breaking changes introduced in docker compose v2.24.7. If you still encounter issues, file a issue here and downgrade docker compose to v2.24.6 in the meantime.

What's Changed

• Add detach_keys argument for start and exec by @jhc4318 in https://github.com/gabrieldemarmiesse/python-on-whales/pull/554
• Fixpodman.image.exists by @jhc4318 in https://github.com/gabrieldemarmiesse/python-on-whales/pull/558
• ✨ docker.compose.down() can take str as service arg by @gabrieldemarmiesse in https://github.com/gabrieldemarmiesse/python-on-whales/pull/562
• feat(service): Add docker service ls --filter option by @fuentes73 in https://github.com/gabrieldemarmiesse/python-on-whales/pull/561
• 🐛 Fix parsing of compose file configs with compose v2.24.7 by @gabrieldemarmiesse in https://github.com/gabrieldemarmiesse/python-on-whales/pull/563

New Contributors

• @jhc4318 made their first contribution in https://github.com/gabrieldemarmiesse/python-on-whales/pull/554

Full Changelog: https://github.com/gabrieldemarmiesse/python-on-whales/compare/v0.69.0...v0.70.0

What's Changed

Since this is a big release, I'll only put here the commits which have an impact on end users and remove internal refactoring.

• #518 Add platform option for pull by @d4nj1 in https://github.com/gabrieldemarmiesse/python-on-whales/pull/519
• ✨ Added argument client_type to add custom logic later by @gabrieldemarmiesse in https://github.com/gabrieldemarmiesse/python-on-whales/pull/524
• Add missing tty and interactive flags to container create and start by @LewisGaul in https://github.com/gabrieldemarmiesse/python-on-whales/pull/545
• Fixed pydantic error on service model by @jonakarl in https://github.com/gabrieldemarmiesse/python-on-whales/pull/548
• add platforms parameter to buildx.create by @emalihin in https://github.com/gabrieldemarmiesse/python-on-whales/pull/541
• Add support for podman --env-host flag when creating containers by @LewisGaul in https://github.com/gabrieldemarmiesse/python-on-whales/pull/551

New Contributors

• @jonakarl made their first contribution in https://github.com/gabrieldemarmiesse/python-on-whales/pull/548
• @emalihin made their first contribution in https://github.com/gabrieldemarmiesse/python-on-whales/pull/541

Full Changelog: https://github.com/gabrieldemarmiesse/python-on-whales/compare/v0.68.0...v0.69.0

What's Changed

• Error docker.execute with str by @kashyab12 in https://github.com/gabrieldemarmiesse/python-on-whales/pull/501
• ✨ Added stream_logs to docker.compose.up() by @HemaZ in https://github.com/gabrieldemarmiesse/python-on-whales/pull/505
• ✨ Added stream_logs to docker.compose.stop() by @HemaZ in https://github.com/gabrieldemarmiesse/python-on-whales/pull/507
• ✨ Added stream_logs to docker.compose.start() by @HemaZ in https://github.com/gabrieldemarmiesse/python-on-whales/pull/508
• service create args: network,restart,secrets by @fuentes73 in https://github.com/gabrieldemarmiesse/python-on-whales/pull/511
• feat(service): Add --mount arg && update --replicas by @fuentes73 in https://github.com/gabrieldemarmiesse/python-on-whales/pull/514

Full Changelog: https://github.com/gabrieldemarmiesse/python-on-whales/compare/v0.67.0...v0.68.0

This release is the first where we'll slowly force some arguments to be positional only or keyword only. This is to ensure we have the flexibility in the future to change functions signatures without breaking people's code. Also that will make the user's code cleaner and less error prone.

If you get errors that look like "function xxxx take 2 positional arguments but recieved 4" then it's that we enforced the way to pass arguments. Double check the function signature in your documentation and IDE, it should be just a matter of specifying the argument name or not. Open an issue if you're having trouble.

In practice we don't expect much code to break, that seems unlikely.

If you're looking for some ressources:

• https://github.com/gabrieldemarmiesse/python-on-whales/issues/495
• https://docs.python.org/3/tutorial/controlflow.html#special-parameters

What's Changed

• Add platform variant to image inspect by @d4nj1 in https://github.com/gabrieldemarmiesse/python-on-whales/pull/492
• ✨ Allow the streaming of the docker.compose.build logs by @gabrieldemarmiesse in https://github.com/gabrieldemarmiesse/python-on-whales/pull/494
• Allow the streaming of the docker.compose.pull logs by @HemaZ in https://github.com/gabrieldemarmiesse/python-on-whales/pull/497
• ✨ Add stream_logs to docker.compose.down() by @gabrieldemarmiesse in https://github.com/gabrieldemarmiesse/python-on-whales/pull/496
• ✨ Added stream_logs to docker.compose.create() by @gabrieldemarmiesse in https://github.com/gabrieldemarmiesse/python-on-whales/pull/498
• 🧹 Make some arguments positional only or kwd only by @gabrieldemarmiesse in https://github.com/gabrieldemarmiesse/python-on-whales/pull/500

New Contributors

• @d4nj1 made their first contribution in https://github.com/gabrieldemarmiesse/python-on-whales/pull/492
• @HemaZ made their first contribution in https://github.com/gabrieldemarmiesse/python-on-whales/pull/497

Full Changelog: https://github.com/gabrieldemarmiesse/python-on-whales/compare/v0.66.0...v0.67.0

What's Changed

• Fix doc deployment by @kashyab12 in https://github.com/gabrieldemarmiesse/python-on-whales/pull/489
• returns the context when using context.use by @avgdev in https://github.com/gabrieldemarmiesse/python-on-whales/pull/488
• adds support for --renew-anon-volumes by @avgdev in https://github.com/gabrieldemarmiesse/python-on-whales/pull/487
• Set the minimum version of pydantic to 1.9 by @kashyab12 in https://github.com/gabrieldemarmiesse/python-on-whales/pull/491

New Contributors

• @kashyab12 made their first contribution in https://github.com/gabrieldemarmiesse/python-on-whales/pull/489
• @avgdev made their first contribution in https://github.com/gabrieldemarmiesse/python-on-whales/pull/488

Full Changelog: https://github.com/gabrieldemarmiesse/python-on-whales/compare/v0.65.0...v0.66.0

What's Changed

• Expose dockerfile and args arguments under build by @jashparekh in https://github.com/gabrieldemarmiesse/python-on-whales/pull/477
• Replace setup.py by a pyproject.toml by @jashparekh in https://github.com/gabrieldemarmiesse/python-on-whales/pull/478

This release is the first one that uses a pyproject.toml. This should silence the pip warning that some users might get.

New Contributors

• @jashparekh made their first contribution in https://github.com/gabrieldemarmiesse/python-on-whales/pull/477

Full Changelog: https://github.com/gabrieldemarmiesse/python-on-whales/compare/v0.64.3...v0.65.0

What's Changed

• fix(ContainerConfig): stop-signal can be str or int by @ambasta in https://github.com/gabrieldemarmiesse/python-on-whales/pull/473

New Contributors

• @ambasta made their first contribution in https://github.com/gabrieldemarmiesse/python-on-whales/pull/473

Full Changelog: https://github.com/gabrieldemarmiesse/python-on-whales/compare/v0.64.2...v0.64.3

What's Changed

• Remove deprecation warning when using pydantic V2 by @einarwar in https://github.com/gabrieldemarmiesse/python-on-whales/pull/469

New Contributors

• @einarwar made their first contribution in https://github.com/gabrieldemarmiesse/python-on-whales/pull/469

Full Changelog: https://github.com/gabrieldemarmiesse/python-on-whales/compare/v0.64.1...v0.64.2

What's Changed

• Expose DockerClient from the root of the package by @LewisGaul in https://github.com/gabrieldemarmiesse/python-on-whales/pull/462
• use correct setting for pydantic v2 by @tobiasjunsten in https://github.com/gabrieldemarmiesse/python-on-whales/pull/464
• Fix documentation for docker.compose.images() by @martinburchell in https://github.com/gabrieldemarmiesse/python-on-whales/pull/467
• Add support for podman's --systemd in container run/create by @LewisGaul in https://github.com/gabrieldemarmiesse/python-on-whales/pull/453

New Contributors

• @tobiasjunsten made their first contribution in https://github.com/gabrieldemarmiesse/python-on-whales/pull/464

Full Changelog: https://github.com/gabrieldemarmiesse/python-on-whales/compare/v0.64.0...v0.64.1

This is the first release to support pydantic v2. Pydantic v1 is still supported.

⚠️ pydantic v2.0.x will never be supported because of a datetime parsing bug in pydantic. Use pydantic 2.1 or above. ⚠️

Please file a bug if you encounter a Pydantic depreciation warning.

What's Changed

• Add support to pydantic 2 by @gabrieldemarmiesse in https://github.com/gabrieldemarmiesse/python-on-whales/pull/455

Full Changelog: https://github.com/gabrieldemarmiesse/python-on-whales/compare/v0.63.0...v0.64.0

What's Changed

• 456 use stdin to log in by @zimmdi in https://github.com/gabrieldemarmiesse/python-on-whales/pull/459
• 439 no support for buildx build build context by @bigcat2014 in https://github.com/gabrieldemarmiesse/python-on-whales/pull/440

New Contributors

• @zimmdi made their first contribution in https://github.com/gabrieldemarmiesse/python-on-whales/pull/459
• @bigcat2014 made their first contribution in https://github.com/gabrieldemarmiesse/python-on-whales/pull/440

Full Changelog: https://github.com/gabrieldemarmiesse/python-on-whales/compare/v0.62.0...v0.63.0

What's Changed

• Fix: fix the gh-pages ci by @kclamalex in https://github.com/gabrieldemarmiesse/python-on-whales/pull/449
• Additional Docker Compose Run Flags by @ethanleifer in https://github.com/gabrieldemarmiesse/python-on-whales/pull/443
• Feat: Add --no-attach option for docker.compose.up by @kclamalex in https://github.com/gabrieldemarmiesse/python-on-whales/pull/451

New Contributors

• @ethanleifer made their first contribution in https://github.com/gabrieldemarmiesse/python-on-whales/pull/443

Full Changelog: https://github.com/gabrieldemarmiesse/python-on-whales/compare/v0.61.0...v0.62.0

Installing this version requires python 3.8 or above. The end of life of python 3.7 is the 27 of june, so if you are still using it, please upgrade!

What's Changed

• 🆙 Bump minimum python version to 3.8 by @gabrieldemarmiesse in https://github.com/gabrieldemarmiesse/python-on-whales/pull/431
• ✨ Add more precise type hints for filters in docker.ps() by @gabrieldemarmiesse in https://github.com/gabrieldemarmiesse/python-on-whales/pull/432
• ✨ Clarify type for buildx progress by @gabrieldemarmiesse in https://github.com/gabrieldemarmiesse/python-on-whales/pull/435
• Support passing signals as integers (or signal.Signals enum instances) by @LewisGaul in https://github.com/gabrieldemarmiesse/python-on-whales/pull/441
• Allow container selection in 'docker stats' by @MisterOwlPT in https://github.com/gabrieldemarmiesse/python-on-whales/pull/447
• Use mkdocstrings to generate documentation by @kclamalex in https://github.com/gabrieldemarmiesse/python-on-whales/pull/444

New Contributors

• @kclamalex made their first contribution in https://github.com/gabrieldemarmiesse/python-on-whales/pull/444

Full Changelog: https://github.com/gabrieldemarmiesse/python-on-whales/compare/v0.60.1...v0.61.0

What's Changed

• 🐛 Prevent the user from installing pydantic v2 by @gabrieldemarmiesse in https://github.com/gabrieldemarmiesse/python-on-whales/pull/430

⚠️ Install this release if you get the error AttributeError: type object 'NetworkIPAM' has no attribute '__fields__', see #429

Full Changelog: https://github.com/gabrieldemarmiesse/python-on-whales/compare/v0.60.0...v0.60.1

What's Changed

• Add pull flag to docker compose up by @John-Vash in https://github.com/gabrieldemarmiesse/python-on-whales/pull/421
• Make long description show pictures on PyPi. by @termim in https://github.com/gabrieldemarmiesse/python-on-whales/pull/426
• 🆙 Bump linting tools versions by @gabrieldemarmiesse in https://github.com/gabrieldemarmiesse/python-on-whales/pull/428
• Add Imagetools create command by @darpham in https://github.com/gabrieldemarmiesse/python-on-whales/pull/419

New Contributors

• @termim made their first contribution in https://github.com/gabrieldemarmiesse/python-on-whales/pull/426
• @darpham made their first contribution in https://github.com/gabrieldemarmiesse/python-on-whales/pull/419

Full Changelog: https://github.com/gabrieldemarmiesse/python-on-whales/compare/v0.59.0...v0.60.0

⚠️ This release is the last one that supports Python 3.7. The version 0.61.0 will only support Python 3.8 and above

What's Changed

• 🔧 Rework the CI by @gabrieldemarmiesse in https://github.com/gabrieldemarmiesse/python-on-whales/pull/414
• ⚡ speed up ci by @gabrieldemarmiesse in https://github.com/gabrieldemarmiesse/python-on-whales/pull/415
• 🆙 Upgrade lint tools by @gabrieldemarmiesse in https://github.com/gabrieldemarmiesse/python-on-whales/pull/416
• ✨ Added new provenance options for docker.buildx.build() by @gabrieldemarmiesse in https://github.com/gabrieldemarmiesse/python-on-whales/pull/410
• ⚡ Run some tests in parralel by @gabrieldemarmiesse in https://github.com/gabrieldemarmiesse/python-on-whales/pull/417
• ✨ Better error message when using command as a string by @gabrieldemarmiesse in https://github.com/gabrieldemarmiesse/python-on-whales/pull/420

Full Changelog: https://github.com/gabrieldemarmiesse/python-on-whales/compare/v0.58.0...v0.59.0

What's Changed

• Add 'docker compose up --wait' functionality by @m-roberts in https://github.com/gabrieldemarmiesse/python-on-whales/pull/411

New Contributors

• @m-roberts made their first contribution in https://github.com/gabrieldemarmiesse/python-on-whales/pull/411

Full Changelog: https://github.com/gabrieldemarmiesse/python-on-whales/compare/v0.57.0...v0.58.0