splight-lib 5.3.0__tar.gz → 5.24.0.dev2__tar.gz

splight_lib-5.24.0.dev2/.github/workflows/code-style.yaml

@@ -0,0 +1,21 @@
+name: Code Quality
+
+on: 
+  pull_request:
+    branches:
+      - master
+
+jobs:
+  format:
+    runs-on: ubuntu-latest
+    name: Check Code Quality and Format
+    steps:
+      - uses: actions/checkout@v4
+      - name: Install Python
+        uses: actions/setup-python@v5
+        with:
+          python-version: "3.11"
+      - name: Install latest uv and set Python version
+        uses: astral-sh/setup-uv@v6
+      - name: Lint 
+        run: make check-format

splight_lib-5.24.0.dev2/.github/workflows/developer.yaml

@@ -0,0 +1,84 @@
+# used when creating a feature branch for development
+# enabling the creation of dev versions (x.y.z-devN) that are uploaded to pypi
+# if the version is correct, that is, greater than the version of master and pypi
+name: Developer
+on: workflow_dispatch
+
+env:
+  LIBRARY_NAME: "splight-lib"
+
+jobs:
+  verify_version:
+    runs-on: ubuntu-latest
+    name: Verify version is higher than last PyPi package and master version
+    steps:
+      # get master version
+      - name: Checkout to master
+        uses: actions/checkout@v3
+        with:
+          ref: master
+
+      - name: Get version from master branch
+        run: echo "MASTER_VERSION=$(grep version pyproject.toml | head -1 | awk '{print $3}' | tr -d '\"')" >> "$GITHUB_ENV"
+
+      # get current branch version
+      - name: Checkout to feature branch
+        uses: actions/checkout@v3
+
+      - name: Checks if you are in the master branch
+        if: ${{ github.ref == 'refs/heads/master' }}
+        run: |
+          echo "Cannot run this action in the master branch."
+          exit 1
+
+      - name: Get version from feature branch
+        run: echo "CURRENT_VERSION=$(grep version pyproject.toml | head -1 | awk '{print $3}' | tr -d '\"')" >> "$GITHUB_ENV"
+
+      - name: Set up Python
+        uses: actions/setup-python@v3
+        with:
+          python-version: "3.11"
+
+      # validate versions
+      - name: Validates version is a dev version.
+        run: python3 .github/workflows/scripts/check_dev_version.py ${{ env.CURRENT_VERSION }}
+
+      - name: Verifies the dev version is not uploaded.
+        run: python .github/workflows/scripts/check_version_uploaded.py ${{ env.CURRENT_VERSION }} $LIBRARY_NAME
+
+  upload_developer_to_pypi:
+    runs-on: ubuntu-latest
+    name: Upload the version to pypi only if it's a developer version
+    needs: [verify_version]
+    steps:
+      - name: Checkout to feature branch
+        uses: actions/checkout@v3
+
+      - name: Get version from feature branch
+        run: echo "CURRENT_VERSION=$(grep version pyproject.toml | head -1 | awk '{print $3}' | tr -d '\"')" >> "$GITHUB_ENV"
+
+      - name: Set up Python
+        uses: actions/setup-python@v3
+        with:
+          python-version: "3.11"
+
+      - name: Install latest uv and set Python version
+        uses: astral-sh/setup-uv@v6
+
+      - name: Build package
+        run: uv build
+
+      - name: Load variable to decide whether to publish package
+        run: |
+          if [[ $CURRENT_VERSION =~ "dev" ]]; then
+              echo "PUBLISH_PACKAGE=true" >> "$GITHUB_ENV"
+          else
+              echo "PUBLISH_PACKAGE=false" >> "$GITHUB_ENV"
+          fi
+
+      - name: Publish package
+        uses: pypa/gh-action-pypi-publish@27b31702a0e7fc50959f5ad993c78deac1bdfc29
+        if: ${{ env.PUBLISH_PACKAGE == 'true' }}
+        with:
+          user: __token__
+          password: ${{ secrets.PYPI_API_TOKEN }}

splight_lib-5.24.0.dev2/.github/workflows/pre-release.yaml

@@ -0,0 +1,71 @@
+# used when creating a pull request
+# this step runs the tests, coding style and validates that the version is
+# release and greater than the version of master and pypi
+name: Pre Release
+on:
+  pull_request:
+    types:
+      [opened, synchronize]
+    branches:
+      - master
+
+env:
+  LIBRARY_NAME: "splight-lib"
+
+jobs:
+  run_tests_and_coding_style:
+    runs-on: ubuntu-latest
+    name: Verify library tests and coding style
+    steps:
+      - name: Checkout to feature branch
+        uses: actions/checkout@v3
+
+      - name: Set up Python
+        uses: actions/setup-python@v3
+        with:
+          python-version: "3.11"
+
+      - name: Install latest uv and set Python version
+        uses: astral-sh/setup-uv@v6
+
+      - name: Install dependencies
+        run: |
+          uv sync
+
+      - name: Run tests
+        run: make test
+
+  verify_version:
+    runs-on: ubuntu-latest
+    name: Verify version is a valid release version and is higher than last PyPi package and master version
+    steps:
+      # get master version
+      - name: Checkout to master
+        uses: actions/checkout@v3
+        with:
+          ref: master
+
+      - name: Get version from master branch
+        run: echo "MASTER_VERSION=$(grep version pyproject.toml | head -1 | awk '{print $3}' | tr -d '\"')" >> "$GITHUB_ENV"
+
+      # get current branch version
+      - name: Checkout to feature branch
+        uses: actions/checkout@v3
+
+      - name: Set up Python
+        uses: actions/setup-python@v3
+        with:
+          python-version: "3.11"
+
+      - name: Get version from feature branch
+        run: echo "CURRENT_VERSION=$(grep version pyproject.toml | head -1 | awk '{print $3}' | tr -d '\"')" >> "$GITHUB_ENV"
+
+      # validate versions
+      - name: Verify version is a valid release version
+        run: python .github/workflows/scripts/check_release_version.py ${{ env.CURRENT_VERSION }}
+
+      - name: Verify version is greater than last pypi uploaded version
+        run: python .github/workflows/scripts/check_pypi_version.py ${{ env.CURRENT_VERSION }} $LIBRARY_NAME
+
+      - name: Verify version is greater than master version
+        run: python .github/workflows/scripts/check_master_version.py ${{ env.MASTER_VERSION }} ${{ env.CURRENT_VERSION }}

splight_lib-5.24.0.dev2/.github/workflows/release.yaml

@@ -0,0 +1,78 @@
+# used when a new feature has already been merged to master
+# this step creates a new tag in the github repository, pushes the release
+# version to pypi and deletes all dev versions
+name: Release
+on:
+  push:
+    branches:
+      - master
+
+env:
+  LIBRARY_NAME: "splight-lib"
+
+jobs:
+  tag_version:
+    runs-on: ubuntu-latest
+    name: Create tag version on github repository
+    steps:
+      - name: Checkout to feature branch
+        uses: actions/checkout@v3
+
+      - name: Get version from feature branch
+        run: echo "CURRENT_VERSION=$(grep version pyproject.toml | head -1 | awk '{print $3}' | tr -d '\"')" >> "$GITHUB_ENV"
+
+      - name: Create tag
+        uses: softprops/action-gh-release@v1
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+        with:
+          name: Release ${{ env.CURRENT_VERSION }}
+          tag_name: ${{ env.CURRENT_VERSION }}
+
+  upload_release_to_pypi:
+    runs-on: ubuntu-latest
+    name: Upload release library version to pypi
+    needs: [tag_version]
+    steps:
+      - name: Checkout to feature branch
+        uses: actions/checkout@v3
+
+      - name: Set up Python 3.11
+        uses: actions/setup-python@v5
+        with:
+          python-version: "3.11"
+
+      - name: Install latest uv and set Python version
+        uses: astral-sh/setup-uv@v6
+
+      - name: Build package
+        run: uv build
+
+      - name: Publish package
+        uses: pypa/gh-action-pypi-publish@27b31702a0e7fc50959f5ad993c78deac1bdfc29
+        with:
+          user: __token__
+          password: ${{ secrets.PYPI_API_TOKEN }}
+
+  cleanup_pypi:
+    runs-on: ubuntu-latest
+    name: Remove all developer versions from pypi
+    needs: [upload_release_to_pypi]
+    steps:
+      - name: Checkout to feature branch
+        uses: actions/checkout@v3
+
+      - name: Set up Python 3.11
+        uses: actions/setup-python@v5
+        with:
+          python-version: "3.11"
+
+      # install requests and pypi-cleanup
+      - name: Install requirements
+        run: pip install -r .github/workflows/scripts/requirements.txt
+
+      - name: Get version from feature branch
+        run: echo "CURRENT_VERSION=$(grep version pyproject.toml | head -1 | awk '{print $3}' | tr -d '\"')" >> "$GITHUB_ENV"
+
+      - name: Remove all developer versions from pypi
+        run: python .github/workflows/scripts/cleanup_pypi.py $LIBRARY_NAME ${{ env.CURRENT_VERSION }} ${{ secrets.PYPI_USERNAME }} ${{ secrets.PYPI_PASSWORD }}

splight_lib-5.24.0.dev2/.github/workflows/scripts/check_dev_version.py

@@ -0,0 +1,28 @@
+import sys
+
+from pkg_resources import parse_version as parse
+
+
+class VersionError(Exception):
+    """Raised when the version is not a developer version."""
+
+    ...
+
+
+if __name__ == "__main__":
+    """Checks if the version is a developer version.
+
+    Parameters
+    ----------
+    version: The version from the feature branch
+
+    Raises
+    ------
+    VersionError if the version is not a developer version
+    """
+    version_line = sys.argv[1]
+
+    version = parse(version_line)
+
+    if not (version.is_prerelease or version.is_devrelease):
+        raise VersionError(f"Version {version} is not a developer version")

splight_lib-5.24.0.dev2/.github/workflows/scripts/check_master_version.py

@@ -0,0 +1,30 @@
+import sys
+
+from pkg_resources import parse_version as parse
+
+
+class VersionError(Exception):
+    """Raised when the feature version is not greater than the master
+    version."""
+
+
+if __name__ == "__main__":
+    """Compares versions between the local repository and master.
+
+    Args:
+        old_version (arg 1) (str): local version number (x.y.z)
+        new_version (arg 2) (str): master version number (x.y.x)
+    Raises:
+        VersionError: if the local version is not greater than master version
+    """
+    old_version_line = sys.argv[1]
+    new_version_line = sys.argv[2]
+
+    master_version = parse(old_version_line)
+    project_version = parse(new_version_line)
+
+    if project_version <= master_version:
+        raise VersionError(
+            f"Feature version {project_version} is not greater than "
+            f"master version {master_version}"
+        )

splight_lib-5.24.0.dev2/.github/workflows/scripts/check_pypi_version.py

@@ -0,0 +1,39 @@
+import json
+import sys
+import urllib.request
+
+from pkg_resources import parse_version as parse
+
+
+class PypiVersionError(Exception):
+    """Raised when the version is not greater than the one on pypi."""
+
+
+def get_pypi_version(project_name: str):
+    url = f"https://pypi.org/pypi/{project_name}/json"
+    response = urllib.request.urlopen(url)
+    version = json.loads(response.read())["info"]["version"]
+    return parse(version)
+
+
+if __name__ == "__main__":
+    """Compares versions between the local repository and the package on pypi.
+
+    Args:
+        local_version (arg 1) (str): local version number (x.y.z)
+        project_name (arg 2) (str): name of the project on pypi
+    Raises:
+        PypiVersionError: if the local version is not greater than the one on
+        pypi
+    """
+    local_version = sys.argv[1]
+    project_name = sys.argv[2]
+
+    project_version = parse(local_version)
+    public_project_version = get_pypi_version(project_name)
+
+    if project_version <= public_project_version:
+        raise PypiVersionError(
+            f"Feature version {project_version} is not greater than "
+            f"uploaded version {public_project_version}"
+        )

splight_lib-5.24.0.dev2/.github/workflows/scripts/check_release_version.py

@@ -0,0 +1,19 @@
+import sys
+
+from pkg_resources import parse_version as parse
+
+if __name__ == "__main__":
+    """Verify if the format is release for a given string version.
+
+    Example:
+        - x.y.z: it's OK.
+        - x.y.x.dev0: raises InvalidReleaseVersion
+
+    Args:
+        version (arg 1) (str): current lib version number (x.y.z)
+    Raises:
+        InvalidReleaseVersion: if the current version is not a release
+        version.
+    """
+    string_version = sys.argv[1]
+    parse(string_version)

splight_lib-5.24.0.dev2/.github/workflows/scripts/check_version_uploaded.py

@@ -0,0 +1,35 @@
+import json
+import sys
+import urllib.request
+
+from pkg_resources import parse_version as parse
+
+
+class PypiVersionError(Exception):
+    """Raised if the local version was already uploaded to pypi."""
+
+
+def get_pypi_versions(project_name: str):
+    url = f"https://pypi.org/pypi/{project_name}/json"
+    response = urllib.request.urlopen(url)
+    return [parse(r) for r in json.loads(response.read())["releases"].keys()]
+
+
+if __name__ == "__main__":
+    """Checks the version was not uploaded.
+
+    Args:
+        local_version (arg 1) (str): local version number (x.y.z)
+        project_name (arg 2) (str): name of the project on pypi
+    Raises:
+        PypiVersionError: if the local version was already uploaded to pypi
+    """
+    local_version = sys.argv[1]
+    project_name = sys.argv[2]
+
+    project_version = parse(local_version)
+    uploaded_versions = get_pypi_versions(project_name)
+    if project_version in uploaded_versions:
+        raise PypiVersionError(
+            f"Feature version {project_version} is already uploaded to pypi."
+        )

splight_lib-5.24.0.dev2/.github/workflows/scripts/cleanup_pypi.py

@@ -0,0 +1,91 @@
+import logging
+import sys
+
+import requests
+from pypi_cleanup import CsfrParser
+
+
+def delete_developer_versions(
+    package_name: str, release_version: str, username: str, password: str
+):
+    with requests.Session() as session:
+        # generate csrf token
+        with session.get("https://pypi.org/account/login/") as response:
+            response.raise_for_status()
+            form_action = "/account/login/"
+            parser = CsfrParser(form_action)
+            parser.feed(response.text)
+            if not parser.csrf:
+                raise ValueError(f"No CSFR found in {form_action}")
+            csrf = parser.csrf
+
+        # validate login
+        with session.post(
+            "https://pypi.org/account/login/",
+            data={
+                "csrf_token": csrf,
+                "username": username,
+                "password": password,
+            },
+            headers={"referer": "https://pypi.org/account/login/"},
+        ) as response:
+            response.raise_for_status()
+            if response.url == "https://pypi.org/account/login/":
+                logging.error(f"Login for user {username} failed")
+                return 1
+
+        # get developer versions to delete
+        with session.get(
+            f"https://pypi.org/pypi/{package_name}/json"
+        ) as response:
+            versions = list(response.json()["releases"].keys())
+            to_delete = [
+                version
+                for version in versions
+                if "dev" in version and release_version in version
+            ]
+
+        # delete versions
+        for version in to_delete:
+            logging.info(f"Deleting {package_name} version {version}")
+            form_action = f"/manage/project/{package_name}/release/{version}/"
+            form_url = f"https://pypi.org{form_action}"
+            with session.get(form_url) as response:
+                response.raise_for_status()
+                parser = CsfrParser(form_action, "confirm_delete_version")
+                parser.feed(response.text)
+                if not parser.csrf:
+                    raise ValueError(f"No CSFR found in {form_action}")
+                csrf = parser.csrf
+                referer = response.url
+
+            with session.post(
+                form_url,
+                data={"csrf_token": csrf, "confirm_delete_version": version},
+                headers={"referer": referer},
+            ) as response:
+                response.raise_for_status()
+
+
+if __name__ == "__main__":
+    """Remove all developer version from given release version
+
+    Args:
+        package_name (arg 1) (str): library package name (splight-lib)
+        release_version (arg 2) (str): current release version (x.y.z)
+        username (arg 3) (str): pypi account username
+        password (arg 4) (str): pypi account password
+    Raises:
+        ValueError: When CSRF fails.
+    """
+    package_name = sys.argv[1]
+    release_version = sys.argv[2]
+    username = sys.argv[3]
+    password = sys.argv[4]
+
+    public_project_version = delete_developer_versions(
+        package_name=package_name,
+        release_version=release_version,
+        username=username,
+        password=password,
+    )

splight_lib-5.24.0.dev2/.github/workflows/scripts/requirements.txt

@@ -0,0 +1,2 @@
+requests==2.32.2
+pypi-cleanup==0.1.4

splight_lib-5.24.0.dev2/.gitignore

@@ -0,0 +1,56 @@
+.env/*
+build/*
+splight_lib.egg-info/*
+db.sqlite3
+# These are some examples of commonly ignored file patterns.
+# You should customize this list as applicable to your project.
+# Learn more about .gitignore:
+#     https://www.atlassian.com/git/tutorials/saving-changes/gitignore
+
+# Node artifact files
+node_modules/
+dist/
+
+# Compiled Java class files
+*.class
+
+# Compiled Python bytecode
+*.py[cod]
+
+# Log files
+*.log
+
+# Package files
+*.jar
+
+# Maven
+target/
+dist/
+
+# JetBrains IDE
+.idea/
+
+# Unit test reports
+TEST*.xml
+
+# Generated by MacOS
+.DS_Store
+
+# Generated by Windows
+Thumbs.db
+
+# Applications
+*.app
+*.exe
+*.war
+
+# Large media files
+*.mp4
+*.tiff
+*.avi
+*.flv
+*.mov
+*.wmv
+#vscode
+.vscode
+mise.toml

splight_lib-5.24.0.dev2/.pre-commit-config.yaml

@@ -0,0 +1,10 @@
+repos:
+- repo: https://github.com/astral-sh/ruff-pre-commit
+  # Ruff version.
+  rev: v0.12.1
+  hooks:
+    # Run the linter.
+    - id: ruff-check
+      args: [ --fix ]
+    # Run the formatter.
+    - id: ruff-format