.devcontainer/commands/post-create-command.sh

@@ -0,0 +1,5 @@
+echo "Running post-create-command.sh"
+
+curl -sSL https://install.python-poetry.org | python3 -
+
+poetry install --all-extras

.devcontainer/devcontainer.json

@@ -0,0 +1,35 @@
+// For format details, see https://aka.ms/devcontainer.json. For config options, see the
+// README at: https://github.com/devcontainers/templates/tree/main/src/python
+{
+	"name": "Python 3",
+	// Or use a Dockerfile or Docker Compose file. More info: https://containers.dev/guide/dockerfile
+	"image": "mcr.microsoft.com/devcontainers/python:1-3.11-bookworm",
+	"features": {
+		"ghcr.io/devcontainers/features/docker-in-docker:2": {
+			"version": "latest",
+			"dockerDashComposeVersion": "v2"
+		}
+	},
+
+	// Features to add to the dev container. More info: https://containers.dev/features.
+	// "features": {},
+
+	// Use 'forwardPorts' to make a list of ports inside the container available locally.
+	// "forwardPorts": [],
+
+	// Use 'postCreateCommand' to run commands after the container is created.
+	"postCreateCommand": ".devcontainer/commands/post-create-command.sh",
+	"customizations": {
+		"vscode": {
+			"extensions": [
+				"ms-python.python"
+			]
+		}
+	}
+
+	// Configure tool-specific properties.
+	// "customizations": {},
+
+	// Uncomment to connect as root instead. More info: https://aka.ms/dev-containers-non-root.
+	// "remoteUser": "root"
+}

.github/.release-please-manifest.json

@@ -0,0 +1,3 @@
+{
+    ".": "4.0.0"
+}

.github/ISSUE_TEMPLATE/bug-or-unexpected-behavior.md

@@ -0,0 +1,35 @@
+---
+name: Bug or unexpected behavior
+about: Create a report to help us improve.
+title: 'Bug: '
+labels: bug
+assignees: ''
+
+---
+
+**Describe the bug**
+
+A clear and concise description of what the bug is. What did you expect to happen? What happened instead?
+
+**To Reproduce**
+
+Provide a self-contained code snippet that illustrates the bug or unexpected behavior. Ideally, send a Pull Request to illustrate with a test that illustrates the problem.
+
+```python
+raise RuntimeError("something went wrong")
+```
+
+**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.
+
+```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
+```

.github/ISSUE_TEMPLATE/feature-proposal.md

@@ -0,0 +1,22 @@
+---
+name: Feature Proposal
+about: Send a note to the tc-python team about something you would like to see changed or improved.
+title: 'Feature: '
+labels: '🚀 enhancement'
+assignees: ''
+
+---
+
+<!-- feel free to remove any irrelevant section(s) below -->
+
+**What are you trying to do?**
+
+Describe the intention of the enhancement.
+
+**Why should it be done this way?**
+
+Describe the motivation of the enhancement.
+
+**Other references:**
+
+Include any other relevant reading material about the enhancement.

.github/ISSUE_TEMPLATE/question.md

@@ -0,0 +1,35 @@
+---
+name: Question
+about: Ask a question about how to use this library.
+title: 'Question: '
+labels: '📖 documentation'
+assignees: ''
+
+---
+
+<!-- feel free to remove any irrelevant section(s) below -->
+
+**What are you trying to do?**
+
+Ask your question here
+
+**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**
+
+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.
+
+```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
+```

.github/PULL_REQUEST_TEMPLATE/new_container.md

@@ -1,9 +1,8 @@
-You have implemented a new container and would like to contribute it? Great! Here are the necessary steps:
+You have implemented a new container and would like to contribute it? Great! Here are the necessary steps.
 
-- [ ] You have added the new container as a module in the `testcontainers` directory (such as `testcontainers/my_fancy_container.py`).
-- [ ] You have added any new python dependencies in the `extras_require` section of `setup.py`.
-- [ ] You have added the `extra_requires` key to `requirements.in`.
-- [ ] You have updated all python requirements by running `make requirements` from the root directory.
-- [ ] You have added tests for the new container in the `tests` directory, e.g. `tests/test_my_fancy_container.py`.
-- [ ] You have added the name of the container (such as `my_fancy_container`) to the `test-components` matrix in `.github/workflows/main.yml` to ensure the tests are run.
-- [ ] You have rebased your development branch on `master` (or merged `master` into your development branch).
+- [ ] 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).

.github/actions/setup-env/action.yml

@@ -0,0 +1,20 @@
+name: setup-env
+description: set up the python environment
+
+inputs:
+  python-version:
+    description: "The python version to install and use"
+    default: "3.12"  # we default to latest supported
+    required: false
+
+runs:
+  using: composite
+  steps:
+    - name: Setup Poetry
+      run: pipx install poetry
+      shell: bash
+    - name: Setup python ${{ inputs.python-version }}
+      uses: actions/setup-python@v5
+      with:
+        python-version: ${{ inputs.python-version }}
+        cache: poetry

.github/release-please-config.json

@@ -0,0 +1,10 @@
+{
+    "release-type": "python",
+    "bootstrap-sha": "28e3a471c32c1036dd5e37df13cdde3b1ba91000",
+    "packages": {
+        ".": {
+            "package-name": "testcontainers"
+        }
+    },
+    "$schema": "https://raw.githubusercontent.com/googleapis/release-please/main/schemas/config.json"
+}

.github/settings.yml

@@ -0,0 +1,152 @@
+# These settings are synced to GitHub by https://probot.github.io/apps/settings/
+
+repository:
+  # See https://docs.github.com/en/rest/reference/repos#update-a-repository for all available settings.
+
+  # The name of the repository. Changing this will rename the repository
+  name: testcontainers-python
+
+  # A short description of the repository that will show up on GitHub
+  description: "Python library that providing a friendly API to run Docker containers when from tests."
+
+  # A URL with more information about the repository
+  homepage: https://testcontainers-python.readthedocs.io/en/latest
+
+  # A comma-separated list of topics to set on the repository
+  topics: database,python,python3,selenium,testcontainers,testing
+
+  # Either `true` to make the repository private, or `false` to make it public.
+  private: false
+
+  # Either `true` to enable issues for this repository, `false` to disable them.
+  has_issues: true
+
+  # Either `true` to enable projects for this repository, or `false` to disable them.
+  # If projects are disabled for the organization, passing `true` will cause an API error.
+  has_projects: false
+
+  # Either `true` to enable the wiki for this repository, `false` to disable it.
+  has_wiki: false
+
+  # Either `true` to enable downloads for this repository, `false` to disable them.
+  has_downloads: true
+
+  # Updates the default branch for this repository.
+  default_branch: main
+
+  # Either `true` to allow squash-merging pull requests, or `false` to prevent
+  # squash-merging.
+  allow_squash_merge: true
+
+  # Either `true` to allow merging pull requests with a merge commit, or `false`
+  # to prevent merging pull requests with merge commits.
+  allow_merge_commit: false
+
+  # Either `true` to allow rebase-merging pull requests, or `false` to prevent
+  # rebase-merging.
+  allow_rebase_merge: false
+
+  # Either `true` to enable automatic deletion of branches on merge, or `false` to disable
+  delete_branch_on_merge: true
+
+# Labels: define labels for Issues and Pull Requests
+# If including a `#`, make sure to wrap it with quotes!
+labels:
+  - { name: '⛔ invalid',                color: '#e6e6e6', description: '' }
+  - { name: 'dependencies',             color: '#0366d6', description: 'Pull requests that update a dependency file' }
+  - { name: 'good first issue',         color: '#1C49A0', description: '' }
+  - { name: '✅ close on merge',         color: '#0E8A16', description: 'Issue that will be closed by an open pull request' }
+  - { name: '✨ package: new',           color: '#0E8A16', description: '' }
+  - { name: '❓ question',               color: '#cc317c', description: '' }
+  - { name: '🍏 macos',                  color: '#C5BF0',, description: '' }
+  - { name: '🐛 bug',                    color: '#ee001',, description: '' }
+  - { name: '🐧 linux',                  color: '#3ED4D',, description: '' }
+  - { name: '👀 requires attention',     color: '#fef2c0', description: '' }
+  - { name: '📖 documentation',          color: '#d93f0b', description: '' }
+  - { name: '📦 package: clickhouse',    color: '#0052CC', description: '' }
+  - { name: '📦 package: compose',       color: '#0052CC', description: '' }
+  - { name: '📦 package: core',          color: '#0052CC', description: '' }
+  - { name: '📦 package: elasticsearch', color: '#0052CC', description: '' }
+  - { name: '📦 package: google',        color: '#0052CC', description: '' }
+  - { name: '📦 package: kafka',         color: '#0052CC', description: '' }
+  - { name: '📦 package: keycloak',      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: '🔀 requires triage',        color: '#bfdadc', description: '' }
+  - { name: '🔧 maintenance',            color: '#c2f759', description: '' }
+  - { name: '🚀 enhancement',            color: '#84b6eb', description: '' }
+  - { name: '🚫 wontfix',                color: '#ffffff', description: '' }
+  - { name: '🛟 help wanted',            color: '#128A0C', description: '' }
+
+# Collaborators: give specific users access to this repository.
+# See https://docs.github.com/en/rest/reference/repos#add-a-repository-collaborator for available options
+collaborators:
+  - username: totallyzen
+    permission: maintain
+  - username: alexanderankin
+    permission: maintain
+  - username: kiview
+    permission: admin
+  #- username: testcontainersbot
+  #  permission: write
+
+  # Note: `permission` is only valid on organization-owned repositories.
+  # The permission to grant the collaborator. Can be one of:
+  # * `pull` - can pull, but not push to or administer this repository.
+  # * `push` - can pull and push, but not administer this repository.
+  # * `admin` - can pull, push and administer this repository.
+  # * `maintain` - Recommended for project managers who need to manage the repository without access to sensitive or destructive actions.
+  # * `triage` - Recommended for contributors who need to proactively manage issues and pull requests without write access.
+
+# See https://docs.github.com/en/rest/reference/teams#add-or-update-team-repository-permissions for available options
+teams:
+  # Please make sure the team already exist in the organization, as the repository-settings application is not creating them.
+  # See https://github.com/repository-settings/app/discussions/639 for more information about teams and settings
+  # - name: go-team
+  #   # The permission to grant the team. Can be one of:
+  #   # * `pull` - can pull, but not push to or administer this repository.
+  #   # * `push` - can pull and push, but not administer this repository.
+  #   # * `admin` - can pull, push and administer this repository.
+  #   # * `maintain` - Recommended for project managers who need to manage the repository without access to sensitive or destructive actions.
+  #   # * `triage` - Recommended for contributors who need to proactively manage issues and pull requests without write access.
+  #   permission: admin
+  - name: oss-maintainers
+    permission: admin
+
+branches:
+  - name: main
+    # https://docs.github.com/en/rest/reference/repos#update-branch-protection
+    # Branch Protection settings. Set to null to disable
+    protection:
+      # Required. Require at least one approving review on a pull request, before merging. Set to null to disable.
+      required_pull_request_reviews:
+        # The number of approvals required. (1-6)
+        required_approving_review_count: 1
+        # Dismiss approved reviews automatically when a new commit is pushed.
+        dismiss_stale_reviews: false
+        # Blocks merge until code owners have reviewed.
+        require_code_owner_reviews: false
+        # Specify which users and teams can dismiss pull request reviews. Pass an empty dismissal_restrictions object to disable. User and team dismissal_restrictions are only available for organization-owned repositories. Omit this parameter for personal repositories.
+        dismissal_restrictions:
+          users: []
+          teams: [] # [go-team]
+      # Required. Require status checks to pass before merging. Set to null to disable
+      required_status_checks:
+        # Required. Require branches to be up to date before merging.
+        strict: true
+        # Required. The list of status checks to require in order to merge into this branch
+        contexts: ["core"]
+      # Required. Enforce all configured restrictions for administrators. Set to true to enforce required status checks for repository administrators. Set to null to disable.
+      enforce_admins: false
+      # Prevent merge commits from being pushed to matching branches
+      required_linear_history: true
+      # Required. Restrict who can push to this branch. Team and user restrictions are only available for organization-owned repositories. Set to null to disable.
+      restrictions:
+        apps: []
+        users: [kiview,totallyzen,alexanderankin]
+        teams: [oss-maintainers]