diff --git a/.github/workflows/1.bump-version.yml b/.github/workflows/1.bump-version.yml index ebbd31a..02da425 100644 --- a/.github/workflows/1.bump-version.yml +++ b/.github/workflows/1.bump-version.yml @@ -21,7 +21,7 @@ jobs: - name: Set up Python uses: actions/setup-python@v7 with: - python-version: "3.10" + python-version: "3.11" - name: Install dependencies run: | python -m pip install -U pip diff --git a/.github/workflows/2.build-publish.yml b/.github/workflows/2.build-publish.yml index a96faec..cfd974b 100644 --- a/.github/workflows/2.build-publish.yml +++ b/.github/workflows/2.build-publish.yml @@ -25,7 +25,7 @@ jobs: - name: Set up Python uses: actions/setup-python@v7 with: - python-version: "3.10" + python-version: "3.11" - name: Install dependencies run: | python -m pip install -U pip diff --git a/.github/workflows/pre-commit.yml b/.github/workflows/pre-commit.yml index 10fd5b9..e5b9614 100644 --- a/.github/workflows/pre-commit.yml +++ b/.github/workflows/pre-commit.yml @@ -23,7 +23,7 @@ jobs: - name: Set up Python uses: actions/setup-python@v7 with: - python-version: "3.10" + python-version: "3.11" - name: Cache pip uses: actions/cache@v6 with: diff --git a/.github/workflows/publish-docs.yml b/.github/workflows/publish-docs.yml index d11be07..9ba7f43 100644 --- a/.github/workflows/publish-docs.yml +++ b/.github/workflows/publish-docs.yml @@ -23,7 +23,7 @@ jobs: - name: Set up Python uses: actions/setup-python@v7 with: - python-version: "3.10" + python-version: "3.11" - name: Install dependencies run: | python -m pip install -U pip diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml index fe38c9b..ea196d4 100644 --- a/.pre-commit-config.yaml +++ b/.pre-commit-config.yaml @@ -1,6 +1,6 @@ fail_fast: true default_language_version: - python: python3.10 + python: python3.11 exclude: | (?x)^( \.git/.* @@ -146,22 +146,22 @@ repos: # --- Python --- - repo: https://github.com/psf/black - rev: 26.5.1 + rev: 26.10.1 hooks: - id: black name: "๐Ÿ black - Format python code" files: \.pyi?$ - repo: https://github.com/asottile/pyupgrade - rev: v3.21.2 + rev: v3.22.0 hooks: - id: pyupgrade name: "๐Ÿ pyupgrade - Upgrade python syntax" - entry: "pyupgrade --py310-plus" + entry: "pyupgrade --py311-plus" files: \.pyi?$ - repo: https://github.com/PyCQA/flake8 - rev: 7.3.0 + rev: 7.4.1 hooks: - id: flake8 name: "๐Ÿ flake8 - Lint python code" diff --git a/.python-version b/.python-version index c8cfe39..2c07333 100644 --- a/.python-version +++ b/.python-version @@ -1 +1 @@ -3.10 +3.11 diff --git a/Dockerfile b/Dockerfile index 4c44c24..c718052 100644 --- a/Dockerfile +++ b/Dockerfile @@ -1,7 +1,7 @@ # syntax=docker/dockerfile:1 # check=skip=SecretsUsedInArgOrEnv -ARG PYTHON_VERSION=3.10 +ARG PYTHON_VERSION=3.11 ARG BASE_IMAGE=python:${PYTHON_VERSION}-slim-trixie ARG DEBIAN_FRONTEND=noninteractive diff --git a/Dockerfile.gpu b/Dockerfile.gpu index 17489b7..485fbd4 100644 --- a/Dockerfile.gpu +++ b/Dockerfile.gpu @@ -20,7 +20,7 @@ ARG PROJECT_SLUG ENV UV_LINK_MODE=copy -ARG PYTHON_VERSION=3.10 +ARG PYTHON_VERSION=3.11 SHELL ["/bin/bash", "-o", "pipefail", "-c"] @@ -40,7 +40,7 @@ RUN --mount=type=cache,target=/opt/conda/pkgs,sharing=private \ ca-certificates \ build-essential \ wget && \ - _MINICONDA_VERSION=py310_25.11.1-1 && \ + _MINICONDA_VERSION=py311_26.7.1-1 && \ if [ "${_BUILD_TARGET_ARCH}" == "x86_64" ]; then \ _MINICONDA_FILENAME=Miniconda3-${_MINICONDA_VERSION}-Linux-x86_64.sh && \ export _MINICONDA_URL=https://repo.anaconda.com/miniconda/${_MINICONDA_FILENAME}; \ diff --git a/README.md b/README.md index dfdf645..18e3bff 100644 --- a/README.md +++ b/README.md @@ -26,7 +26,7 @@ This is a template repository for AI/ML model projects. ### 1. ๐Ÿšง Prerequisites -- Install **Python (>= v3.10)** and **pip (>= 23)**: +- Install **Python (>= v3.11)** and **pip (>= 23)**: - **[RECOMMENDED] [Miniconda (v3)](https://www.anaconda.com/docs/getting-started/miniconda/install)** - *[arm64/aarch64] [Miniforge (v3)](https://github.com/conda-forge/miniforge)* - *[Python virtual environment] [venv](https://docs.python.org/3/library/venv.html)* @@ -43,36 +43,19 @@ This is a template repository for AI/ML model projects. [TIP] Skip this step, if you're going to install the package directly from **GitHub** repository. -**2.1.** Prepare projects directory (if not exists): - ```sh -# Create projects directory: mkdir -pv ~/workspaces/projects - -# Enter into projects directory: cd ~/workspaces/projects -``` - -**2.2.** Follow one of the below options **[A]**, **[B]** or **[C]**: -**OPTION A.** Clone the repository: +# HTTPS: +git clone https://github.com/bybatkhuu/model-python-template.git +# Or SSH (development): +git clone git@github.com:bybatkhuu/model-python-template.git -```sh -git clone https://github.com/bybatkhuu/model-python-template.git && \ - cd model-python-template +cd model-python-template ``` -**OPTION B.** Clone the repository (for **DEVELOPMENT**: git + ssh key): - -```sh -git clone git@github.com:bybatkhuu/model-python-template.git && \ - cd model-python-template -``` - -**OPTION C.** Download source code: - -1. Download archived **zip** file from [**releases**](https://github.com/bybatkhuu/model-python-template/releases). -2. Extract it into the projects directory. +Alternatively, download the source from the [**releases**](https://github.com/bybatkhuu/model-python-template/releases) page and extract it into your projects directory. ### 3. ๐Ÿ“ฆ Install the package @@ -229,13 +212,6 @@ simple_model: # Just an example to group t [**`.env.example`**](./.env.example): -```sh -# ENV=LOCAL -# DEBUG=false -# TZ=UTC -# PYTHONDONTWRITEBYTECODE=0 -``` - --- ## ๐Ÿงช Running Tests diff --git a/docs/getting-started/installation.md b/docs/getting-started/installation.md index 190d5e5..4691606 100644 --- a/docs/getting-started/installation.md +++ b/docs/getting-started/installation.md @@ -8,36 +8,19 @@ title: Installation [TIP] Skip this step, if you're going to install the module directly from **git** repository. -**1.1.** Prepare projects directory (if not exists): - ```sh -# Create projects directory: mkdir -pv ~/workspaces/projects - -# Enter into projects directory: cd ~/workspaces/projects -``` - -**1.2.** Follow one of the below options **[A]**, **[B]** or **[C]**: - -**OPTION A.** Clone the repository: -```sh -git clone https://github.com/bybatkhuu/model-python-template.git && \ - cd model-python-template -``` - -**OPTION B.** Clone the repository (for **DEVELOPMENT**: git + ssh key): +# HTTPS: +git clone https://github.com/bybatkhuu/model-python-template.git +# Or SSH (development): +git clone git@github.com:bybatkhuu/model-python-template.git -```sh -git clone git@github.com:bybatkhuu/model-python-template.git && \ - cd model-python-template +cd model-python-template ``` -**OPTION C.** Download source code: - -1. Download archived **zip** file from [**releases**](https://github.com/bybatkhuu/model-python-template/releases). -2. Extract it into the projects directory. +Alternatively, download the source from the [**releases**](https://github.com/bybatkhuu/model-python-template/releases) page and extract it into your projects directory. ## 2. ๐Ÿ“ฆ Install the module diff --git a/docs/getting-started/prerequisites.md b/docs/getting-started/prerequisites.md index d3b1fd2..3885611 100644 --- a/docs/getting-started/prerequisites.md +++ b/docs/getting-started/prerequisites.md @@ -4,7 +4,7 @@ title: Prerequisites # ๐Ÿšง Prerequisites -- Install **Python (>= v3.10)** and **pip (>= 23)**: +- Install **Python (>= v3.11)** and **pip (>= 23)**: - **[RECOMMENDED] [Miniconda (v3)](https://www.anaconda.com/docs/getting-started/miniconda/install)** - *[arm64/aarch64] [Miniforge (v3)](https://github.com/conda-forge/miniforge)* - *[Python virtual environment] [venv](https://docs.python.org/3/library/venv.html)* diff --git a/pyproject.toml b/pyproject.toml index 5d6fcf0..c3806d9 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -1,5 +1,5 @@ [build-system] -requires = ["setuptools>=82.0.1,<84.0.0", "setuptools-scm>=10.0.5,<11.0.0"] +requires = ["setuptools>=82.0.1,<85.0.0", "setuptools-scm>=10.0.5,<11.0.0"] build-backend = "setuptools.build_meta" [project] @@ -7,7 +7,7 @@ name = "simple_model" authors = [{ name = "Batkhuu Byambajav", email = "batkhuu10@gmail.com" }] description = "This is a template module for AI/ML model projects." readme = "README.md" -requires-python = ">=3.10,<4.0" +requires-python = ">=3.11,<4.0" keywords = [ "simple_model", "model", @@ -24,10 +24,10 @@ classifiers = [ "Topic :: Software Development :: Libraries", "Operating System :: OS Independent", "Programming Language :: Python :: 3", - "Programming Language :: Python :: 3.10", "Programming Language :: Python :: 3.11", "Programming Language :: Python :: 3.12", "Programming Language :: Python :: 3.13", + "Programming Language :: Python :: 3.14", ] dynamic = ["version", "dependencies", "optional-dependencies"] diff --git a/requirements/requirements.build.txt b/requirements/requirements.build.txt index 3ed2c93..97120e7 100644 --- a/requirements/requirements.build.txt +++ b/requirements/requirements.build.txt @@ -1,4 +1,4 @@ -setuptools>=70.3.0,<84.0.0 +setuptools>=70.3.0,<85.0.0 wheel>=0.43.0,<1.0.0 build>=1.1.1,<2.0.0 twine>=6.0.1,<8.0.0