pythainer 0.0.1__tar.gz

pythainer-0.0.1/.flake8

@@ -0,0 +1,5 @@
+[flake8]
+#ignore = E203, W503
+max-line-length = 100
+exclude =
+    venv/,

pythainer-0.0.1/.gitignore

@@ -0,0 +1,160 @@
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[cod]
+*$py.class
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+share/python-wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+MANIFEST
+
+# PyInstaller
+#  Usually these files are written by a python script from a template
+#  before PyInstaller builds the exe, so as to inject date/other infos into it.
+*.manifest
+*.spec
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.nox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*.cover
+*.py,cover
+.hypothesis/
+.pytest_cache/
+cover/
+
+# Translations
+*.mo
+*.pot
+
+# Django stuff:
+*.log
+local_settings.py
+db.sqlite3
+db.sqlite3-journal
+
+# Flask stuff:
+instance/
+.webassets-cache
+
+# Scrapy stuff:
+.scrapy
+
+# Sphinx documentation
+docs/_build/
+
+# PyBuilder
+.pybuilder/
+target/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# IPython
+profile_default/
+ipython_config.py
+
+# pyenv
+#   For a library or package, you might want to ignore these files since the code is
+#   intended to run in multiple environments; otherwise, check them in:
+# .python-version
+
+# pipenv
+#   According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
+#   However, in case of collaboration, if having platform-specific dependencies or dependencies
+#   having no cross-platform support, pipenv may install dependencies that don't work, or not
+#   install all needed dependencies.
+#Pipfile.lock
+
+# poetry
+#   Similar to Pipfile.lock, it is generally recommended to include poetry.lock in version control.
+#   This is especially recommended for binary packages to ensure reproducibility, and is more
+#   commonly ignored for libraries.
+#   https://python-poetry.org/docs/basic-usage/#commit-your-poetrylock-file-to-version-control
+#poetry.lock
+
+# pdm
+#   Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control.
+#pdm.lock
+#   pdm stores project-wide configurations in .pdm.toml, but it is recommended to not include it
+#   in version control.
+#   https://pdm.fming.dev/#use-with-ide
+.pdm.toml
+
+# PEP 582; used by e.g. github.com/David-OConnor/pyflow and github.com/pdm-project/pdm
+__pypackages__/
+
+# Celery stuff
+celerybeat-schedule
+celerybeat.pid
+
+# SageMath parsed files
+*.sage.py
+
+# Environments
+.env
+.venv
+env/
+venv/
+ENV/
+env.bak/
+venv.bak/
+
+# Spyder project settings
+.spyderproject
+.spyproject
+
+# Rope project settings
+.ropeproject
+
+# mkdocs documentation
+/site
+
+# mypy
+.mypy_cache/
+.dmypy.json
+dmypy.json
+
+# Pyre type checker
+.pyre/
+
+# pytype static type analyzer
+.pytype/
+
+# Cython debug symbols
+cython_debug/
+
+# PyCharm
+#  JetBrains specific template is maintained in a separate JetBrains.gitignore that can
+#  be found at https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore
+#  and can be added to the global gitignore or merged into this file.  For a more nuclear
+#  option (not recommended) you can uncomment the following to ignore the entire idea folder.
+.idea/

pythainer-0.0.1/.pylintrc

@@ -0,0 +1,11 @@
+[BASIC]
+#good-names=x,y,m,gd,df,p,s,i,r,d,k,cd,d1,d2,ip,vn,x0,x1,y0,y1,dd,xs,i,j,tz
+ignore-paths=
+    venv/,
+
+[MESSAGE-CONTROL]
+disable=
+    too-many-instance-attributes,
+    too-many-arguments,
+    too-few-public-methods,
+    unspecified-encoding,

pythainer-0.0.1/CHANGELOG.md

@@ -0,0 +1,10 @@
+# Changelog
+
+All notable changes to benchkit will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+## [0.0.1] - 2024-04-22
+
+Initial version.

pythainer-0.0.1/CONTRIBUTING.md

@@ -0,0 +1,39 @@
+# Contributing to pythainer
+
+Contributions are welcome.
+Contact the [maintainer](MAINTAINERS) for more information.
+
+### Source organization
+
+Source organization is already documented for users in the [README](README.md).
+
+### Modifying the core
+
+The core is the `pythainer/` directory.
+
+### Conventions
+
+When defining a class, the following order of functions should be respected:
+
+ 1. `__new__` (static) method
+ 2. `__init__` method
+ 3. `__post_init__` method
+ 4. Properties (`@property`)
+ 5. Static methods (`@staticmethod`) 
+ 6. Class methods (`@classmethod`) 
+ 7. Normal methods 
+ 8. Protected or private methods (with the name starting with `_`)
+
+
+### Check list to modify a python file
+
+- if the file is executable, the shebang must be the first line: `#!/usr/bin/env python3`
+- type hinting is correct & complete (to a _reasonable_ extent)
+- sorting imports: `isort --profile black .`
+- formatting: `black -l 100 .`
+- checking: `pylint`
+- checking: `flake8`
+
+### Reviews
+
+All contributions require to be reviewed by the [maintainer](MAINTAINERS).

pythainer-0.0.1/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024 Antonio Paolillo
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

pythainer-0.0.1/MAINTAINERS

@@ -0,0 +1 @@
+Antonio Paolillo

pythainer-0.0.1/PKG-INFO

@@ -0,0 +1,107 @@
+Metadata-Version: 2.3
+Name: pythainer
+Version: 0.0.1
+Summary: A pythonic toolkit for composing, managing, and deploying Docker images and containers.
+Project-URL: Homepage, https://github.com/apaolillo/pythainer
+Project-URL: Issues, https://github.com/apaolillo/pythainer/issues
+Author-email: Antonio Paolillo <antonio@paolillo.be>
+License-File: LICENSE
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
+Requires-Python: >=3.10
+Description-Content-Type: text/markdown
+
+# Pythainer
+
+Pythainer is an open-source Python package designed to facilitate the creation,
+management, composition and deployment of Docker containers for various use
+cases, with a focus on ease of use and automation.
+
+## Features
+
+- **Docker Image Building**: Simplify Docker image construction with
+  pre-defined Python scripts.
+- **Project Examples**: Includes examples for building, installing, and
+  running applications within Docker containers.
+- **Extensible**: Easily extendable to include more features or adapt
+  existing ones to different environments or requirements.
+
+## Getting Started
+
+### Prerequisites
+
+- Python 3.10 or later
+- [Docker](https://docs.docker.com/engine/install/)
+
+### Installation
+
+To get started with Pythainer, clone this repository and set up a virtual
+environment:
+
+```bash
+git clone https://github.com/apaolillo/pythainer.git
+cd pythainer
+./scripts/install_venv.sh
+```
+
+### Usage
+
+Here is a simple example of how to use Pythainer to build a Docker container:
+
+```python3
+from pythainer.builders import UbuntuDockerBuilder
+from pythainer.runners import ConcreteDockerRunner
+
+image_name = "pythainertest"
+builder = UbuntuDockerBuilder(tag=image_name, ubuntu_base_tag="ubuntu:22.04")
+builder.add_packages(packages=["vim", "git", "tmux"])
+runner = ConcreteDockerRunner(image=image_name)
+
+builder.build()
+runner.run()
+```
+
+## High-level source organization
+
+The source code of this repository is organized as follows:
+```
+pythainer
+├── pythainer           Core package containing all the essential modules for the framework.
+│   ├── builders        Modules responsible for building Docker images through automated scripts.
+│   │   ├── cmds.py     Defines command classes that translate high-level actions into Dockerfile commands.
+│   │   └── utils.py    Provides utility functions supporting Docker image construction.
+│   ├── examples        Contains various examples demonstrating the use of Pythainer components.
+│   │   ├── builders    Examples showcasing how to use the builders module to create Docker images.
+│   │   ├── installs    Examples demonstrating how to handle software installations inside Docker containers.
+│   │   └── runners     Examples illustrating how to execute and manage Docker containers for specific tasks.
+│   ├── runners         Contains utilities for running Docker containers.
+│   └── sysutils.py     Provides system utilities such as shell command execution and directory management.
+└── scripts             Directory containing scripts that facilitate development and operational tasks.
+```
+
+## Contributing
+
+Contributions to Pythainer are welcome! If you have suggestions for
+improvements  or new features, please open an issue or submit a pull request.
+
+Please read [CONTRIBUTING.md](CONTRIBUTING.md) for details on the process.
+
+## Roadmap
+
+Check out the [ROADMAP.md](ROADMAP.md) file to see the plans for future
+releases.
+
+## License
+
+This project is licensed under the MIT License - see the [LICENSE](LICENSE)
+file for details.
+
+## Maintainers
+
+For major changes and guidance, the list of active maintainers is available in
+the [MAINTAINERS](MAINTAINERS) file.
+
+## Support
+
+For support, raise an issue in the GitHub issue tracker.

pythainer-0.0.1/README.md

@@ -0,0 +1,93 @@
+# Pythainer
+
+Pythainer is an open-source Python package designed to facilitate the creation,
+management, composition and deployment of Docker containers for various use
+cases, with a focus on ease of use and automation.
+
+## Features
+
+- **Docker Image Building**: Simplify Docker image construction with
+  pre-defined Python scripts.
+- **Project Examples**: Includes examples for building, installing, and
+  running applications within Docker containers.
+- **Extensible**: Easily extendable to include more features or adapt
+  existing ones to different environments or requirements.
+
+## Getting Started
+
+### Prerequisites
+
+- Python 3.10 or later
+- [Docker](https://docs.docker.com/engine/install/)
+
+### Installation
+
+To get started with Pythainer, clone this repository and set up a virtual
+environment:
+
+```bash
+git clone https://github.com/apaolillo/pythainer.git
+cd pythainer
+./scripts/install_venv.sh
+```
+
+### Usage
+
+Here is a simple example of how to use Pythainer to build a Docker container:
+
+```python3
+from pythainer.builders import UbuntuDockerBuilder
+from pythainer.runners import ConcreteDockerRunner
+
+image_name = "pythainertest"
+builder = UbuntuDockerBuilder(tag=image_name, ubuntu_base_tag="ubuntu:22.04")
+builder.add_packages(packages=["vim", "git", "tmux"])
+runner = ConcreteDockerRunner(image=image_name)
+
+builder.build()
+runner.run()
+```
+
+## High-level source organization
+
+The source code of this repository is organized as follows:
+```
+pythainer
+├── pythainer           Core package containing all the essential modules for the framework.
+│   ├── builders        Modules responsible for building Docker images through automated scripts.
+│   │   ├── cmds.py     Defines command classes that translate high-level actions into Dockerfile commands.
+│   │   └── utils.py    Provides utility functions supporting Docker image construction.
+│   ├── examples        Contains various examples demonstrating the use of Pythainer components.
+│   │   ├── builders    Examples showcasing how to use the builders module to create Docker images.
+│   │   ├── installs    Examples demonstrating how to handle software installations inside Docker containers.
+│   │   └── runners     Examples illustrating how to execute and manage Docker containers for specific tasks.
+│   ├── runners         Contains utilities for running Docker containers.
+│   └── sysutils.py     Provides system utilities such as shell command execution and directory management.
+└── scripts             Directory containing scripts that facilitate development and operational tasks.
+```
+
+## Contributing
+
+Contributions to Pythainer are welcome! If you have suggestions for
+improvements  or new features, please open an issue or submit a pull request.
+
+Please read [CONTRIBUTING.md](CONTRIBUTING.md) for details on the process.
+
+## Roadmap
+
+Check out the [ROADMAP.md](ROADMAP.md) file to see the plans for future
+releases.
+
+## License
+
+This project is licensed under the MIT License - see the [LICENSE](LICENSE)
+file for details.
+
+## Maintainers
+
+For major changes and guidance, the list of active maintainers is available in
+the [MAINTAINERS](MAINTAINERS) file.
+
+## Support
+
+For support, raise an issue in the GitHub issue tracker.

pythainer-0.0.1/ROADMAP.md

@@ -0,0 +1,5 @@
+# Roadmap
+
+[ ] Document installation of CUDA dependencies on the host, i.e. install
+container-toolkit to run CUDA application inside the container:
+https://docs.nvidia.com/datacenter/cloud-native/container-toolkit/latest/install-guide.html

pythainer-0.0.1/pyproject.toml

@@ -0,0 +1,35 @@
+[project]
+name = "pythainer"
+version = "0.0.1"
+authors = [
+  { name="Antonio Paolillo", email="antonio@paolillo.be" },
+]
+description = "A pythonic toolkit for composing, managing, and deploying Docker images and containers."
+readme = "README.md"
+requires-python = ">=3.10"
+classifiers = [
+    "Programming Language :: Python :: 3",
+    "License :: OSI Approved :: MIT License",
+    "Operating System :: OS Independent",
+]
+
+[project.urls]
+Homepage = "https://github.com/apaolillo/pythainer"
+Issues = "https://github.com/apaolillo/pythainer/issues"
+
+[build-system]
+requires = ["hatchling"]
+build-backend = "hatchling.build"
+
+[tool.black]
+line-length = 100
+target-version = ['py310']
+
+exclude = '''venv'''
+
+[tool.isort]
+profile = "black"
+skip = [
+    "venv"
+]
+skip_glob = ["**/venv/**/*"]

pythainer-0.0.1/scripts/all_checks.sh

@@ -0,0 +1,37 @@
+#!/bin/sh
+set -e
+
+script_dir=$(readlink -e "$(dirname "$0")")
+pythainer_root_dir=$(readlink -e "${script_dir}/..")
+venv_dir=$(readlink -f "${pythainer_root_dir}/venv")
+
+(
+  cd "${pythainer_root_dir}"
+
+  if [ ! -d "${venv_dir}" ]
+  then
+    echo "-- venv in root dir of benchkit not present. Creating one. --"
+    ./scripts/install_venv.sh
+    echo "-- venv created. --"
+  fi
+
+  pylint=$(readlink -f "${venv_dir}/bin/pylint")
+  flake8=$(readlink -f "${venv_dir}/bin/flake8")
+  isort=$(readlink -f "${venv_dir}/bin/isort")
+  black=$(readlink -f "${venv_dir}/bin/black")
+
+  echo "-- check copyright. --"
+  ./scripts/list_missing_copyright.sh
+
+  echo "-- running pylint. --"
+  ${pylint} pythainer/ || true
+
+  echo "-- running flake8. --"
+  ${flake8} pythainer/ || true
+
+  echo "-- running isort. --"
+  ${isort} --profile=black pythainer/
+
+  echo "-- running black. --"
+  ${black} -l 100 .
+)

pythainer-0.0.1/scripts/install_venv.sh

@@ -0,0 +1,22 @@
+#!/bin/sh
+set -e
+
+script_dir=$(dirname "$(readlink -f "$0")")
+
+python_exec=python3.10
+
+${python_exec} -m venv venv
+
+pip_execs=$(find venv/ -name "pip3*")
+pip_exec=$(echo "${pip_execs}" | head -n 1)
+
+${pip_exec} install --upgrade pip
+${pip_exec} install --upgrade setuptools
+${pip_exec} install --upgrade wheel
+${pip_exec} install --upgrade pycodestyle isort pylint black black[d] black[jupyter] flake8 docopt
+
+requirement_file="requirements.txt"
+if [ -e "${requirement_file}" ]
+then
+  ${pip_exec} install --upgrade --requirement "${requirement_file}"
+fi

pythainer-0.0.1/scripts/list_missing_copyright.sh

@@ -0,0 +1,18 @@
+#!/bin/sh
+set -e
+
+copyright_line1="# Copyright (C) 2024 Antonio Paolillo. All rights reserved."
+copyright_line2="# SPDX-License-Identifier: MIT"
+
+# Iterate over all .py files in the current directory and its subdirectories, excluding venv/
+find . -type d -name "venv" -prune -o -type f -name "*.py" -print | while IFS= read -r file; do
+    header=$(head -n 3 "$file")
+    case "$header" in
+        *"$copyright_line1"*|*"$copyright_line2"*)
+            # Do nothing if match found
+            ;;
+        *)
+            echo "$file does not have the copyright header" >&2
+            ;;
+    esac
+done

pythainer-0.0.1/src/pythainer/__init__.py

@@ -0,0 +1,2 @@
+# Copyright (C) 2024 Antonio Paolillo. All rights reserved.
+# SPDX-License-Identifier: MIT