python-on-whales

What's Changed

• feat : Add support for Docker service networks in ComposeService by @R3gardless in #683
• [Docs] Enable Syntax Highlighting by @lgeiger in #686
• Improve typing of run by using @overload by @patrick91 in #685
• Add metadata_file opt-in for buildx builds by @K-dash in #689

New Contributors

• @R3gardless made their first contribution in #683
• @lgeiger made their first contribution in #686
• @patrick91 made their first contribution in #685
• @K-dash made their first contribution in #689

Thank you for your contributions! This makes me very happy to see new faces!

Full Changelog: v0.78.0...v0.79.0

What's Changed

• Allow customization of --isolation and --quiet in legacy_build by @makuchma in #680
• Stream output from pull and push command by @dabico in #678
• Explicitely preserver order while removing duplicates in push/pull by @gabrieldemarmiesse in #681

New Contributors

• @makuchma made their first contribution in #680
• @dabico made their first contribution in #678

Full Changelog: v0.77.0...v0.78.0

What's Changed

• Rework filters to support passing multiple filters of the same type by @LewisGaul in #635
• Add events method to stream Docker Compose events by @pietroagazzi in #676

New Contributors

• @pietroagazzi made their first contribution in #676

Full Changelog: v0.76.1...v0.77.0

What's Changed

• Fixed secrets and added tests by @gabrieldemarmiesse in #673
• Add support for multi-nodes on builders by @gabrieldemarmiesse in #674
• Fix secrets specs labels being capitalized by @gabrieldemarmiesse in #675

Breaking changes:

Some breaking changes were introduced in this version. Those are rarely used features but it might impact you.

python_on_whales.Builder:

• my_builder.status -> my_builder.nodes[0].status
• my_builder.platforms -> my_builder.nodes[0].platforms

python_on_whales.Secret:

• my_secret.spec["name"] -> my_secret.spec.name
• my_secret.spec["labels"] -> my_secret.spec.labels

Full Changelog: v0.75.1...v0.76.1

What's Changed

• Work around setuptools license file metadata issue by @rcwbr in #666

Full Changelog: v0.75.0...v0.75.1

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

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

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
• :writing_hand: 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
• :bug: 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
• :sparkles: 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
• :bug: 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
• :sparkles: 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
• :sparkles: 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
• :sparkles: Add stream_logs to docker.compose.down() by @gabrieldemarmiesse in https://github.com/gabrieldemarmiesse/python-on-whales/pull/496
• :sparkles: Added stream_logs to docker.compose.create() by @gabrieldemarmiesse in https://github.com/gabrieldemarmiesse/python-on-whales/pull/498
• :broom: 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

• :up: Bump minimum python version to 3.8 by @gabrieldemarmiesse in https://github.com/gabrieldemarmiesse/python-on-whales/pull/431
• :sparkles: Add more precise type hints for filters in docker.ps() by @gabrieldemarmiesse in https://github.com/gabrieldemarmiesse/python-on-whales/pull/432
• :sparkles: 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

• :bug: 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
• :up: 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

• :wrench: 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
• :up: Upgrade lint tools by @gabrieldemarmiesse in https://github.com/gabrieldemarmiesse/python-on-whales/pull/416
• :sparkles: Added new provenance options for docker.buildx.build() by @gabrieldemarmiesse in https://github.com/gabrieldemarmiesse/python-on-whales/pull/410
• :zap: Run some tests in parralel by @gabrieldemarmiesse in https://github.com/gabrieldemarmiesse/python-on-whales/pull/417
• :sparkles: 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

What's Changed

• Fix legacy build with podman when there is output on stderr by @LewisGaul in https://github.com/gabrieldemarmiesse/python-on-whales/pull/403
• Add __all__ to specify what * should import from the main module by @rafrafek in https://github.com/gabrieldemarmiesse/python-on-whales/pull/397
• return_stderr should be True for run method to return tuple by @rafrafek in https://github.com/gabrieldemarmiesse/python-on-whales/pull/399
• :up: Upgrade compose to 2.15.1 and buildx to 0.10.0 in the CI by @gabrieldemarmiesse in https://github.com/gabrieldemarmiesse/python-on-whales/pull/405
• Mark arguments with default value None as Optional by @rafrafek in https://github.com/gabrieldemarmiesse/python-on-whales/pull/406
• Add support for the --cgroupns arg by @LewisGaul in https://github.com/gabrieldemarmiesse/python-on-whales/pull/400

New Contributors

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

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

What's Changed

• fix: Constrain the minimum bound of pydantic. by @DanCardin in https://github.com/gabrieldemarmiesse/python-on-whales/pull/389
• Add docker context create command by @toxicphreAK in https://github.com/gabrieldemarmiesse/python-on-whales/pull/394

New Contributors

• @DanCardin made their first contribution in https://github.com/gabrieldemarmiesse/python-on-whales/pull/389
• @toxicphreAK made their first contribution in https://github.com/gabrieldemarmiesse/python-on-whales/pull/394

Full Changelog: https://github.com/gabrieldemarmiesse/python-on-whales/compare/v0.55.0...v0.56.0

What's Changed

• Implementing --pull flag for commands 'run' and 'create' and functions 'copy_from' and 'copy_to' (#369) by @MisterOwlPT in https://github.com/gabrieldemarmiesse/python-on-whales/pull/381
• Added support for --remove-orphans docker compose up flag by @bodo-ata in https://github.com/gabrieldemarmiesse/python-on-whales/pull/388

New Contributors

• @bodo-ata made their first contribution in https://github.com/gabrieldemarmiesse/python-on-whales/pull/388

Full Changelog: https://github.com/gabrieldemarmiesse/python-on-whales/compare/v0.54.0...v0.55.0

What's Changed

• Implemented "attach" command. by @MisterOwlPT in https://github.com/gabrieldemarmiesse/python-on-whales/pull/371
• Use separate status attributes for ComposeProject model by @marshall7m in https://github.com/gabrieldemarmiesse/python-on-whales/pull/377
• Implement manifest command by @raylas in https://github.com/gabrieldemarmiesse/python-on-whales/pull/378
• [IMP] "docker compose ps" argument services by @fuentes73 in https://github.com/gabrieldemarmiesse/python-on-whales/pull/383
• Fixed command for removing node labels by @NickG158 in https://github.com/gabrieldemarmiesse/python-on-whales/pull/385
• [IMP] docker compose run & up by @fuentes73 in https://github.com/gabrieldemarmiesse/python-on-whales/pull/386

New Contributors

• @raylas made their first contribution in https://github.com/gabrieldemarmiesse/python-on-whales/pull/378
• @fuentes73 made their first contribution in https://github.com/gabrieldemarmiesse/python-on-whales/pull/383
• @NickG158 made their first contribution in https://github.com/gabrieldemarmiesse/python-on-whales/pull/385

Full Changelog: https://github.com/gabrieldemarmiesse/python-on-whales/compare/v0.53.0...v0.54.0

What's Changed

• :sparkles: Add a quiet option to docker.compose.down() by @gabrieldemarmiesse in https://github.com/gabrieldemarmiesse/python-on-whales/pull/365
• implement docker compose port command by @vrazdalovschi in https://github.com/gabrieldemarmiesse/python-on-whales/pull/366
• Fix for Issue #370 - Replace on decode errors rather than surface UnicodeDecodeError by @magichair in https://github.com/gabrieldemarmiesse/python-on-whales/pull/372
• Switch from 'network list' to 'network ls' by @LewisGaul in https://github.com/gabrieldemarmiesse/python-on-whales/pull/374
• fix: cannot inspect node with empty leader status by @ahoetker-deca in https://github.com/gabrieldemarmiesse/python-on-whales/pull/376
• docker compose ls -> docker.compose.ls() by @marshall7m in https://github.com/gabrieldemarmiesse/python-on-whales/pull/368

New Contributors

• @vrazdalovschi made their first contribution in https://github.com/gabrieldemarmiesse/python-on-whales/pull/366
• @magichair made their first contribution in https://github.com/gabrieldemarmiesse/python-on-whales/pull/372
• @ahoetker-deca made their first contribution in https://github.com/gabrieldemarmiesse/python-on-whales/pull/376
• @marshall7m made their first contribution in https://github.com/gabrieldemarmiesse/python-on-whales/pull/368

Full Changelog: https://github.com/gabrieldemarmiesse/python-on-whales/compare/v0.52.0...v0.53.0

What's Changed

• Add the quiet flag to docker.compose.pull() by @gabrieldemarmiesse in https://github.com/gabrieldemarmiesse/python-on-whales/pull/363
• Allow single strings in docker.compose.up() and pull(), add quiet flag for up() by @gabrieldemarmiesse in https://github.com/gabrieldemarmiesse/python-on-whales/pull/364

Full Changelog: https://github.com/gabrieldemarmiesse/python-on-whales/compare/v0.51.1...v0.52.0

What's Changed

• Fix NetworkBindings parsing error by @betaboon in https://github.com/gabrieldemarmiesse/python-on-whales/pull/362

New Contributors

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

Full Changelog: https://github.com/gabrieldemarmiesse/python-on-whales/compare/v0.51.0...v0.51.1

What's Changed

• Change behavior of empty list as argument to some functions by @gabrieldemarmiesse in https://github.com/gabrieldemarmiesse/python-on-whales/pull/352
• Clarify the documentation about podman by @gabrieldemarmiesse in https://github.com/gabrieldemarmiesse/python-on-whales/pull/359
• Add arguments for docker.image.list() by @gabrieldemarmiesse in https://github.com/gabrieldemarmiesse/python-on-whales/pull/361

Full Changelog: https://github.com/gabrieldemarmiesse/python-on-whales/compare/v0.50.0...v0.51.0

What's Changed

• Fix image remove command by @LewisGaul in https://github.com/gabrieldemarmiesse/python-on-whales/pull/350
• Improve legacy build parsing of image ID by @LewisGaul in https://github.com/gabrieldemarmiesse/python-on-whales/pull/351
• Add fields 'platforms' and 'status' to Builder. by @MisterOwlPT in https://github.com/gabrieldemarmiesse/python-on-whales/pull/357

New Contributors

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

Full Changelog: https://github.com/gabrieldemarmiesse/python-on-whales/compare/v0.49...v0.50.0

What's Changed

• Allow to inspect exit_code and other info on exceptions by @juan-leon in https://github.com/gabrieldemarmiesse/python-on-whales/pull/342

New Contributors

• @juan-leon made their first contribution in https://github.com/gabrieldemarmiesse/python-on-whales/pull/342

Full Changelog: https://github.com/gabrieldemarmiesse/python-on-whales/compare/v0.47.0...v0.48.0

What's Changed

• [FEAT] Add Event API by @lonk95 in https://github.com/gabrieldemarmiesse/python-on-whales/pull/340
• 🐛 Fix docker.system.events() without filters by @gabrieldemarmiesse in https://github.com/gabrieldemarmiesse/python-on-whales/pull/341

New Contributors

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

Full Changelog: https://github.com/gabrieldemarmiesse/python-on-whales/compare/v0.46.0...v0.47.0

What's Changed

• Handle custom registry name when using ecr login by @a-gentilhomme in https://github.com/gabrieldemarmiesse/python-on-whales/pull/338

New Contributors

• @a-gentilhomme made their first contribution in https://github.com/gabrieldemarmiesse/python-on-whales/pull/338

Full Changelog: https://github.com/gabrieldemarmiesse/python-on-whales/compare/v0.45.0...v0.46.0

What's Changed

• :bug: Fix parsing of a podman container by @gabrieldemarmiesse in https://github.com/gabrieldemarmiesse/python-on-whales/pull/336
• :sparkles: Add more options to call the docker client by @gabrieldemarmiesse in https://github.com/gabrieldemarmiesse/python-on-whales/pull/337

Full Changelog: https://github.com/gabrieldemarmiesse/python-on-whales/compare/v0.44.0...v0.45.0

What's Changed

• :sparkles: Added support for other clients like podman and nerdctl by @gabrieldemarmiesse in https://github.com/gabrieldemarmiesse/python-on-whales/pull/329
• add --project-directory flag to compose by @John-Vash in https://github.com/gabrieldemarmiesse/python-on-whales/pull/332
• :bug: Fixed docker.network.disconnect() and add test by @gabrieldemarmiesse in https://github.com/gabrieldemarmiesse/python-on-whales/pull/333

New Contributors

• 🎉 @John-Vash made their first contribution in https://github.com/gabrieldemarmiesse/python-on-whales/pull/332

Full Changelog: https://github.com/gabrieldemarmiesse/python-on-whales/compare/v0.43.0...v0.44.0

What's Changed

• Add more docker run examples in the readme by @gabrieldemarmiesse in https://github.com/gabrieldemarmiesse/python-on-whales/pull/325
• :sparkles: Nice repr for all python_on_whales objects by @gabrieldemarmiesse in https://github.com/gabrieldemarmiesse/python-on-whales/pull/326

Full Changelog: https://github.com/gabrieldemarmiesse/python-on-whales/compare/v0.42.0...v0.43.0

What's Changed

• Force recent versions of typer by @gabrieldemarmiesse in https://github.com/gabrieldemarmiesse/python-on-whales/pull/320
• :sparkles: Add more options to docker.compose.build() by @gabrieldemarmiesse in https://github.com/gabrieldemarmiesse/python-on-whales/pull/323

Full Changelog: https://github.com/gabrieldemarmiesse/python-on-whales/compare/v0.41.0...v0.42.0

What's Changed

• :bug: Fix bug with typer import crashing by @gabrieldemarmiesse in https://github.com/gabrieldemarmiesse/python-on-whales/pull/318

This will pink click to 8.0.4 and below. We'll make a new release later with an upgraded version of typer that doesn't have this issue.

Full Changelog: https://github.com/gabrieldemarmiesse/python-on-whales/compare/v0.40.0...v0.41.0

What's Changed

• Add flags to docker compose pull by @joshkarlin in https://github.com/gabrieldemarmiesse/python-on-whales/pull/314
• Task/add boolean to run docker compose in compatibility mode by @joshkarlin in https://github.com/gabrieldemarmiesse/python-on-whales/pull/315
• :wrench: Output of docker.image.prune() is returned, more types by @gabrieldemarmiesse in https://github.com/gabrieldemarmiesse/python-on-whales/pull/316

New Contributors

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

Full Changelog: https://github.com/gabrieldemarmiesse/python-on-whales/compare/v0.39.0...v0.40.0

What's Changed

• capturing stdout and stderr for docker volume prune by @dvizzini in https://github.com/gabrieldemarmiesse/python-on-whales/pull/311
• :sparkles: Add docker.compose.execute(...) by @gabrieldemarmiesse in https://github.com/gabrieldemarmiesse/python-on-whales/pull/312

Full Changelog: https://github.com/gabrieldemarmiesse/python-on-whales/compare/v0.38.0...v0.39.0

What's Changed

• Add project_urls by @wannaphong in https://github.com/gabrieldemarmiesse/python-on-whales/pull/309
• handling filter option uniformly by @dvizzini in https://github.com/gabrieldemarmiesse/python-on-whales/pull/308

New Contributors

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

Full Changelog: https://github.com/gabrieldemarmiesse/python-on-whales/compare/v0.37.0...v0.38.0

What's Changed

• Fix system prune hang by @dvizzini in https://github.com/gabrieldemarmiesse/python-on-whales/pull/307
• Adding filter to system prune by @dvizzini in https://github.com/gabrieldemarmiesse/python-on-whales/pull/306

New Contributors

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

Full Changelog: https://github.com/gabrieldemarmiesse/python-on-whales/compare/v0.36.1...v0.37.0

What's Changed

• :bug: Fix docker.service.list() when there are no services by @gabrieldemarmiesse in https://github.com/gabrieldemarmiesse/python-on-whales/pull/303

Full Changelog: https://github.com/gabrieldemarmiesse/python-on-whales/compare/v0.36.0...v0.36.1

What's Changed

• :zap: Faster docker.service.list() by @gabrieldemarmiesse in https://github.com/gabrieldemarmiesse/python-on-whales/pull/301

Full Changelog: https://github.com/gabrieldemarmiesse/python-on-whales/compare/v0.35.0...v0.36.0

What's Changed

• Some precisions concerning compose v2 in the docs by @gabrieldemarmiesse in https://github.com/gabrieldemarmiesse/python-on-whales/pull/296
• Added a function to check if the CLI is already on the host by @gabrieldemarmiesse in https://github.com/gabrieldemarmiesse/python-on-whales/pull/297
• Add compose_profiles argument to the docker client constructor by @gabrieldemarmiesse in https://github.com/gabrieldemarmiesse/python-on-whales/pull/298

Full Changelog: https://github.com/gabrieldemarmiesse/python-on-whales/compare/v0.34.0...v0.35.0

What's Changed

• Fix typo 'lenght' in property names by @martinburchell in https://github.com/gabrieldemarmiesse/python-on-whales/pull/291

New Contributors

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

Full Changelog: https://github.com/gabrieldemarmiesse/python-on-whales/compare/v0.33.0...v0.34.0

What's Changed

• Enable labeling networks in network create by @Akshay04 in https://github.com/gabrieldemarmiesse/python-on-whales/pull/284
• Set threads in stream_stdout_and_stderr as daemons to avoid blocking ctrl+c by @mdantonio in https://github.com/gabrieldemarmiesse/python-on-whales/pull/283
• Allow the publishing of a random port on host by @gabrieldemarmiesse in https://github.com/gabrieldemarmiesse/python-on-whales/pull/288
• Fix return type of compose.run() by @gabrieldemarmiesse in https://github.com/gabrieldemarmiesse/python-on-whales/pull/289

New Contributors

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

Full Changelog: https://github.com/gabrieldemarmiesse/python-on-whales/compare/v0.32.0...v0.33.0

What's Changed

• Added compose logs by @mdantonio in https://github.com/gabrieldemarmiesse/python-on-whales/pull/282

Full Changelog: https://github.com/gabrieldemarmiesse/python-on-whales/compare/v0.31.0...v0.32.0

What's Changed

• Fixed compose.restart by adding services and made timeout parameter optional by @mdantonio in https://github.com/gabrieldemarmiesse/python-on-whales/pull/278
• Added pre-commit configuration by @mdantonio in https://github.com/gabrieldemarmiesse/python-on-whales/pull/279
• Just fixed a simple typo by @mdantonio in https://github.com/gabrieldemarmiesse/python-on-whales/pull/281
• Added stream option to docker.compose.run and fixed the tty flag by @mdantonio in https://github.com/gabrieldemarmiesse/python-on-whales/pull/280

Full Changelog: https://github.com/gabrieldemarmiesse/python-on-whales/compare/v0.30.0...v0.31.0

What's Changed

• ✨ Add docker.compose.restart() by @gabrieldemarmiesse in https://github.com/gabrieldemarmiesse/python-on-whales/pull/268
• ✨ Added an explanation about docker compose image by @gabrieldemarmiesse in https://github.com/gabrieldemarmiesse/python-on-whales/pull/269
• :sparkles: Add docker.compose.start() by @gabrieldemarmiesse in https://github.com/gabrieldemarmiesse/python-on-whales/pull/270
• Fix links in the readme when the page is read from github by @gabrieldemarmiesse in https://github.com/gabrieldemarmiesse/python-on-whales/pull/273
• Declare new userguide: Running python-on-whales in a container by @gabrieldemarmiesse in https://github.com/gabrieldemarmiesse/python-on-whales/pull/275

Full Changelog: https://github.com/gabrieldemarmiesse/python-on-whales/compare/v0.29.0...v0.30.0

What's Changed

• Added the stream option to docker.execute() by @gabrieldemarmiesse in https://github.com/gabrieldemarmiesse/python-on-whales/pull/258
• Fix typos. Mainly adress -> address by @gabrieldemarmiesse in https://github.com/gabrieldemarmiesse/python-on-whales/pull/262
• Replaced string in the tests by @gabrieldemarmiesse in https://github.com/gabrieldemarmiesse/python-on-whales/pull/264
• ✨ Get the compose version with docker.compose.version() by @gabrieldemarmiesse in https://github.com/gabrieldemarmiesse/python-on-whales/pull/265
• Added doc explaining how to run python-on-whales in a container by @gabrieldemarmiesse in https://github.com/gabrieldemarmiesse/python-on-whales/pull/261

Full Changelog: https://github.com/gabrieldemarmiesse/python-on-whales/compare/v0.28.0...v0.29.0