hyperfast-uv-template 0.3.1__tar.gz

hyperfast_uv_template-0.3.1/.copier-config.yaml

@@ -0,0 +1,44 @@
+# Changes here will be overwritten by Copier; do NOT edit manually
+_commit: v0.2.0-1-gc667855
+_src_path: .
+author: Young Joon Lee
+build_and_release: true
+code_template_answers_file: .copier-code-config.yaml
+code_template_source: ''
+codecov_graph_token: 29NXUNQUBU
+copyright_year: 2023
+documentaion_tool: mkdocs
+documentation_url: https://hyperfast-uv.entelecheia.ai
+email: entelecheia@hotmail.com
+favicon_path: https://assets.entelecheia.ai/favicon.png
+friendly_name: Hyperfast UV Template
+github_repo_name: hyperfast-uv-template
+github_username: entelecheia
+google_analytics_id: G-0K77490FJT
+logo_path: https://assets.entelecheia.ai/logo.png
+main_branch: main
+open_link: true
+package_name: hyperfastuv
+package_scripts:
+- hyperfastuv = 'hyperfastuv.__cli__:main'
+project_description: The Hyperfast UV Template is a powerful and comprehensive solution
+    designed to accelerate the development and maintenance of high-quality Python
+    projects. By incorporating industry best practices and automating key aspects
+    such as dependency management, releases, code formatting, testing, and documentation,
+    this template streamlines the entire development process. It ensures code quality
+    through continuous integration, coverage reporting, linting, and static type-checking
+    while providing seamless support for Conventional Commits and Semantic Versioning.
+    With the Hyperfast UV Template, developers can efficiently create and manage Python
+    projects, focusing on their core functionality while enjoying a robust, well-organized,
+    and maintainable codebase.
+project_license: MIT
+project_name: hyperfast-uv-template
+project_short_description: Streamlining Python Project Development with a Comprehensive
+    Toolset for Quality, Efficiency, and Maintainability
+python_version: '3.11'
+upload_to_release: true
+upload_to_repository: true
+use_launch_buttons: true
+use_source_code_skeleton: true
+uv_version: latest
+

hyperfast_uv_template-0.3.1/.copier-template/.copierignore

@@ -0,0 +1,4 @@
+.copierignore
+CHANGELOG.md
+pyproject.toml
+release.yaml

hyperfast_uv_template-0.3.1/.copier-template/.editorconfig

@@ -0,0 +1,29 @@
+# Check http://editorconfig.org for more information
+
+# top-most .editorconfig file
+root = true
+max_line_length = 120
+
+# Unix-style newlines with a newline ending every file
+[*]
+end_of_line = lf
+insert_final_newline = true
+charset = utf-8
+trim_trailing_whitespace = true
+indent_style = space
+
+[*.py]
+profile = black
+
+[Makefile]
+indent_style = tab
+
+[*.md]
+trim_trailing_whitespace = false
+
+[*.{yaml,yml}]
+indent_size = 2
+
+[*.json]
+indent_style = space
+indent_size = 4

hyperfast_uv_template-0.3.1/.copier-template/.envrc.jinja

@@ -0,0 +1,16 @@
+#!/usr/bin/env bash
+export PYTHON_KEYRING_BACKEND="keyring.backends.null.Keyring"
+PROJECT_NAME=$(basename "$(pwd)")
+export PROJECT_NAME
+PROJECT_ROOT="$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)"
+export PROJECT_ROOT
+VIRTUAL_ENV="./.venv"
+if [ -e "${VIRTUAL_ENV}/bin/activate" ]; then
+    # shellcheck disable=SC1091
+    source "${VIRTUAL_ENV}/bin/activate"
+else
+    make install
+    # shellcheck disable=SC1091
+    source "${VIRTUAL_ENV}/bin/activate"
+    python3 -m pip install --upgrade pip setuptools wheel
+fi

hyperfast_uv_template-0.3.1/.copier-template/.gitattributes

@@ -0,0 +1 @@
+* text=auto eol=lf

hyperfast_uv_template-0.3.1/.copier-template/.github/dependabot.yaml

@@ -0,0 +1,27 @@
+# To get started with Dependabot version updates, you'll need to specify which
+# package ecosystems to update and where the package manifests are located.
+# Please see the documentation for all configuration options:
+# https://docs.github.com/github/administering-a-repository/configuration-options-for-dependency-updates
+
+version: 2
+updates:
+  - package-ecosystem: "github-actions"
+    directory: "/"
+    schedule:
+      interval: "daily"
+      time: "03:00"
+      timezone: "Asia/Seoul"
+    labels:
+      - ":game_die: dependencies"
+      - ":robot: bot"
+  - package-ecosystem: "pip"
+    directory: "/"
+    schedule:
+      interval: "daily"
+      time: "03:00"
+      timezone: "Asia/Seoul"
+    allow:
+      - dependency-type: "production"
+    labels:
+      - ":game_die: dependencies"
+      - ":robot: bot"

hyperfast_uv_template-0.3.1/.copier-template/.github/labels.yaml

@@ -0,0 +1,66 @@
+---
+# Labels names are important as they are used by Release Drafter to decide
+# regarding where to record them in changelog or if to skip them.
+#
+# The repository labels will be automatically configured using this file and
+# the GitHub Action https://github.com/marketplace/actions/github-labeler.
+- name: breaking
+  description: Breaking Changes
+  color: bfd4f2
+- name: bug
+  description: Something isn't working
+  color: d73a4a
+- name: build
+  description: Build System and Dependencies
+  color: bfdadc
+- name: ci
+  description: Continuous Integration
+  color: 4a97d6
+- name: dependencies
+  description: Pull requests that update a dependency file
+  color: 0366d6
+- name: documentation
+  description: Improvements or additions to documentation
+  color: 0075ca
+- name: duplicate
+  description: This issue or pull request already exists
+  color: cfd3d7
+- name: enhancement
+  description: New feature or request
+  color: a2eeef
+- name: github_actions
+  description: Pull requests that update Github_actions code
+  color: "000000"
+- name: good first issue
+  description: Good for newcomers
+  color: 7057ff
+- name: help wanted
+  description: Extra attention is needed
+  color: 008672
+- name: invalid
+  description: This doesn't seem right
+  color: e4e669
+- name: performance
+  description: Performance
+  color: "016175"
+- name: python
+  description: Pull requests that update Python code
+  color: 2b67c6
+- name: question
+  description: Further information is requested
+  color: d876e3
+- name: refactoring
+  description: Refactoring
+  color: ef67c4
+- name: removal
+  description: Removals and Deprecations
+  color: 9ae7ea
+- name: style
+  description: Style
+  color: c120e5
+- name: testing
+  description: Testing
+  color: b1fc6f
+- name: wontfix
+  description: This will not be worked on
+  color: ffffff

hyperfast_uv_template-0.3.1/.copier-template/.github/release.yaml

@@ -0,0 +1,20 @@
+---
+changelog:
+  exclude:
+    labels:
+      - ignore-for-release
+    authors:
+      - octocat
+  categories:
+    - title: Breaking Changes 🛠
+      labels:
+        - breaking
+    - title: Exciting New Features 🎉
+      labels:
+        - feature
+    - title: Fixes 🔧
+      labels:
+        - fix
+    - title: Other Changes
+      labels:
+        - "*"

hyperfast_uv_template-0.3.1/.copier-template/.github/workflows/{% if build_and_release %}lint_and_test.yaml{% endif %}

@@ -0,0 +1,66 @@
+---
+name: lint & test
+
+on:
+  workflow_call:
+  workflow_dispatch:
+  push:
+    branches:
+      - "main"
+    paths:
+      - "src/**"
+      - "tests/**"
+
+jobs:
+  build:
+    # Name the Job
+    name: test-code-base
+    # Set the agent to run on
+    runs-on: ${{ matrix.os }}
+    strategy:
+      matrix:
+        os: [ubuntu-latest]
+        python-version: [3.9]
+
+    steps:
+      # Checkout the code base #
+      - name: Checkout Code
+        uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
+
+      - name: Install uv
+        uses: astral-sh/setup-uv@v5
+        with:
+          enable-cache: true
+
+      - name: "Set up Python"
+        uses: actions/setup-python@v5
+        with:
+          python-version-file: ".python-version"
+
+      - name: Run checks
+        run: |
+          set -o pipefail
+          make check
+
+      - name: Run unit-tests
+        run: |
+          set -o pipefail
+          make test
+
+      - name: Pytest coverage GitHub summary
+        run: |
+          set -o pipefail
+          echo '# Coverage report' >> $GITHUB_STEP_SUMMARY
+          echo '```' >> $GITHUB_STEP_SUMMARY
+          cat tests/pytest-coverage.txt >> $GITHUB_STEP_SUMMARY
+          echo '```' >> $GITHUB_STEP_SUMMARY
+          echo '\n\n\n'
+
+      - name: Upload coverage reports to Codecov
+        uses: codecov/codecov-action@v5
+        with:
+          token: ${{ secrets.CODECOV_TOKEN }} # required
+          fail_ci_if_error: false # optional (default = false)
+          verbose: true # optional (default = false)

hyperfast_uv_template-0.3.1/.copier-template/.github/workflows/{% if build_and_release %}release-test.yaml{% endif %}

@@ -0,0 +1,57 @@
+---
+name: semantic-release-test
+
+on:
+  workflow_call:
+  workflow_dispatch:
+  push:
+    branches:
+      - test-release*
+
+jobs:
+  release:
+    runs-on: ubuntu-latest
+    concurrency: release
+    environment: release
+
+    permissions:
+      id-token: write
+      contents: write
+
+    steps:
+      # Note: we need to checkout the repository at the workflow sha in case during the workflow
+      # the branch was updated. To keep PSR working with the configured release branches,
+      # we force a checkout of the desired release branch but at the workflow sha HEAD.
+      - name: Setup | Checkout Repository at workflow sha
+        uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
+          ref: ${{ github.sha }}
+
+      - name: Setup | Force correct release branch on workflow sha
+        run: |
+          git checkout -B ${{ github.ref_name }} ${{ github.sha }}
+
+      - name: Action | Semantic Version Release
+        id: release
+        # Adjust tag with desired version if applicable.
+        uses: python-semantic-release/python-semantic-release@v9.17.0
+        with:
+          build: true
+          github_token: ${{ secrets.GITHUB_TOKEN }}
+          git_committer_name: "github-actions"
+          git_committer_email: "actions@users.noreply.github.com"
+
+      - name: Publish | Upload package to TestPyPI
+        uses: pypa/gh-action-pypi-publish@release/v1
+        if: steps.release.outputs.released == 'true'
+        with:
+            password: ${{ secrets.TEST_PYPI_API_TOKEN }}
+            repository-url: https://test.pypi.org/legacy/
+
+      - name: Publish | Upload to GitHub Release Assets
+        uses: python-semantic-release/publish-action@v9.17.0
+        if: steps.release.outputs.released == 'true'
+        with:
+          github_token: ${{ secrets.GITHUB_TOKEN }}
+          tag: ${{ steps.release.outputs.tag }}

hyperfast_uv_template-0.3.1/.copier-template/.github/workflows/{% if build_and_release %}release.yaml{% endif %}

@@ -0,0 +1,56 @@
+---
+name: semantic-release
+
+on:
+  workflow_call:
+  workflow_dispatch:
+  push:
+    branches:
+      - release*
+    paths:
+      - "src/**"
+      - "pyproject.toml"
+
+jobs:
+  release:
+    runs-on: ubuntu-latest
+    concurrency: release
+
+    permissions:
+      id-token: write
+      contents: write
+
+    steps:
+      # Note: we need to checkout the repository at the workflow sha in case during the workflow
+      # the branch was updated. To keep PSR working with the configured release branches,
+      # we force a checkout of the desired release branch but at the workflow sha HEAD.
+      - name: Setup | Checkout Repository at workflow sha
+        uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
+          ref: ${{ github.sha }}
+
+      - name: Setup | Force correct release branch on workflow sha
+        run: |
+          git checkout -B ${{ github.ref_name }} ${{ github.sha }}
+
+      - name: Action | Semantic Version Release
+        id: release
+        # Adjust tag with desired version if applicable.
+        uses: python-semantic-release/python-semantic-release@v9.17.0
+        with:
+          build: true
+          github_token: ${{ secrets.GITHUB_TOKEN }}
+          git_committer_name: "github-actions"
+          git_committer_email: "actions@users.noreply.github.com"
+
+      - name: Publish | Upload package to PyPI
+        uses: pypa/gh-action-pypi-publish@release/v1
+        if: steps.release.outputs.released == 'true'
+
+      - name: Publish | Upload to GitHub Release Assets
+        uses: python-semantic-release/publish-action@v9.17.0
+        if: steps.release.outputs.released == 'true'
+        with:
+          github_token: ${{ secrets.GITHUB_TOKEN }}
+          tag: ${{ steps.release.outputs.tag }}

hyperfast_uv_template-0.3.1/.copier-template/.github/workflows/{% if documentaion_tool == 'jupyter-book' %}deploy-docs.yaml{% endif %}.jinja

@@ -0,0 +1,43 @@
+---
+name: deploy-docs
+on:
+  workflow_call:
+  workflow_dispatch:
+  push:
+    branches:
+      - main
+    # Paths can be used to only trigger actions when you have edited certain files, such as a file within the /docs directory
+    paths:
+      - "book/**"
+      - ".github/workflows/deploy-docs.yaml"
+
+permissions:
+  contents: write
+
+jobs:
+  deploy:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+
+      - uses: actions/setup-python@v5
+        with:
+          python-version: 3.9
+
+      # install the source code
+      - name: Install the source code
+        run: pip install .
+
+      # Build the book
+      - name: Build the book
+        run: |
+          pip install -r book/requirements.txt
+          jupyter-book build book
+
+      # Deploy the book's HTML to gh-pages branch
+      - name: GitHub Pages action
+        uses: peaceiris/actions-gh-pages@v4
+        with:
+          github_token: {% raw %}${{ secrets.GITHUB_TOKEN }}{% endraw %}
+          publish_dir: book/_build/html
+          cname: {% if 'github.io' not in documentation_url %}{{ documentation_url|replace('https://', '')|replace('http://', '') }}{% endif %}

hyperfast_uv_template-0.3.1/.copier-template/.github/workflows/{% if documentaion_tool == 'mkdocs' %}deploy-docs.yaml{% endif %}

@@ -0,0 +1,40 @@
+---
+name: deploy-docs
+on:
+  workflow_call:
+  workflow_dispatch:
+  push:
+    branches:
+      - main
+    # Paths can be used to only trigger actions when you have edited certain files, such as a file within the /docs directory
+    paths:
+      - "README.md"
+      - "mkdocs.yaml"
+      - "docs/**.md"
+      - "docs/images/**"
+      - ".github/workflows/deploy-docs.yaml"
+
+permissions:
+  contents: write
+
+jobs:
+  deploy:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+
+      - uses: actions/setup-python@v5
+        with:
+          python-version: 3.9
+
+      # install the source code
+      - name: Install the source code
+        run: pip install .
+
+      - uses: actions/cache@v4
+        with:
+          key: ${{ github.ref }}
+          path: .cache
+      - run: |
+          pip install -r docs/requirements.txt
+          mkdocs gh-deploy --force

hyperfast_uv_template-0.3.1/.copier-template/.github/workflows/{% if not build_and_release %}release.yaml{% endif %}

@@ -0,0 +1,45 @@
+---
+name: semantic-release
+
+on:
+  workflow_call:
+  workflow_dispatch:
+  push:
+    branches:
+      - main
+    paths:
+      - 'src/**'
+      - 'pyproject.toml'
+
+jobs:
+  release:
+    runs-on: ubuntu-latest
+    concurrency: release
+
+    permissions:
+      id-token: write
+      contents: write
+
+    steps:
+      # Note: we need to checkout the repository at the workflow sha in case during the workflow
+      # the branch was updated. To keep PSR working with the configured release branches,
+      # we force a checkout of the desired release branch but at the workflow sha HEAD.
+      - name: Setup | Checkout Repository at workflow sha
+        uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
+          ref: ${{ github.sha }}
+
+      - name: Setup | Force correct release branch on workflow sha
+        run: |
+          git checkout -B ${{ github.ref_name }} ${{ github.sha }}
+
+      - name: Action | Semantic Version Release
+        id: release
+        # Adjust tag with desired version if applicable.
+        uses: python-semantic-release/python-semantic-release@v9.12.0
+        with:
+          build: true
+          github_token: ${{ secrets.GITHUB_TOKEN }}
+          git_committer_name: "github-actions"
+          git_committer_email: "actions@users.noreply.github.com"

hyperfast_uv_template-0.3.1/.copier-template/.gitignore

@@ -0,0 +1,43 @@
+# working directory
+workspace/
+tmp/
+
+# hypothesis: https://github.com/HypothesisWorks/hypothesis
+.hypothesis/
+.vscode/
+
+# Ignore node_modules directory
+node_modules/
+
+# Jupyter Notebook
+_build/
+_autosummary/
+.ipynb_checkpoints/
+
+# MkDocs
+site/
+
+# Python
+*.py[cod]
+__pycache__/
+dist/
+.tox/
+*.egg-info/
+*.egg
+pytest_cache/
+pytest.xml
+.mypy_cache/
+.venv/
+
+# Coverage
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*.cover
+htmlcov/
+pytest-coverage.*
+
+# UV lock file
+uv.lock

hyperfast_uv_template-0.3.1/.copier-template/.pre-commit-config.yaml

@@ -0,0 +1,17 @@
+repos:
+  - repo: https://github.com/pre-commit/pre-commit-hooks
+    rev: "v4.4.0"
+    hooks:
+      - id: check-case-conflict
+      - id: check-merge-conflict
+      - id: check-toml
+      - id: check-yaml
+      # - id: end-of-file-fixer
+      # - id: trailing-whitespace
+
+  - repo: https://github.com/astral-sh/ruff-pre-commit
+    rev: "v0.6.3"
+    hooks:
+      - id: ruff
+        args: [--exit-non-zero-on-fix]
+      - id: ruff-format

hyperfast_uv_template-0.3.1/.copier-template/.python-version.jinja

@@ -0,0 +1 @@
+{{ python_version }}

hyperfast_uv_template-0.3.1/.copier-template/CHANGELOG.md

@@ -0,0 +1 @@
+<!--next-version-placeholder-->