Merge remote-tracking branch 'github/main'

Author: Josephrp

.github/.release-please-manifest.json

@@ -1,3 +1,3 @@
 {
-    ".": "4.6.0"
+    ".": "4.7.2"
 }

.github/CONTRIBUTING.md

@@ -0,0 +1,82 @@
+# Contributing to `testcontainers-python`
+
+Welcome to the `testcontainers-python` community!
+This should give you an idea about how we build, test and release `testcontainers-python`!
+
+Highly recommended to read this document thoroughly to understand what we're working on right now
+and what our priorities are before you are trying to contribute something.
+
+This will greatly increase your chances of getting prompt replies as the maintainers are volunteers themselves.
+
+## Before you Begin
+
+We recommend following these steps:
+
+1. Finish reading this document.
+2. Read the [recently updated issues][1]
+3. Look for existing issues on the subject you are interested in - we do our best to label everything correctly
+
+
+## Local Development
+
+### Pre-Requisites
+
+You need to have the following tools available to you:
+- `make` - You'll need a GNU Make for common developer activities
+- `poetry` - This is the primary package manager for the project
+- `pyenv` **Recommended**: For installing python versions for your system.
+  Poetry infers the current latest version from what it can find on the `PATH` so you are still fine if you don't use `pyenv`.
+
+### Build and test
+
+
+- Run `make install` to get `poetry` to install all dependencies and set up `pre-commit`
+  - **Recommended**: Run `make` or `make help` to see other commands available to you.
+- After this, you should have a working virtual environment and proceed with writing code with your favourite IDE
+- **TIP**: You can run `make core/tests` or `make module/<my-module>/tests` to run the tests specifically for that to speed up feedback cycles
+- You can also run `make lint` to run the `pre-commit` for the entire codebase.
+
+
+## Adding new containers
+
+We have an [issue template](.github/ISSUE_TEMPLATE/new-container.md) for adding new containers, please refer to that for more information.
+Once you've talked to the maintainers (we do our best to reply!) then you can proceed with contributing the new container.
+
+> [!WARNING]
+> PLease raise an issue before you try to contribute a new container! It helps maintainers understand your use-case and motivation.
+> This way we can keep pull requests foruced on the "how", not the "why"! :pray:
+> It also gives maintainers a chance to give you last-minute guidance on caveats or expectations, particularly with
+> new extra dependencies and how to manage them.
+
+
+## Raising Issues
+
+We have [Issue Templates][2] to cover most cases, please try to adhere to them, they will guide you through the process.
+Try to look through the existing issues before you raise a new one.
+
+
+## Releasing Versions
+
+We have automated Semantic Versioning and release via [release-please](workflows/release-please.yml).
+This takes care of:
+- Detecting the next version, based on the commits that landed on `main`
+- When a Release PR has been merged
+  - Create a GitHub Release with the CHANGELOG included
+  - Update the [CHANGELOG](../CHANGELOG.md), similar to the GitHub Release
+  - Release to PyPI via a [trusted publisher](https://docs.pypi.org/trusted-publishers/using-a-publisher/)
+  - Automatically script updates in files where it's needed instead of hand-crafting it (i.e. in `pyproject.toml`)
+
+> [!CRITICAL]
+> Community modules are supported on a best-effort basis and for maintenance reasons, any change to them
+> is only covered under minor and patch changes.
+>
+> Community modules changes DO NOT contribute to major version changes!
+>
+> If your community module container was broken by a minor or patch version change, check out the change logs!
+
+# Thank you!
+
+Thanks for reading, feedback on documentation is always welcome!
+
+[1]: https://github.com/testcontainers/testcontainers-python/issues?q=is%3Aissue+is%3Aopen+sort%3Aupdated-desc "Recently Updated Issues showing you what we're focusing on"
+[2]: https://github.com/testcontainers/testcontainers-python/issues/new/choose "List of current issue templates, please use them"

.github/ISSUE_TEMPLATE/new-container.md

@@ -0,0 +1,26 @@
+---
+name: New Container
+about: Tell the Testcontainers-Python team about a container you'd like to have support for.
+title: 'New Container: '
+labels: '🚀 enhancement'
+assignees: ''
+
+---
+
+<!-- feel free to remove any irrelevant section(s) below -->
+
+**What is the new container you'd like to have?**
+
+Please link some docker containers as well as documentation/arguments to the benefits of having this container.
+
+**Why not just use a generic container for this?**
+
+Please describe why the `DockerContainer("my-image:latest")` approach is not useful enough.
+
+Having a dedicated `TestContainer` usually means the need for some or all of these:
+- complicated setup/configuration
+- the wait strategy is complex for the container, usually more than just an http wait
+
+**Other references:**
+
+Include any other relevant reading material about the enhancement.

.github/ISSUE_TEMPLATE/question.md

@@ -9,27 +9,33 @@ assignees: ''
 
 <!-- feel free to remove any irrelevant section(s) below -->
 
-**What are you trying to do?**
+## What are you trying to do?
 
 Ask your question here
 
-**Where are you trying to do it?**
+## Where are you trying to do it?
 
 Provide a self-contained code snippet that illustrates the bug or unexpected behavior.
 Ideally, include a link to a public repository with a minimal project where someone from the
 testcontainers-python can submit a PR with a solution to the problem you are facing with the library.
 
-**Runtime environment**
+## Runtime environment
 
-Provide a summary of your runtime environment. Which operating system, python version, and docker version are you using? What is the version of `testcontainers-python` you are using? You can run the following commands to get the relevant information.
+Provide a summary of your runtime environment. Which operating system, python version, and docker version are you using?
+What is the version of `testcontainers-python` you are using? You can run the following commands to get the relevant information.
+
+Paste the results of the bash below
+
+```bash
+uname -a
+echo "------"
+docker info
+echo "------"
+poetry run python --version
+echo "------"
+poetry show --tree
+```
 
 ```bash
-# Get the operating system information (on a unix os).
-$ uname -a
-# Get the python version.
-$ python --version
-# Get the docker version and other docker information.
-$ docker info
-# Get all python packages.
-$ pip freeze
+paste-me-here
 ```

.github/PULL_REQUEST_TEMPLATE/new_container.md

@@ -1,8 +1,44 @@
-You have implemented a new container and would like to contribute it? Great! Here are the necessary steps.
-
-- [ ] Create a new feature directory and populate it with the package structure [described in the documentation](https://testcontainers-python.readthedocs.io/en/latest/#package-structure). Copying one of the existing features is likely the best way to get started.
-- [ ] Implement the new feature (typically in `__init__.py`) and corresponding tests.
-- [ ] Update the feature `README.rst` and add it to the table of contents (`toctree` directive) in the top-level `README.rst`.
-- [ ] Add a line `[feature name]` to the list of components in the  GitHub Action workflow in `.github/workflows/main.yml` to run tests, build, and publish your package when pushed to the `main` branch.
-- [ ] Rebase your development branch on `main` (or merge `main` into your development branch).
-- [ ] Add a line `-e file:[feature name]` to `requirements.in` and open a pull request. Opening a pull request will automatically generate lock files to ensure reproducible builds (see the [pip-tools documentation](https://pip-tools.readthedocs.io/en/latest/) for details). Finally, run `python get_requirements.py --pr=[your PR number]` to fetch the updated requirement files (the build needs to have succeeded).
+# New Container
+
+<!-- You have implemented a new container and would like to contribute it? Great! Here are the necessary checklist steps. -->
+
+Fixes ...
+
+<!--
+Please do not raise a PR for new container without having raised an issue first.
+It helps reduce unnecessary work for you and the maintainers!
+-->
+
+
+# PR Checklist
+
+- [ ] Your PR title follows the [Conventional Commits](https://www.conventionalcommits.org/en/v1.0.0/) syntax
+  as we make use of this for detecting Semantic Versioning changes.
+  - Additions to the community modules do not contribute to SemVer scheme:
+    all community features will be tagged [community-feat](https://github.com/testcontainers/testcontainers-python/issues?q=label%3Acommunity-feat+),
+    but we do not want to release minor or major versions due to features or breaking changes outside of core.
+    So please use `fix(postgres):` or `fix(my_new_vector_db):` if you want to add or modify community modules.
+    This may change in the future if we have a separate package released with community modules.
+- [ ] Your PR allows maintainers to edit your branch, this will speed up resolving minor issues!
+- [ ] The new container is implemented under `modules/*`
+  - Your module follows [PEP 420](https://peps.python.org/pep-0420/) with implicit namespace packages
+    (if unsure, look at other existing community modules)
+  - Your package namespacing follows `testcontainers.<modulename>.*`
+    and you DO NOT have an `__init__.py` above your module's level.
+  - Your module has its own tests under `modules/*/tests`
+  - Your module has a `README.rst` and hooks in the `.. auto-class` and `.. title` of your container
+  - Implement the new feature (typically in `__init__.py`) and corresponding tests.
+- [ ] Your module is added in `pyproject.toml`
+  - it is declared under `tool.poetry.packages` - see other community modules
+  - it is declared under `tool.poetry.extras` with the same name as your module name,
+    we still prefer adding _NO EXTRA DEPENDENCIES_, meaning `mymodule = []` is the preferred addition
+    (see the notes at the bottom)
+- [ ] Your branch is up-to-date (or your branch will be rebased with `git rebase`)
+
+# Preferred implementation
+
+- The current consensus among maintainers is to try to avoid enforcing the client library
+  for the given tools you are triyng to implement.
+- This means we want you to avoid adding specific libraries as dependencies to `testcontainers`.
+- Therefore, you should implement the configuration and the waiting with as little extra as possible
+- You may still find it useful to add your preferred client library as a dev dependency

.github/settings.yml

@@ -71,13 +71,15 @@ labels:
   - { name: '📦 package: google',        color: '#0052CC', description: '' }
   - { name: '📦 package: kafka',         color: '#0052CC', description: '' }
   - { name: '📦 package: keycloak',      color: '#0052CC', description: '' }
+  - { name: '📦 package: mailpit',       color: '#0052CC', description: '' }
   - { name: '📦 package: mongodb',       color: '#0052CC', description: '' }
   - { name: '📦 package: mssql',         color: '#0052CC', description: '' }
   - { name: '📦 package: neo4j',         color: '#0052CC', description: '' }
   - { name: '📦 package: oracle',        color: '#0052CC', description: '' }
   - { name: '📦 package: postgres',      color: '#0052CC', description: '' }
   - { name: '📦 package: rabbitmq',      color: '#0052CC', description: '' }
   - { name: '📦 package: selenium',      color: '#0052CC', description: '' }
+  - { name: '📦 package: sftp',          color: '#0052CC', description: '' }
   - { name: '🔀 requires triage',        color: '#bfdadc', description: '' }
   - { name: '🔧 maintenance',            color: '#c2f759', description: '' }
   - { name: '🚀 enhancement',            color: '#84b6eb', description: '' }

CHANGELOG.md

@@ -1,5 +1,49 @@
 # Changelog
 
+## [4.7.2](https://github.com/testcontainers/testcontainers-python/compare/testcontainers-v4.7.1...testcontainers-v4.7.2) (2024-07-15)
+
+
+### Bug Fixes
+
+* Add container Trino ([#642](https://github.com/testcontainers/testcontainers-python/issues/642)) ([49ce5a5](https://github.com/testcontainers/testcontainers-python/commit/49ce5a5ff2ac46cf51920e16c5e39684886b699a)), closes [#641](https://github.com/testcontainers/testcontainers-python/issues/641)
+* **core:** Improve private registry support (tolerate not implemented fields in DOCKER_AUTH_CONFIG) ([#647](https://github.com/testcontainers/testcontainers-python/issues/647)) ([766c382](https://github.com/testcontainers/testcontainers-python/commit/766c382a3aee4eb512ee0f482d6595d3412097c3))
+* **kafka:** add a flag to limit to first hostname for use with networks ([#638](https://github.com/testcontainers/testcontainers-python/issues/638)) ([0ce4fec](https://github.com/testcontainers/testcontainers-python/commit/0ce4fecb2872620fd4cb96313abcba4353442cfd)), closes [#637](https://github.com/testcontainers/testcontainers-python/issues/637)
+* **modules:** Mailpit container base API URL helper method ([#643](https://github.com/testcontainers/testcontainers-python/issues/643)) ([df07586](https://github.com/testcontainers/testcontainers-python/commit/df07586d8844c757db62ac0f8b7914c67fd96e05))
+
+## [4.7.1](https://github.com/testcontainers/testcontainers-python/compare/testcontainers-v4.7.0...testcontainers-v4.7.1) (2024-07-02)
+
+
+### Bug Fixes
+
+* **core:** bad rebase from [#579](https://github.com/testcontainers/testcontainers-python/issues/579) ([#635](https://github.com/testcontainers/testcontainers-python/issues/635)) ([4766e48](https://github.com/testcontainers/testcontainers-python/commit/4766e4829407c19de039effc7ea8fcc8b6dcc214))
+* **modules:** Mailpit Container ([#625](https://github.com/testcontainers/testcontainers-python/issues/625)) ([0b866ff](https://github.com/testcontainers/testcontainers-python/commit/0b866ff3c2d462fa5032945dfa2efd4bd59079da))
+* **modules:** SFTP Server Container ([#629](https://github.com/testcontainers/testcontainers-python/issues/629)) ([2e7dbf1](https://github.com/testcontainers/testcontainers-python/commit/2e7dbf1185c68c7cbfb6bdac7457d1d5f86aba19))
+* **network:** Now able to use Network without context, and has labels to be automatically cleaned up ([#627](https://github.com/testcontainers/testcontainers-python/issues/627)) ([#630](https://github.com/testcontainers/testcontainers-python/issues/630)) ([e93bc29](https://github.com/testcontainers/testcontainers-python/commit/e93bc29c1781c4e73840c4c587160f8e5805feea))
+* **postgres:** get_connection_url(driver=None) should return postgres://... ([#588](https://github.com/testcontainers/testcontainers-python/issues/588)) ([01d6c18](https://github.com/testcontainers/testcontainers-python/commit/01d6c182485555ee83f560739c34f089b0e54e0b)), closes [#587](https://github.com/testcontainers/testcontainers-python/issues/587)
+* update test module import ([#623](https://github.com/testcontainers/testcontainers-python/issues/623)) ([16f6ca4](https://github.com/testcontainers/testcontainers-python/commit/16f6ca42621866d8ff87ca539a84da27dbe9a4c4))
+
+## [4.7.0](https://github.com/testcontainers/testcontainers-python/compare/testcontainers-v4.6.0...testcontainers-v4.7.0) (2024-06-28)
+
+
+### Features
+
+* **core:** Add support for ollama module ([#618](https://github.com/testcontainers/testcontainers-python/issues/618)) ([5442d05](https://github.com/testcontainers/testcontainers-python/commit/5442d054cb8bc11887e09d24e29d9f91dd943307))
+* **core:** Added Generic module ([#612](https://github.com/testcontainers/testcontainers-python/issues/612)) ([e575b28](https://github.com/testcontainers/testcontainers-python/commit/e575b28da912147c5b806abab40a0c92329e2eb7))
+* **core:** allow custom dockerfile path for image build and bypassing build cache ([#615](https://github.com/testcontainers/testcontainers-python/issues/615)) ([ead0f79](https://github.com/testcontainers/testcontainers-python/commit/ead0f797902a94d3b2558e489fe2a0a55c3bb7ad)), closes [#610](https://github.com/testcontainers/testcontainers-python/issues/610)
+* **core:** DockerCompose.stop now stops only services that it starts (does not stop the other services) ([#620](https://github.com/testcontainers/testcontainers-python/issues/620)) ([e711800](https://github.com/testcontainers/testcontainers-python/commit/e71180039441e3c7d49467298ef0f498fe786149))
+
+
+### Bug Fixes
+
+* **cosmosdb:** Add support for the CosmosDB Emulator ([#579](https://github.com/testcontainers/testcontainers-python/issues/579)) ([8045a80](https://github.com/testcontainers/testcontainers-python/commit/8045a806fcb6908567339a14f2f0d7a169461675))
+* improve ollama docs, s/ollama_dir/ollama_home/g ([#619](https://github.com/testcontainers/testcontainers-python/issues/619)) ([27f2a6b](https://github.com/testcontainers/testcontainers-python/commit/27f2a6bdca8b9c860a96920eebc96f53682ea750))
+* **kafka:** Add Kraft to Kafka containers ([#611](https://github.com/testcontainers/testcontainers-python/issues/611)) ([762d2a2](https://github.com/testcontainers/testcontainers-python/commit/762d2a2130f7ce17dacaed5a96a6898a08cf2bc5))
+
+
+### Documentation
+
+* **contributing:** add contribution and new-container guide  ([#460](https://github.com/testcontainers/testcontainers-python/issues/460)) ([3519f4b](https://github.com/testcontainers/testcontainers-python/commit/3519f4bdad6eac6c172977303b51cf52b4fa4c04))
+
 ## [4.6.0](https://github.com/testcontainers/testcontainers-python/compare/testcontainers-v4.5.1...testcontainers-v4.6.0) (2024-06-18)
 
 

Dockerfile

@@ -1,13 +1,16 @@
-ARG version=3.8
-FROM python:${version}
+ARG PYTHON_VERSION
+FROM python:${version}-slim-bookworm
 
 WORKDIR /workspace
 RUN pip install --upgrade pip \
     && apt-get update \
     && apt-get install -y \
         freetds-dev \
     && rm -rf /var/lib/apt/lists/*
+
+# install requirements we exported from poetry
 COPY build/requirements.txt requirements.txt
-COPY setup.py README.rst ./
 RUN pip install -r requirements.txt
+
+# copy project source
 COPY . .