iker-python-setup 1.0.4__tar.gz → 1.0.6__tar.gz

{iker_python_setup-1.0.4 → iker_python_setup-1.0.6}/.github/workflows/pr.yml

@@ -43,3 +43,21 @@ jobs:
           python -m pip install --upgrade pip
           python -m pip install .[test]
           python -m pytest . --cov --cov-config pyproject.toml
+
+  build-python313:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Setup Python
+        uses: actions/setup-python@v5
+        with:
+          python-version: "3.13"
+
+      - name: Checkout
+        uses: actions/checkout@v4
+
+      - name: Build and Test
+        run: |
+          sudo apt-get install libxml2-dev libxslt1-dev llvm-14-dev
+          python -m pip install --upgrade pip
+          python -m pip install .[test]
+          python -m pytest . --cov --cov-config pyproject.toml

{iker_python_setup-1.0.4 → iker_python_setup-1.0.6}/.github/workflows/push.yml

@@ -14,7 +14,7 @@ jobs:
       - name: Setup Python
         uses: actions/setup-python@v5
         with:
-          python-version: "3.12"
+          python-version: "3.13"
 
       - name: Checkout
         uses: actions/checkout@v4

{iker_python_setup-1.0.4 → iker_python_setup-1.0.6}/PKG-INFO

@@ -1,10 +1,11 @@
 Metadata-Version: 2.1
 Name: iker-python-setup
-Version: 1.0.4
+Version: 1.0.6
 Classifier: Programming Language :: Python :: 3
 Classifier: Programming Language :: Python :: 3.11
 Classifier: Programming Language :: Python :: 3.12
-Requires-Python: <3.13,>=3.11
+Classifier: Programming Language :: Python :: 3.13
+Requires-Python: <3.14,>=3.11
 Requires-Dist: setuptools>=75.0
 Requires-Dist: setuptools-scm>=8.0
 Provides-Extra: test

iker_python_setup-1.0.6/README.md

@@ -0,0 +1,93 @@
+# Iker's Python Setup Module
+
+SCM/CI environment settings aware setup tool for Iker's Python projects
+
+The Python package naming and versioning should comply with the [PEP 440](https://peps.python.org/pep-0440) and
+[PEP 517](https://peps.python.org/pep-0517/) standards to ensure compatibility with the Python Package Index, as well as
+various build front-ends and back-ends. Additionally, we aim to manage version updates using both the SCM and CI
+systems, enabling for example automatic patch increments based on SCM branch information, CI build numbers, or release
+tags.
+
+To achieve this, we can utilize SCM branch information alongside CI-generated data injected into the build environment.
+This approach requires the build process to dynamically determine the version string, taking into account both the local
+version configuration (e.g., major and minor version numbers) and the CI runtime environment.
+
+This package offers the necessary build tools to fulfill these requirements.
+
+## Usage
+
+To use this tool for managing the versioning of your Python package, follow these steps:
+
+1. **Create a `VERSION` file** that maintains the major and minor version numbers. For example:
+    ```
+    1.0
+    ```
+2. **Modify the `pyproject.toml` file** as follows:
+    ```toml
+    [build-system]
+    requires = [
+        "setuptools>=68.0",
+        "setuptools-scm>=8.0",
+        "iker-python-setup>=1.0"  # This is required
+    ]
+
+    [project]
+    dynamic = ["version"]  # This is required
+    ```
+3. **Use this tool in your `setup.py` script**:
+    ```python
+    from iker.setup import setup
+
+    setup()
+    ```
+
+### Behaviors
+
+The major and minor version numbers are read from the `VERSION` file located in the project’s root directory, while the
+patch version number is sourced from the `BUILD_NUMBER` environment variable. These can be configured via the
+`version_file` and `patch_env_var` parameters of the `setup` function. In a CI environment, the `patch_env_var` can be
+set by the CI system.
+
+For SCM settings, if the code is on the specified "base" branch, no additional segments will be appended to the version
+string. Otherwise, a 12-character digest of the current commit will be appended to the version string. Additionally, if
+there are uncommitted changes in the workspace, a `dirty` label will also be added, resulting in a final version string
+format like `{major}.{minor}.{patch}+{digest}.dirty`.
+
+An alternative approach for detecting the "base" branch is to use an environment variable specified by
+`scm_branch_env_var`, which defaults to `GIT_BRANCH`. The "base" branch name, defaulting to `master`, is also
+configurable.
+
+```python
+from iker.setup import setup
+
+setup(
+    version_file="MY_VERSION",
+    patch_env_var="MY_ENV_VAR",
+    scm_branch_name="main",
+    scm_branch_env_var="MY_SCM_BRANCH"
+)
+```
+
+## Build and Deploy
+
+### Using Conda
+
+We recommend using Conda. You need to install Anaconda packages from
+the [official site](https://www.anaconda.com/products/distribution)
+
+Create a Conda environment and install the modules and their dependencies in it
+
+```shell
+conda create -n iker python=3.12
+conda activate iker
+
+pip install .
+
+conda deactivate
+```
+
+To remove the existing Conda environment (and create a brand new one)
+
+```shell
+conda env remove -n iker
+```

{iker_python_setup-1.0.4 → iker_python_setup-1.0.6}/pyproject.toml

@@ -8,11 +8,12 @@ build-backend = "setuptools.build_meta"
 [project]
 name = "iker-python-setup"
 dynamic = ["version"]
-requires-python = ">=3.11,<3.13"
+requires-python = ">=3.11,<3.14"
 classifiers = [
     "Programming Language :: Python :: 3",
     "Programming Language :: Python :: 3.11",
     "Programming Language :: Python :: 3.12",
+    "Programming Language :: Python :: 3.13",
 ]
 dependencies = [
     "setuptools>=75.0",

iker_python_setup-1.0.6/src/iker/setup/__init__.py

@@ -0,0 +1,110 @@
+import importlib.metadata
+import os
+
+try:
+    __version__ = importlib.metadata.version("iker-python-setup")
+except importlib.metadata.PackageNotFoundError:
+    __version__ = "unknown"
+
+__all__ = [
+    "version_string_local",
+    "version_string_scm",
+    "version_string",
+    "setup",
+]
+
+
+def read_version_tuple(cwd: str | None, *, version_file: str, patch_env_var: str) -> tuple[int, int, int]:
+    if cwd is None:
+        cwd = os.getcwd()
+
+    with open(os.path.join(cwd, version_file)) as fh:
+        major_str, minor_str, *patch_strs = fh.read().strip().split(".")
+
+    major = max(0, int(major_str))
+    minor = max(0, int(minor_str))
+
+    patch_str = patch_strs[0] if len(patch_strs) > 0 else os.getenv(patch_env_var)
+    patch = 0 if patch_str is None else min(999999, max(0, int(patch_str)))
+
+    return major, minor, patch
+
+
+def version_string_local(cwd: str | None,
+                         *,
+                         version_file: str,
+                         patch_env_var: str) -> str:
+    major, minor, patch = read_version_tuple(cwd, version_file=version_file, patch_env_var=patch_env_var)
+    return f"{major}.{minor}.{patch}"
+
+
+def version_string_scm(cwd: str | None,
+                       *,
+                       version_file: str,
+                       patch_env_var: str,
+                       scm_branch_name: str,
+                       scm_branch_env_var: str) -> str:
+    from setuptools_scm import ScmVersion
+    from setuptools_scm import get_version
+    if cwd is None:
+        cwd = os.getcwd()
+
+    def find_scm_root(cd: str) -> str:
+        cd = os.path.abspath(cd)
+        for item in os.listdir(cd):
+            if os.path.isdir(os.path.join(cd, item)) and item == ".git":
+                return cd
+        pd = os.path.dirname(cd)
+        if pd == cd:
+            raise ValueError("Cannot find SCM root properly")
+        return find_scm_root(pd)
+
+    def version_scheme_callback(scm_version: ScmVersion) -> str:
+        major, minor, patch = read_version_tuple(cwd, version_file=version_file, patch_env_var=patch_env_var)
+        if scm_version.branch == scm_branch_name or os.getenv(scm_branch_env_var) == scm_branch_name:
+            return f"{major}.{minor}.{patch}"
+        return f"{major}.{minor}.{0}"
+
+    def local_scheme_callback(scm_version: ScmVersion) -> str:
+        if scm_version.branch == scm_branch_name or os.getenv(scm_branch_env_var) == scm_branch_name:
+            return ""
+        if scm_version.dirty:
+            return scm_version.format_with("+{node}.dirty")
+        return scm_version.format_with("+{node}")
+
+    return get_version(root=find_scm_root(cwd),
+                       version_scheme=version_scheme_callback,
+                       local_scheme=local_scheme_callback,
+                       normalize=True)
+
+
+def version_string(cwd: str | None = None,
+                   default: str = "0.0.0",
+                   *,
+                   version_file: str = "VERSION",
+                   patch_env_var: str = "BUILD_NUMBER",
+                   scm_branch_name: str = "master",
+                   scm_branch_env_var: str = "GIT_BRANCH",
+                   strict: bool = False) -> str:
+    try:
+        return version_string_scm(cwd,
+                                  version_file=version_file,
+                                  patch_env_var=patch_env_var,
+                                  scm_branch_name=scm_branch_name,
+                                  scm_branch_env_var=scm_branch_env_var)
+    except Exception as e:
+        if strict:
+            raise e
+    try:
+        return version_string_local(cwd,
+                                    version_file=version_file,
+                                    patch_env_var=patch_env_var)
+    except Exception as e:
+        if strict:
+            raise e
+    return default
+
+
+def setup(cwd: str | None = None, **kwargs):
+    from setuptools import setup
+    setup(version=version_string(cwd, **kwargs), **kwargs)

{iker_python_setup-1.0.4 → iker_python_setup-1.0.6}/src/iker_python_setup.egg-info/PKG-INFO

@@ -1,10 +1,11 @@
 Metadata-Version: 2.1
 Name: iker-python-setup
-Version: 1.0.4
+Version: 1.0.6
 Classifier: Programming Language :: Python :: 3
 Classifier: Programming Language :: Python :: 3.11
 Classifier: Programming Language :: Python :: 3.12
-Requires-Python: <3.13,>=3.11
+Classifier: Programming Language :: Python :: 3.13
+Requires-Python: <3.14,>=3.11
 Requires-Dist: setuptools>=75.0
 Requires-Dist: setuptools-scm>=8.0
 Provides-Extra: test

iker_python_setup-1.0.4/README.md

@@ -1,25 +0,0 @@
-# Iker's Python Setup Module
-
-## Build and Deploy
-
-### Using Conda
-
-We recommend using Conda. You need to install Anaconda packages from
-the [official site](https://www.anaconda.com/products/distribution)
-
-Create a Conda environment and install the modules and their dependencies in it
-
-```shell
-conda create -n iker python=3.12
-conda activate iker
-
-pip install .
-
-conda deactivate
-```
-
-To remove the existing Conda environment (and create a brand new one)
-
-```shell
-conda env remove -n iker
-```

iker_python_setup-1.0.4/src/iker/setup/__init__.py

@@ -1,91 +0,0 @@
-import importlib.metadata
-import os
-
-try:
-    __version__ = importlib.metadata.version("iker-python-setup")
-except importlib.metadata.PackageNotFoundError:
-    __version__ = "unknown"
-
-__all__ = [
-    "version_string_local",
-    "version_string_scm",
-    "version_string",
-    "setup",
-]
-
-
-def read_version_tuple(cwd: str | None = None,
-                       *,
-                       default: (int, int, int) = (0, 0, 0),
-                       version_file: str = "VERSION",
-                       patch_env_var: str = "BUILD_NUMBER",
-                       strict: bool = False) -> (int, int, int):
-    if cwd is None:
-        cwd = os.getcwd()
-    try:
-        with open(os.path.join(cwd, version_file)) as fh:
-            major_str, minor_str, *patch_strs = fh.read().strip().split(".")
-
-        major = max(0, int(major_str))
-        minor = max(0, int(minor_str))
-
-        patch_str = patch_strs[0] if len(patch_strs) > 0 else os.getenv(patch_env_var)
-        patch = 0 if patch_str is None else min(999999, max(0, int(patch_str)))
-
-        return major, minor, patch
-    except Exception as e:
-        if strict:
-            raise e
-    return default
-
-
-def version_string_local(cwd: str | None = None) -> str:
-    major, minor, patch = read_version_tuple(cwd, strict=True)
-    return f"{major}.{minor}.{patch}"
-
-
-def version_string_scm(cwd: str | None = None) -> str:
-    from setuptools_scm import ScmVersion
-    from setuptools_scm import get_version
-    if cwd is None:
-        cwd = os.getcwd()
-
-    def find_scm_root(cd: str) -> str:
-        cd = os.path.abspath(cd)
-        for item in os.listdir(cd):
-            if os.path.isdir(os.path.join(cd, item)) and item == ".git":
-                return cd
-        pd = os.path.dirname(cd)
-        if pd == cd:
-            raise ValueError("Cannot find SCM root properly")
-        return find_scm_root(pd)
-
-    def version_scheme_callback(scm_version: ScmVersion) -> str:
-        major, minor, patch = read_version_tuple(cwd, strict=True)
-        if scm_version.branch == "master" or os.getenv("GIT_BRANCH", "") == "master":
-            return f"{major}.{minor}.{patch}"
-        return f"{major}.{minor}.{0}"
-
-    def local_scheme_callback(scm_version: ScmVersion) -> str:
-        if scm_version.branch == "master" or os.getenv("GIT_BRANCH", "") == "master":
-            return ""
-        if scm_version.dirty:
-            return scm_version.format_with("+{node}.dirty")
-        return scm_version.format_with("+{node}")
-
-    return get_version(root=find_scm_root(cwd),
-                       version_scheme=version_scheme_callback,
-                       local_scheme=local_scheme_callback,
-                       normalize=True)
-
-
-def version_string(cwd: str | None = None):
-    try:
-        return version_string_scm(cwd)
-    except Exception:
-        return version_string_local(cwd)
-
-
-def setup():
-    from setuptools import setup
-    setup(version=version_string())