diff --git a/README.md b/README.md index 9bee71f..4fa4374 100644 --- a/README.md +++ b/README.md @@ -1,7 +1,44 @@ -# The openSUSE Tumbleweed BCI Python 3.10 development container image +# Python 3.10 development container image + ![Redistributable](https://img.shields.io/badge/Redistributable-Yes-green) -Python 3.10 development container based on the openSUSE Tumbleweed Base Container Image. +## Description + +[Python](https://www.python.org/) is an interpreted, interactive, object-oriented, open-source programming language. It incorporates modules, exceptions, dynamic typing, high-level dynamic data types, and classes. It provides interfaces to many system calls, libraries, and various window systems, and it is extensible in C or C++. It is also usable as an extension language for applications that require programmable interfaces. + +## Usage + +To deploy an application, install dependencies, copy the sources, and configure the application's main script: + +```Dockerfile +FROM registry.opensuse.org/opensuse/bci/python:3.10 + +WORKDIR /app + +COPY requirements.txt ./ +RUN pip install --no-cache-dir -r requirements.txt + +COPY . . + +CMD [ "python3", "./main-script.py" ] +``` + +Build and run the container image: + +```ShellSession +$ podman build -t my-python-app . +$ podman run -it --rm my-python-app +``` + +To run a single script inside a container, use the following command: + +```ShellSession +$ podman run --rm -v "$PWD":/app:Z -w /app registry.opensuse.org/opensuse/bci/python:3.10 python3 script.py +``` + +## Additional tools + +The Python container image includes [pip](https://pip.pypa.io/), [pipx](https://pipx.pypa.io/), [wheel](https://wheel.readthedocs.io/), Python Development Headers, and Git. ## Licensing diff --git a/python-3.10-image.changes b/python-3.10-image.changes index 47ea948..44a77fc 100644 --- a/python-3.10-image.changes +++ b/python-3.10-image.changes @@ -1,3 +1,8 @@ +------------------------------------------------------------------- +Thu Jun 20 09:53:37 UTC 2024 - Alexandre Vicenzi + +- extend README.md + ------------------------------------------------------------------- Tue Jun 18 17:24:16 UTC 2024 - Dirk Mueller