v0.74.0

Important breaking change:

The python-on-whales command is not available anymore, meaning that you cannot download the docker client binary automatically.
You need to install it yourself by using the Docker installation guide: https://docs.docker.com/engine/install/ . Note that you need only the client, you can skip the installation of the full docker engine. For example, on Ubuntu, that means you just need to do

sudo apt-get install docker-ce-cli docker-buildx-plugin docker-compose-plugin

instead of

sudo apt-get install docker-ce docker-ce-cli containerd.io docker-buildx-plugin docker-compose-plugin

What's Changed

• Fix breakage of ContainerCLI.create(env_files=path) by @LewisGaul in #637
• Remove download docker client functionality by @LewisGaul in #633
• Update docs references to download-cli by @LewisGaul in #639
• Display an error message if using the python-on-whales command by @gabrieldemarmiesse in #640
• Set defer_build=True pydantic config, improving import time significantly by @LewisGaul in #643
• Add podman is_infra and namespace fields to Container object by @LewisGaul in #641
• Fix Pod property type annotations to allow for missing fields in inspect output by @LewisGaul in #648

Full Changelog: v0.73.0...v0.74.0

v0.73.0

What's Changed

• 🐛 Fix wrong links in docker_client.md by @gabrieldemarmiesse in #613
• Add bootstrap cli flag for create/inspect by @fizzgig1888 in #600
• Add support for 'podman container init' by @LewisGaul in #615
• Replace isort, black and flake8 with ruff by @einarwar in #617
• Add Tuple[Union[str, int]] to ValidPortMapping by @eclark0426 in #619
• Fix handling of 'podman pod create --share=...' by @LewisGaul in #620
• Allow for multiple env-files by @einarwar in #616
• Fix "Render docs" CI job by @LewisGaul in #628
• Drop support for pydantic v1 by @LewisGaul in #630
• add auto/light/dark mode for docs by @s-light in #625
• Update pod component to use generic Iterable and Mapping types by @LewisGaul in #599
• Update container component to accept args as Iterable and Mapping by @LewisGaul in #627
• added missing docstrings for docker.network.inspect(), docker.network.list(), docker.network.prune() by @stock90975 in #631
• Add "network exists" command by @eclark0426 in #632

New Contributors

• @fizzgig1888 made their first contribution in #600
• @eclark0426 made their first contribution in #619
• @s-light made their first contribution in #625
• @stock90975 made their first contribution in #631

Full Changelog: v0.72.0...v0.73.0

v0.72.0

What's Changed

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

New Contributors

• @valberg made their first contribution in #582
• @pcharmoille made their first contribution in #589

Full Changelog: v0.71.0...v0.72.0

v0.71.0

What's Changed

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

New Contributors

• @kamalmarhubi made their first contribution in #574
• @Taragolis made their first contribution in #573
• @tjd78 made their first contribution in #579

Full Changelog: v0.70.1...v0.71.0

v0.70.1

What's Changed

• fix repr return for Tasks by @anesmemisevic in #565
• 🐛 Fix docker.buildx.list() for buildx 0.13 by @gabrieldemarmiesse in #568

New Contributors

• @anesmemisevic made their first contribution in #565

Full Changelog: v0.70.0...v0.70.1

v0.70.0

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 #554
• Fixpodman.image.exists by @jhc4318 in #558
• ✨ docker.compose.down() can take str as service arg by @gabrieldemarmiesse in #562
• feat(service): Add docker service ls --filter option by @fuentes73 in #561
• 🐛 Fix parsing of compose file configs with compose v2.24.7 by @gabrieldemarmiesse in #563

New Contributors

• @jhc4318 made their first contribution in #554

Full Changelog: v0.69.0...v0.70.0

v0.69.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 #519
• ✨ Added argument client_type to add custom logic later by @gabrieldemarmiesse in #524
• Add missing tty and interactive flags to container create and start by @LewisGaul in #545
• Fixed pydantic error on service model by @jonakarl in #548
• add platforms parameter to buildx.create by @emalihin in #541
• Add support for podman --env-host flag when creating containers by @LewisGaul in #551

New Contributors

• @jonakarl made their first contribution in #548
• @emalihin made their first contribution in #541

Full Changelog: v0.68.0...v0.69.0

v0.68.0

What's Changed

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

Full Changelog: v0.67.0...v0.68.0

v0.67.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:

• #495
• https://docs.python.org/3/tutorial/controlflow.html#special-parameters

What's Changed

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

New Contributors

• @d4nj1 made their first contribution in #492
• @HemaZ made their first contribution in #497

Full Changelog: v0.66.0...v0.67.0

v0.66.0

What's Changed

• Fix doc deployment by @kashyab12 in #489
• returns the context when using context.use by @avgdev in #488
• adds support for --renew-anon-volumes by @avgdev in #487
• Set the minimum version of pydantic to 1.9 by @kashyab12 in #491

New Contributors

• @kashyab12 made their first contribution in #489
• @avgdev made their first contribution in #488

Full Changelog: v0.65.0...v0.66.0