From 066209c4ce22687d90ac030d2966c2e7ff687d2c Mon Sep 17 00:00:00 2001 From: Mystic <215104920@qq.com> Date: Fri, 20 Sep 2024 09:19:34 +0000 Subject: [PATCH] ci: Update python example --- .dockerignore | 10 ++ .editorconfig | 14 ++ .github/ISSUE_TEMPLATE/bug_report.md | 44 ++++++ .github/ISSUE_TEMPLATE/config.yml | 1 + .github/ISSUE_TEMPLATE/feature_request.md | 28 ++++ .github/PULL_REQUEST_TEMPLATE.md | 9 ++ .github/configs/labeler.yml | 63 ++++++++ .github/dependabot.yml | 8 + .github/renovate.json | 6 + .github/workflows/cd.yml | 14 ++ .github/workflows/ci.yml | 48 ++++++ .github/workflows/docker.yml | 54 +++++++ .github/workflows/labeler.yml | 15 ++ .github/workflows/release.yml | 60 ++++++++ .gitignore | 145 ++++++++++++++++++ .pre-commit-config.yaml | 33 ++++ CHANGELOG.md | 20 +++ CODE_OF_CONDUCT.md | 3 + CONTRIBUTING.md | 50 ++++++ Dockerfile | 44 ++++++ LICENSE-APACHE | 176 ++++++++++++++++++++++ LICENSE-MIT | 21 +++ Makefile | 60 ++++++++ README.md | 108 +++++++++++++ SECURITY.md | 25 +++ cliff.toml | 131 ++++++++++++++++ compose.yml | 13 ++ docs/development.md | 92 +++++++++++ docs/troubleshooting.md | 0 docs/usage.md | 0 pyproject.toml | 75 +++++++++ ruff.toml | 6 + src/example_py/__init__.py | 8 + src/example_py/app.py | 16 ++ src/example_py/example.py | 16 ++ tests/test_example.py | 63 ++++++++ 36 files changed, 1479 insertions(+) create mode 100644 .dockerignore create mode 100644 .editorconfig create mode 100644 .github/ISSUE_TEMPLATE/bug_report.md create mode 100644 .github/ISSUE_TEMPLATE/config.yml create mode 100644 .github/ISSUE_TEMPLATE/feature_request.md create mode 100644 .github/PULL_REQUEST_TEMPLATE.md create mode 100644 .github/configs/labeler.yml create mode 100644 .github/dependabot.yml create mode 100644 .github/renovate.json create mode 100644 .github/workflows/cd.yml create mode 100644 .github/workflows/ci.yml create mode 100644 .github/workflows/docker.yml create mode 100644 .github/workflows/labeler.yml create mode 100644 .github/workflows/release.yml create mode 100644 .gitignore create mode 100644 .pre-commit-config.yaml create mode 100644 CHANGELOG.md create mode 100644 CODE_OF_CONDUCT.md create mode 100644 CONTRIBUTING.md create mode 100644 Dockerfile create mode 100644 LICENSE-APACHE create mode 100644 LICENSE-MIT create mode 100644 Makefile create mode 100644 README.md create mode 100644 SECURITY.md create mode 100644 cliff.toml create mode 100644 compose.yml create mode 100644 docs/development.md create mode 100644 docs/troubleshooting.md create mode 100644 docs/usage.md create mode 100644 pyproject.toml create mode 100644 ruff.toml create mode 100644 src/example_py/__init__.py create mode 100644 src/example_py/app.py create mode 100644 src/example_py/example.py create mode 100644 tests/test_example.py diff --git a/.dockerignore b/.dockerignore new file mode 100644 index 0000000..84d2c6b --- /dev/null +++ b/.dockerignore @@ -0,0 +1,10 @@ +# all start with .(dot), including directories and files +.* +CHANGELOG.md +CODE_OF_CONDUCT.md +compose.yml +CONTRIBUTING.md +Dockerfile +LICENSE* +README.md +SECURITY.md diff --git a/.editorconfig b/.editorconfig new file mode 100644 index 0000000..3501d01 --- /dev/null +++ b/.editorconfig @@ -0,0 +1,14 @@ +root = true + +[*] +charset = utf-8 +end_of_line = lf +indent_size = 4 +indent_style = space +insert_final_newline = true +max_line_length = 120 +tab_width = 4 +trim_trailing_whitespace = true + +[Makefile] +indent_style = tab diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md new file mode 100644 index 0000000..43fe3c7 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug_report.md @@ -0,0 +1,44 @@ +--- +name: Bug report +about: Create a report to help us improve +title: 'bug: ' +labels: bug +assignees: '' + +--- + +## Bug description + + + +- Would you like to work on a fix? [y/n] + +## To Reproduce + +Steps to reproduce the behavior: + +1. ... +2. ... +3. ... +4. ... + + + +## Expected behavior + + + +## Screenshots + + + +## Environment + + + +- OS: [e.g. Ubuntu 20.04] +- example_py version: [e.g. 0.1.0] + +## Additional context + + diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml new file mode 100644 index 0000000..0086358 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/config.yml @@ -0,0 +1 @@ +blank_issues_enabled: true diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md new file mode 100644 index 0000000..9b061bb --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature_request.md @@ -0,0 +1,28 @@ +--- +name: Feature request +about: Suggest an idea for this project +title: 'Feature Request: ' +labels: enhancement +assignees: '' + +--- + +## Motivations + + + +- Would you like to implement this feature? [y/n] + +## Solution + + + +## Alternatives + + + +## Additional context + + diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md new file mode 100644 index 0000000..d107775 --- /dev/null +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -0,0 +1,9 @@ + + + diff --git a/.github/configs/labeler.yml b/.github/configs/labeler.yml new file mode 100644 index 0000000..f4ed978 --- /dev/null +++ b/.github/configs/labeler.yml @@ -0,0 +1,63 @@ +version: 1 + +labels: + # Type: Build-related changes + - label: "@type/build" + title: '^build(?:\(.+\))?\!?:' + + # Type: CI-related changes + - label: "@type/ci" + title: '^ci(?:\(.+\))?\!?:' + files: + - '\.github/.+' + + # Type: Documentation changes + - label: "@type/docs" + title: '^docs(?:\(.+\))?\!?:' + files: + - "docs/.+" + - "**/*.md" + + # Type: New feature + - label: "@type/feature" + title: '^feat(?:\(.+\))?\!?:' + + # Type: Bug fix + - label: "@type/fix" + title: '^fix(?:\(.+\))?\!?:' + + # Type: Improvements such as style changes, refactoring, or performance improvements + - label: "@type/improve" + title: '^(style|refactor|perf)(?:\(.+\))?\!?:' + + # Type: Dependency changes + - label: "@type/dependency" + title: '^(chore|build)(?:\(deps\))?\!?:' + + # Type: Test-related changes + - label: "@type/test" + title: '^test(?:\(.+\))?\!?:' + files: + - "tests/.+" + - "spec/.+" + + # Type: Security-related changes + - label: "@type/security" + title: '^security(?:\(.+\))?\!?:' + files: + - "**/security/.+" + + # Issue Type Only: Feature Request + - label: "Feature Request" + type: issue + title: "^Feature Request:" + + # Issue Type Only: Documentation + - label: "Documentation" + type: issue + title: "^.*(\b[Dd]ocumentation|doc(s)?\b).*" + + # Issue Type Only: Bug Report + - label: "Bug Report" + type: issue + title: "^.*(\b[Bb]ug|b(u)?g(s)?\b).*" diff --git a/.github/dependabot.yml b/.github/dependabot.yml new file mode 100644 index 0000000..c44b6f1 --- /dev/null +++ b/.github/dependabot.yml @@ -0,0 +1,8 @@ +version: 2 +updates: + - package-ecosystem: "github-actions" + directory: "/" + # Check for updates every Monday + schedule: + interval: "weekly" + open-pull-requests-limit: 10 diff --git a/.github/renovate.json b/.github/renovate.json new file mode 100644 index 0000000..f9c2c32 --- /dev/null +++ b/.github/renovate.json @@ -0,0 +1,6 @@ +{ + "$schema": "https://docs.renovatebot.com/renovate-schema.json", + "extends": [ + "config:base" + ] +} diff --git a/.github/workflows/cd.yml b/.github/workflows/cd.yml new file mode 100644 index 0000000..694b52f --- /dev/null +++ b/.github/workflows/cd.yml @@ -0,0 +1,14 @@ +name: CD # Continuous Deployment or Delivery + +on: + push: + # e.g. 1.0.0, v2.0.0, v0.1.0, v0.2.0-alpha, v0.3.0+build-71edf32 + tags: + - '[v]?[0-9]+\.[0-9]+\.[0-9]+.*' + +jobs: + dd: + name: Deploy or Delivery + runs-on: ubuntu-latest + steps: + - uses: actions/checkout@v4 diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml new file mode 100644 index 0000000..c5c6dd4 --- /dev/null +++ b/.github/workflows/ci.yml @@ -0,0 +1,48 @@ +name: CI # Continuous Integration + +on: + push: + branches: + - main + pull_request: + workflow_dispatch: + + +jobs: + build-and-test: + name: python-${{ matrix.os }} + + strategy: + matrix: + os: + - ubuntu-latest + - windows-latest + - macos-latest + + fail-fast: false + + runs-on: ${{ matrix.os }} + + steps: + - uses: actions/checkout@v4 + + - name: Set up uv + if: ${{ matrix.os == 'ubuntu-latest' || matrix.os == 'macos-latest' }} + run: curl -LsSf https://astral.sh/uv/install.sh | sh + + - name: Set up uv + if: ${{ matrix.os == 'windows-latest' }} + run: irm https://astral.sh/uv/install.ps1 | iex + shell: powershell + + - name: Format + run: uvx ruff format --diff . + + - name: Lint + run: uvx ruff check . + + - name: Build & Test + run: | + uv sync + uvx hatch build + uvx hatch test diff --git a/.github/workflows/docker.yml b/.github/workflows/docker.yml new file mode 100644 index 0000000..a170bb6 --- /dev/null +++ b/.github/workflows/docker.yml @@ -0,0 +1,54 @@ +name: Build and Push Docker Image + +on: + push: + tags: + - '^v[0-9]+\.[0-9]+\.[0-9]+.*$' + +jobs: + docker: + runs-on: ubuntu-latest + steps: + - + name: Checkout + uses: actions/checkout@v4 + - + name: Acquire tag name + run: echo "RELEASE_VERSION=${GITHUB_REF_NAME#refs/*/}" >> $GITHUB_ENV + - + name: Set up QEMU + uses: docker/setup-qemu-action@v3 + - + name: Set up Docker Buildx + uses: docker/setup-buildx-action@v3 + - + name: Login to GitHub Container Registry + uses: docker/login-action@v3 + with: + registry: ghcr.io + username: ${{ github.repository_owner }} + password: ${{ secrets.GITHUB_TOKEN }} + - + name: Build and Export to Docker + uses: docker/build-push-action@v6 + with: + context: . + load: true + tags: | + ghcr.io/x-pt/example-py:latest + ghcr.io/x-pt/example-py:${GITHUB_REF_NAME:1} + - + name: Test it before Push + run: | + docker run --rm ghcr.io/x-pt/example-py:latest + docker run --rm ghcr.io/x-pt/example-py:${GITHUB_REF_NAME:1} + - + name: Build and Push + uses: docker/build-push-action@v6 + with: + context: . + platforms: linux/amd64,linux/arm64 + push: true + tags: | + ghcr.io/x-pt/example-py:latest + ghcr.io/x-pt/example-py:${GITHUB_REF_NAME:1} diff --git a/.github/workflows/labeler.yml b/.github/workflows/labeler.yml new file mode 100644 index 0000000..91499a4 --- /dev/null +++ b/.github/workflows/labeler.yml @@ -0,0 +1,15 @@ +name: Labeler + +on: + - pull_request + - issues + +jobs: + labeler: + runs-on: ubuntu-latest + steps: + - uses: srvaroa/labeler@master + with: + config_path: .github/configs/labeler.yml + env: + GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} diff --git a/.github/workflows/release.yml b/.github/workflows/release.yml new file mode 100644 index 0000000..ef9d857 --- /dev/null +++ b/.github/workflows/release.yml @@ -0,0 +1,60 @@ +name: Example Py Release + +on: + push: + tags: + - "v*.*.*" + +jobs: + changelog: + runs-on: ubuntu-latest + steps: + - name: Checkout Code + uses: actions/checkout@v4 + with: + fetch-depth: 0 + + - name: Get Tag Version + id: tag_version + run: echo "CURRENT_TAG=${GITHUB_REF#refs/tags/}" >> $GITHUB_ENV + + - name: Generate Full Changelog + uses: orhun/git-cliff-action@v4 + with: + config: cliff.toml + args: --verbose + env: + OUTPUT: CHANGELOG.md + GITHUB_REPO: ${{ github.repository }} + + - name: Commit Changelog + run: | + git config user.name 'github-actions[bot]' + git config user.email 'github-actions[bot]@users.noreply.github.com' + set +e + git switch main + git add CHANGELOG.md + git commit -m "chore(release-bot): prepare for release notes on ${CURRENT_TAG}" + git push + + release: + runs-on: ubuntu-latest + steps: + - name: Checkout Code + uses: actions/checkout@v4 + with: + fetch-depth: 0 + + - name: Generate Latest Release Notes + id: latest_release_notes + uses: orhun/git-cliff-action@v4 + with: + config: cliff.toml + args: --latest --strip all + env: + OUTPUT: CHANGELOG.txt + + - name: Create GitHub Release + uses: softprops/action-gh-release@v2 + with: + body_path: CHANGELOG.txt diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..c936a10 --- /dev/null +++ b/.gitignore @@ -0,0 +1,145 @@ +### Custom +.idea +.vscode +.DS_Store + +### Python template +# 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 +coverage.lcov +*.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 + +# PEP 582; used by e.g. github.com/David-OConnor/pyflow +__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/ diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml new file mode 100644 index 0000000..d82d3bb --- /dev/null +++ b/.pre-commit-config.yaml @@ -0,0 +1,33 @@ +fail_fast: true + +repos: + - repo: https://github.com/pre-commit/pre-commit-hooks + rev: v4.6.0 + hooks: + - id: check-merge-conflict + - id: check-toml + - id: check-yaml + - id: end-of-file-fixer + - id: mixed-line-ending + args: [ --fix=lf ] + - id: trailing-whitespace + - repo: https://github.com/crate-ci/typos + rev: v1.24.6 + hooks: + - id: typos + - repo: https://github.com/commitizen-tools/commitizen + rev: v3.29.0 + hooks: + - id: commitizen + - id: commitizen-branch + stages: [ push ] + - repo: https://github.com/astral-sh/ruff-pre-commit + rev: v0.6.5 + hooks: + - id: ruff-format + - id: ruff + args: [--fix, --exit-non-zero-on-fix] + - repo: https://github.com/astral-sh/uv-pre-commit + rev: 0.4.12 + hooks: + - id: uv-lock diff --git a/CHANGELOG.md b/CHANGELOG.md new file mode 100644 index 0000000..f8863f8 --- /dev/null +++ b/CHANGELOG.md @@ -0,0 +1,20 @@ +# Changelog + +All notable changes to this project will be documented in this file. + +The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/), +and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html). + +## [Unreleased] + +### Added + +- support some features + +### Changed + +- change some existed behaviors/logic + +### Fixed + +- fix some bugs diff --git a/CODE_OF_CONDUCT.md b/CODE_OF_CONDUCT.md new file mode 100644 index 0000000..0e57c81 --- /dev/null +++ b/CODE_OF_CONDUCT.md @@ -0,0 +1,3 @@ +# Code of Conduct + +This project adheres to the Python Code of Conduct, which can be found [here](https://www.python.org/psf/conduct/). diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..99101ef --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,50 @@ +# Contribution guidelines + +First off, thank you for considering contributing to `example-py`. + +If your contribution is not straightforward, please first discuss the change you +wish to make by creating a new issue before making the change. + +## Reporting issues + +Before reporting an issue on the +[issue tracker](https://github.com/x-pt/example-py/issues), +please check that it has not already been reported by searching for some related +keywords. + +## Pull requests + +Try to do one pull request per change. + +### Updating the changelog + +Update the changes you have made in +[CHANGELOG](CHANGELOG.md) +file under the **Unreleased** section. + +Add the changes of your pull request to one of the following subsections, +depending on the types of changes defined by +[Keep a changelog](https://keepachangelog.com/en/1.0.0/): + +- `Added` for new features. +- `Changed` for changes in existing functionality. +- `Deprecated` for soon-to-be removed features. +- `Removed` for now removed features. +- `Fixed` for any bug fixes. +- `Security` in case of vulnerabilities. + +If the required subsection does not exist yet under **Unreleased**, create it! + +## Developing + +### Set up + +This is no different from other Python projects. + +```shell +git clone https://github.com/x-pt/example-py +cd example-py +make test +``` + +### Useful Commands diff --git a/Dockerfile b/Dockerfile new file mode 100644 index 0000000..6e6a495 --- /dev/null +++ b/Dockerfile @@ -0,0 +1,44 @@ +# Base image for building the virtual environment +FROM python:3.11-bookworm AS builder + +ENV PATH="/root/.cargo/bin:$PATH" \ + UV_INDEX_URL="https://mirrors.cernet.edu.cn/pypi/web/simple" \ + PIP_INDEX_URL="https://mirrors.cernet.edu.cn/pypi/web/simple" + +# Install uv and tools +RUN curl -LsSf https://astral.sh/uv/install.sh | sh + +WORKDIR /app + +COPY pyproject.toml . + +# Create and install dependencies in the virtual environment +RUN uv sync + +# Separate stage for validation (build and test) +FROM builder AS validator + +WORKDIR /app +COPY . . + +# Run build and test as part of the validation +RUN make build && make test + +# Final image for running the application +FROM python:3.11-slim-bookworm + +LABEL author="X Author Name" + +ENV PATH="/app/.venv/bin:$PATH" \ + PYTHONDONTWRITEBYTECODE=1 \ + PYTHONUNBUFFERED=1 + +WORKDIR /app + +# Copy the virtual environment and application code +COPY --from=builder /app/.venv /app/.venv +COPY src ./src + +HEALTHCHECK --start-period=30s CMD python -c "import requests; requests.get('http://localhost:8000', timeout=2)" + +CMD ["python", "src/example_py/app.py"] diff --git a/LICENSE-APACHE b/LICENSE-APACHE new file mode 100644 index 0000000..1b5ec8b --- /dev/null +++ b/LICENSE-APACHE @@ -0,0 +1,176 @@ + Apache License + Version 2.0, January 2004 + http://www.apache.org/licenses/ + +TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION + +1. Definitions. + + "License" shall mean the terms and conditions for use, reproduction, + and distribution as defined by Sections 1 through 9 of this document. + + "Licensor" shall mean the copyright owner or entity authorized by + the copyright owner that is granting the License. + + "Legal Entity" shall mean the union of the acting entity and all + other entities that control, are controlled by, or are under common + control with that entity. For the purposes of this definition, + "control" means (i) the power, direct or indirect, to cause the + direction or management of such entity, whether by contract or + otherwise, or (ii) ownership of fifty percent (50%) or more of the + outstanding shares, or (iii) beneficial ownership of such entity. + + "You" (or "Your") shall mean an individual or Legal Entity + exercising permissions granted by this License. + + "Source" form shall mean the preferred form for making modifications, + including but not limited to software source code, documentation + source, and configuration files. + + "Object" form shall mean any form resulting from mechanical + transformation or translation of a Source form, including but + not limited to compiled object code, generated documentation, + and conversions to other media types. + + "Work" shall mean the work of authorship, whether in Source or + Object form, made available under the License, as indicated by a + copyright notice that is included in or attached to the work + (an example is provided in the Appendix below). + + "Derivative Works" shall mean any work, whether in Source or Object + form, that is based on (or derived from) the Work and for which the + editorial revisions, annotations, elaborations, or other modifications + represent, as a whole, an original work of authorship. For the purposes + of this License, Derivative Works shall not include works that remain + separable from, or merely link (or bind by name) to the interfaces of, + the Work and Derivative Works thereof. + + "Contribution" shall mean any work of authorship, including + the original version of the Work and any modifications or additions + to that Work or Derivative Works thereof, that is intentionally + submitted to Licensor for inclusion in the Work by the copyright owner + or by an individual or Legal Entity authorized to submit on behalf of + the copyright owner. For the purposes of this definition, "submitted" + means any form of electronic, verbal, or written communication sent + to the Licensor or its representatives, including but not limited to + communication on electronic mailing lists, source code control systems, + and issue tracking systems that are managed by, or on behalf of, the + Licensor for the purpose of discussing and improving the Work, but + excluding communication that is conspicuously marked or otherwise + designated in writing by the copyright owner as "Not a Contribution." + + "Contributor" shall mean Licensor and any individual or Legal Entity + on behalf of whom a Contribution has been received by Licensor and + subsequently incorporated within the Work. + +2. Grant of Copyright License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + copyright license to reproduce, prepare Derivative Works of, + publicly display, publicly perform, sublicense, and distribute the + Work and such Derivative Works in Source or Object form. + +3. Grant of Patent License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + (except as stated in this section) patent license to make, have made, + use, offer to sell, sell, import, and otherwise transfer the Work, + where such license applies only to those patent claims licensable + by such Contributor that are necessarily infringed by their + Contribution(s) alone or by combination of their Contribution(s) + with the Work to which such Contribution(s) was submitted. If You + institute patent litigation against any entity (including a + cross-claim or counterclaim in a lawsuit) alleging that the Work + or a Contribution incorporated within the Work constitutes direct + or contributory patent infringement, then any patent licenses + granted to You under this License for that Work shall terminate + as of the date such litigation is filed. + +4. Redistribution. You may reproduce and distribute copies of the + Work or Derivative Works thereof in any medium, with or without + modifications, and in Source or Object form, provided that You + meet the following conditions: + + (a) You must give any other recipients of the Work or + Derivative Works a copy of this License; and + + (b) You must cause any modified files to carry prominent notices + stating that You changed the files; and + + (c) You must retain, in the Source form of any Derivative Works + that You distribute, all copyright, patent, trademark, and + attribution notices from the Source form of the Work, + excluding those notices that do not pertain to any part of + the Derivative Works; and + + (d) If the Work includes a "NOTICE" text file as part of its + distribution, then any Derivative Works that You distribute must + include a readable copy of the attribution notices contained + within such NOTICE file, excluding those notices that do not + pertain to any part of the Derivative Works, in at least one + of the following places: within a NOTICE text file distributed + as part of the Derivative Works; within the Source form or + documentation, if provided along with the Derivative Works; or, + within a display generated by the Derivative Works, if and + wherever such third-party notices normally appear. The contents + of the NOTICE file are for informational purposes only and + do not modify the License. You may add Your own attribution + notices within Derivative Works that You distribute, alongside + or as an addendum to the NOTICE text from the Work, provided + that such additional attribution notices cannot be construed + as modifying the License. + + You may add Your own copyright statement to Your modifications and + may provide additional or different license terms and conditions + for use, reproduction, or distribution of Your modifications, or + for any such Derivative Works as a whole, provided Your use, + reproduction, and distribution of the Work otherwise complies with + the conditions stated in this License. + +5. Submission of Contributions. Unless You explicitly state otherwise, + any Contribution intentionally submitted for inclusion in the Work + by You to the Licensor shall be under the terms and conditions of + this License, without any additional terms or conditions. + Notwithstanding the above, nothing herein shall supersede or modify + the terms of any separate license agreement you may have executed + with Licensor regarding such Contributions. + +6. Trademarks. This License does not grant permission to use the trade + names, trademarks, service marks, or product names of the Licensor, + except as required for reasonable and customary use in describing the + origin of the Work and reproducing the content of the NOTICE file. + +7. Disclaimer of Warranty. Unless required by applicable law or + agreed to in writing, Licensor provides the Work (and each + Contributor provides its Contributions) on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or + implied, including, without limitation, any warranties or conditions + of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A + PARTICULAR PURPOSE. You are solely responsible for determining the + appropriateness of using or redistributing the Work and assume any + risks associated with Your exercise of permissions under this License. + +8. Limitation of Liability. In no event and under no legal theory, + whether in tort (including negligence), contract, or otherwise, + unless required by applicable law (such as deliberate and grossly + negligent acts) or agreed to in writing, shall any Contributor be + liable to You for damages, including any direct, indirect, special, + incidental, or consequential damages of any character arising as a + result of this License or out of the use or inability to use the + Work (including but not limited to damages for loss of goodwill, + work stoppage, computer failure or malfunction, or any and all + other commercial damages or losses), even if such Contributor + has been advised of the possibility of such damages. + +9. Accepting Warranty or Additional Liability. While redistributing + the Work or Derivative Works thereof, You may choose to offer, + and charge a fee for, acceptance of support, warranty, indemnity, + or other liability obligations and/or rights consistent with this + License. However, in accepting such obligations, You may act only + on Your own behalf and on Your sole responsibility, not on behalf + of any other Contributor, and only if You agree to indemnify, + defend, and hold each Contributor harmless for any liability + incurred by, or claims asserted against, such Contributor by reason + of your accepting any such warranty or additional liability. + +END OF TERMS AND CONDITIONS diff --git a/LICENSE-MIT b/LICENSE-MIT new file mode 100644 index 0000000..38b41f0 --- /dev/null +++ b/LICENSE-MIT @@ -0,0 +1,21 @@ +MIT License + +Copyright (c) 2024 X Author Name + +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. diff --git a/Makefile b/Makefile new file mode 100644 index 0000000..bc41ec3 --- /dev/null +++ b/Makefile @@ -0,0 +1,60 @@ +.PHONY: help build test ruff image clean +.DEFAULT_GOAL := help + +APP_NAME := example-py + +# Init the venv +init: sync + @uvx pre-commit install --hook-type commit-msg --hook-type pre-push + +# Sync the project with the venv +sync: + @uv sync + +# Build wheel +build: + @uvx hatch build + +# Test +test: + @uvx hatch test + +# Ruff +ruff: + @uvx ruff format . + @uvx ruff check . --fix + +# Build image +image: + @docker image build -t $(APP_NAME) . + +# Start a compose service +compose-up: + @docker compose -f ./compose.yml -p $(APP_NAME) up -d + +# Shutdown a compose service +compose-down: + @docker compose -f ./compose.yml down + +# Clean build artifacts +clean: + @rm -rf build dist *.egg-info htmlcov .coverage coverage.xml coverage.lcov + @docker compose -f ./compose.yml down -v + @docker image rm -f $(APP_NAME) + +# Show help +help: + @echo "" + @echo "Usage:" + @echo " make [target]" + @echo "" + @echo "Targets:" + @awk '/^[a-zA-Z\-_0-9]+:/ \ + { \ + helpMessage = match(lastLine, /^# (.*)/); \ + if (helpMessage) { \ + helpCommand = substr($$1, 0, index($$1, ":")-1); \ + helpMessage = substr(lastLine, RSTART + 2, RLENGTH); \ + printf "\033[36m%-22s\033[0m %s\n", helpCommand,helpMessage; \ + } \ + } { lastLine = $$0 }' $(MAKEFILE_LIST) diff --git a/README.md b/README.md new file mode 100644 index 0000000..a693545 --- /dev/null +++ b/README.md @@ -0,0 +1,108 @@ +# example-py + +[![CI](https://github.com/x-pt/example-py/workflows/CI/badge.svg)](https://github.com/x-pt/example-py/actions) +[![Coverage Status](https://coveralls.io/repos/github/x-pt/example-py/badge.svg?branch=main)](https://coveralls.io/github/x-pt/example-py?branch=main) +[![PyPI version](https://badge.fury.io/py/example-py.svg)](https://badge.fury.io/py/example-py) +[![Python Versions](https://img.shields.io/pypi/pyversions/example-py.svg)](https://pypi.org/project/example-py/) + +## Table of Contents + +- [Overview](#overview) +- [Features](#features) +- [Quick Start](#quick-start) +- [Installation](#installation) +- [Usage](#usage) +- [Development](#development) +- [Troubleshooting](#troubleshooting) +- [Contributing](#contributing) +- [License](#license) +- [Changelog](#changelog) +- [Contact](#contact) +- [Acknowledgements](#acknowledgements) + +## Overview + +`example-py` is a Python project designed to [brief description of the project's main purpose or functionality]. This project aims to [explain the primary goals or problems it solves]. + +## Features + +- **Feature 1**: [Detailed description of feature 1 and its benefits] +- **Feature 2**: [Detailed description of feature 2 and its benefits] +- **Feature 3**: [Detailed description of feature 3 and its benefits] +- [Add more features as needed] + +## Quick Start + +```python +import example-py + +# Example usage +result = example-py.do_something() +print(result) + +# Add more examples showcasing key features +``` + +## Installation + +### Requirements +- Python 3.11+ +- Dependencies: + - [Dependency 1]: [version] - [brief description or purpose] + - [Dependency 2]: [version] - [brief description or purpose] + - [Add more dependencies as needed] + +### User Installation +Install `example-py` using pip: + +```bash +pip install example-py +``` + +## Usage + +Here's a brief overview of basic usage: + +```python +import example-py + +# Example usage +result = example-py.do_something() +print(result) + +``` + +For more detailed examples and explanations of key concepts, please refer to our comprehensive [Usage Guide](docs/usage.md). + +## Development + +For information on setting up the development environment, running tests, and contributing to the project, please refer to our [Development Guide](docs/development.md). + +## Troubleshooting + +If you encounter any issues while using `example-py`, please check our [Troubleshooting Guide](docs/troubleshooting.md) for common problems and their solutions. If you can't find a solution to your problem, please [open an issue](https://github.com/x-pt/example-py/issues) on our GitHub repository. + +## Contributing + +We welcome contributions! Please see our [Contributing Guide](CONTRIBUTING.md) for details on how to submit pull requests, report issues, or suggest improvements. + +## License + +This project is licensed under either of: + +- Apache License, Version 2.0 ([LICENSE-APACHE](LICENSE-APACHE) or http://www.apache.org/licenses/LICENSE-2.0) +- MIT license ([LICENSE-MIT](LICENSE-MIT) or http://opensource.org/licenses/MIT) + +at your option. + +## Changelog + +For a detailed history of changes to this project, please refer to our [CHANGELOG.md](CHANGELOG.md). + +## Contact + +[Provide information on how to contact the maintainers or where to ask questions] + +## Acknowledgements + +[Acknowledge contributors, inspirations, or resources used in the project] diff --git a/SECURITY.md b/SECURITY.md new file mode 100644 index 0000000..abdcf15 --- /dev/null +++ b/SECURITY.md @@ -0,0 +1,25 @@ +# Security Policy + +## Supported Versions + + + +| Version | Supported | +|---------|--------------------| +| 5.1.x | :white_check_mark: | +| 5.0.x | :x: | +| 4.0.x | :white_check_mark: | +| < 4.0 | :x: | + +## Reporting a Vulnerability + + diff --git a/cliff.toml b/cliff.toml new file mode 100644 index 0000000..78db664 --- /dev/null +++ b/cliff.toml @@ -0,0 +1,131 @@ +# git-cliff ~ default configuration file +# https://git-cliff.org/docs/configuration +# +# Lines starting with "#" are comments. +# Configuration options are organized into tables and keys. +# See documentation for more information on available options. + +[remote.github] +owner = "x-pt" +repo = "example-py" + +[changelog] +# template for the changelog footer +header = """ +# Changelog\n +All notable changes to this project will be documented in this file.\n +""" +# template for the changelog body +# https://keats.github.io/tera/docs/#introduction +body = """ +{%- macro remote_url() -%} + https://github.com/{{ remote.github.owner }}/{{ remote.github.repo }} +{%- endmacro -%} + +{% macro print_commit(commit) -%} + - {% if commit.scope %}*({{ commit.scope }})* {% endif %}\ + {% if commit.breaking %}[**breaking**] {% endif %}\ + {{ commit.message | upper_first }} - \ + ([{{ commit.id | truncate(length=7, end="") }}]({{ self::remote_url() }}/commit/{{ commit.id }}))\ +{% endmacro -%} + +{% if version %}\ + {% if previous.version %}\ + ## [{{ version | trim_start_matches(pat="v") }}]\ + ({{ self::remote_url() }}/compare/{{ previous.version }}..{{ version }}) - {{ timestamp | date(format="%Y-%m-%d") }} + {% else %}\ + ## [{{ version | trim_start_matches(pat="v") }}] - {{ timestamp | date(format="%Y-%m-%d") }} + {% endif %}\ +{% else %}\ + ## [unreleased] +{% endif %}\ + +{% for group, commits in commits | group_by(attribute="group") %} + ### {{ group | striptags | trim | upper_first }} + {% for commit in commits + | filter(attribute="scope") + | sort(attribute="scope") %} + {{ self::print_commit(commit=commit) }} + {%- endfor %} + {% for commit in commits %} + {%- if not commit.scope -%} + {{ self::print_commit(commit=commit) }} + {% endif -%} + {% endfor -%} +{% endfor -%} +{%- if github -%} +{% if github.contributors | filter(attribute="is_first_time", value=true) | length != 0 %} + ## New Contributors ❀️ +{% endif %}\ +{% for contributor in github.contributors | filter(attribute="is_first_time", value=true) %} + * @{{ contributor.username }} made their first contribution + {%- if contributor.pr_number %} in \ + [#{{ contributor.pr_number }}]({{ self::remote_url() }}/pull/{{ contributor.pr_number }}) \ + {%- endif %} +{%- endfor -%} +{%- endif %} + + +""" + +# template for the changelog footer +footer = """ + +""" +# remove the leading and trailing s +trim = true +# postprocessors +postprocessors = [ + { pattern = '', replace = "https://github.com/x-pt/example-py" }, # replace repository URL +] + +[git] +# parse the commits based on https://www.conventionalcommits.org +conventional_commits = true +# filter out the commits that are not conventional +filter_unconventional = true +# process each line of a commit as an individual commit +split_commits = false +# regex for preprocessing the commit messages +commit_preprocessors = [ + # Replace issue numbers + { pattern = '\((\w+\s)?#([0-9]+)\)', replace = "([#${2}](/issues/${2}))"}, + # Check spelling of the commit with https://github.com/crate-ci/typos + # If the spelling is incorrect, it will be automatically fixed. + #{ pattern = '.*', replace_command = 'typos --write-changes -' }, +] +# regex for parsing and grouping commits +commit_parsers = [ + { message = "^feat", group = "πŸš€ Features" }, + { message = "^fix", group = "πŸ› Bug Fixes" }, + { message = "^doc", group = "πŸ“š Documentation" }, + { message = "^perf", group = "⚑ Performance" }, + { message = "^refactor", group = "🚜 Refactor" }, + { message = "^style", group = "🎨 Styling" }, + { message = "^test", group = "πŸ§ͺ Testing" }, + { message = "^chore\\(release\\): prepare for", skip = true }, + { message = "^chore\\(release-bot\\): prepare for", skip = true }, + { message = "^chore: bump version to", skip = true }, + { message = "^chore\\(deps.*\\)", skip = true }, + { message = "^chore\\(pr\\)", skip = true }, + { message = "^chore\\(pull\\)", skip = true }, + { message = "^chore|^ci", group = "βš™οΈ Miscellaneous Tasks" }, + { body = ".*security", group = "πŸ›‘οΈ Security" }, + { message = "^revert", group = "◀️ Revert" }, +] +# protect breaking changes from being skipped due to matching a skipping commit_parser +protect_breaking_commits = false +# filter out the commits that are not matched by commit parsers +filter_commits = false +# regex for matching git tags +# tag_pattern = "v[0-9].*" +# regex for skipping tags +# skip_tags = "" +# regex for ignoring tags +# ignore_tags = "" +# sort the tags topologically +topo_order = false +# sort the commits inside sections by oldest/newest order +sort_commits = "newest" +# limit the number of commits included in the changelog. +# limit_commits = 42 diff --git a/compose.yml b/compose.yml new file mode 100644 index 0000000..12929a4 --- /dev/null +++ b/compose.yml @@ -0,0 +1,13 @@ +services: + example-py: + build: . + image: example-py + ports: + - 8000:8000 + +networks: + example-py-net: + name: example-py-net + ipam: + config: + - subnet: 172.16.238.0/24 diff --git a/docs/development.md b/docs/development.md new file mode 100644 index 0000000..9cca28a --- /dev/null +++ b/docs/development.md @@ -0,0 +1,92 @@ +# Development Guide for example-py + +Welcome to the development guide for `example-py`! +This document will walk you through setting up your development environment, running tests, building the project, and maintaining code quality. + +## Table of Contents + +- [Setting Up the Development Environment](#setting-up-the-development-environment) + - [Prerequisites](#prerequisites) + - [Installation Steps](#installation-steps) +- [Running Tests](#running-tests) +- [Building the Project](#building-the-project) +- [Code Style and Linting](#code-style-and-linting) + +## Setting Up the Development Environment + +### Prerequisites + +Before you start, make sure you have the following installed on your system: + +- **Python 3.11+**: Ensure you have the correct version of Python. You can check your Python version with: + + ```bash + python --version + ``` + +- **`uv` tool**: This tool helps manage your Python environment. + + - **macOS and Linux**: + + ```bash + curl -LsSf https://astral.sh/uv/install.sh | sh + ``` + + - **Windows**: + + ```bash + powershell -c "irm https://astral.sh/uv/install.ps1 | iex" + ``` + +### Installation Steps + +1. **Clone the Repository**: Start by cloning the project repository to your local machine and navigate to the project directory: + + ```bash + git clone https://github.com/x-pt/example-py.git + cd example-py + ``` + +2. **Initialize the Development Environment**: This command sets up a virtual environment and installs all necessary dependencies. + + ```bash + make init + ``` + + This step will also install any pre-commit hooks, ensuring your code adheres to the project’s coding standards before each commit. + +## Running Tests + +Tests are crucial to ensure the stability of the project. To run all tests, use the following command: + +```bash +make test +``` + +This command will execute the test suite using `pytest`, ensuring all components work as expected. + +[Consider adding specific details on the structure of tests, testing strategy, or how to add new tests.] + +## Building the Project + +To build the project and create a distributable package, use: + +```bash +make build +``` + +This command will generate a `.whl` file in the `dist` directory, which can be used to distribute and install the project. + +## Code Style and Linting + +Maintaining consistent code style is essential. We use `ruff` for linting and formatting. To check for any style issues, run: + +```bash +make ruff +``` + +This command will automatically check and optionally fix any code style issues according to the project's style guide. + +--- + +By following this guide, you'll be well on your way to contributing to `example-py`. Thank you for your efforts in maintaining and improving this project! diff --git a/docs/troubleshooting.md b/docs/troubleshooting.md new file mode 100644 index 0000000..e69de29 diff --git a/docs/usage.md b/docs/usage.md new file mode 100644 index 0000000..e69de29 diff --git a/pyproject.toml b/pyproject.toml new file mode 100644 index 0000000..e9790b7 --- /dev/null +++ b/pyproject.toml @@ -0,0 +1,75 @@ +[build-system] +requires = ["hatchling"] +build-backend = "hatchling.build" + +[project] +name = "example-py" +version = "0.0.1" +description = "A nice example project" +requires-python = ">=3.11" +license = "MIT" +authors = [ + { name = "X Author Name" }, +] +classifiers = [ + "Development Status :: 4 - Beta", + "Programming Language :: Python :: 3.11", +] +dependencies = [ + "pytest>=8.0", + "pytest-cov>=5.0", +] + +[project.optional-dependencies] +dev = [ + "ruff>=0.5.0", +] + +[project.urls] +Documentation = "https://github.com/x-pt/example-py#readme" +Issues = "https://github.com/x-pt/example-py/issues" +Source = "https://github.com/x-pt/example-py" + +[tool.hatch.build.targets.wheel] +packages = ["src/example_py"] + +[tool.pytest.ini_options] +minversion = "6.0" +addopts = [ + "-ra", # show all captured stdout/stderr + "-q", # quiet + "--cov=example-py", # report coverage of example-py + "--cov-report=term-missing", # show missing coverage + "--cov-report=html", # generate html coverage report + "--cov-report=lcov", # generate lcov coverage report +] +testpaths = ["tests"] +python_files = ["test_*.py", "*_test.py"] +python_functions = ["test_*"] +markers = [ + "integration: marks tests as integration tests (deselect with '-m \"not integration\"')", +] + +[tool.coverage.run] +source_pkgs = ["example_py"] +branch = true +parallel = true +omit = [ + "*/.venv/*" +] + +[tool.coverage.paths] +example_py = ["src/example_py", "*/example-py/src/example_py"] +tests = ["tests", "*/example-py/tests"] + +[tool.coverage.report] +exclude_lines = [ + "no cov", + "if __name__ == .__main__.:", + "if TYPE_CHECKING:", +] +show_missing = true # Show missing lines in the report +precision = 2 # Number of decimal places to use when rounding + +[tool.uv.pip] +index-url = "https://mirrors.cernet.edu.cn/pypi/web/simple" diff --git a/ruff.toml b/ruff.toml new file mode 100644 index 0000000..f836274 --- /dev/null +++ b/ruff.toml @@ -0,0 +1,6 @@ +target-version = "py311" +line-length = 120 + +[lint] +select = ["E", "F", "W", "C", "N", "Q", "I"] +ignore = [] diff --git a/src/example_py/__init__.py b/src/example_py/__init__.py new file mode 100644 index 0000000..1ccfdd0 --- /dev/null +++ b/src/example_py/__init__.py @@ -0,0 +1,8 @@ +from .example import add, divide, multiply, subtract + +__all__ = [ + "add", + "subtract", + "multiply", + "divide", +] diff --git a/src/example_py/app.py b/src/example_py/app.py new file mode 100644 index 0000000..26377bc --- /dev/null +++ b/src/example_py/app.py @@ -0,0 +1,16 @@ +from http.server import HTTPServer, SimpleHTTPRequestHandler + + +def run_server(port=8000): + handler = SimpleHTTPRequestHandler + with HTTPServer(("", port), handler) as httpd: + print(f"Serving at port {port}") + try: + httpd.serve_forever() + except KeyboardInterrupt: + print("\nShutting down the server...") + httpd.shutdown() + + +if __name__ == "__main__": + run_server() diff --git a/src/example_py/example.py b/src/example_py/example.py new file mode 100644 index 0000000..8688106 --- /dev/null +++ b/src/example_py/example.py @@ -0,0 +1,16 @@ +def add(a, b): + return a + b + + +def subtract(a, b): + return a - b + + +def multiply(a, b): + return a * b + + +def divide(a, b): + if b == 0: + raise ValueError("Division by zero is not allowed.") + return a / b diff --git a/tests/test_example.py b/tests/test_example.py new file mode 100644 index 0000000..e69dceb --- /dev/null +++ b/tests/test_example.py @@ -0,0 +1,63 @@ +import pytest + +from example_py import add, divide, multiply, subtract + + +@pytest.mark.parametrize( + "a, b, expected", + [ + (1, 2, 3), + (0, 0, 0), + (-1, -1, -2), + ], +) +def test_add(a, b, expected): + assert add(a, b) == expected + + +@pytest.mark.parametrize( + "a, b, expected", + [ + (1, 2, -1), + (0, 0, 0), + (-1, -1, 0), + ], +) +def test_subtract(a, b, expected): + assert subtract(a, b) == expected + + +@pytest.mark.parametrize( + "a, b, expected", + [ + (1, 2, 2), + (0, 0, 0), + (-1, -1, 1), + ], +) +def test_multiply(a, b, expected): + assert multiply(a, b) == expected + + +@pytest.mark.parametrize( + "a, b, expected", + [ + (1, 2, 0.5), + (-1, -1, 1), + ], +) +def test_divide(a, b, expected): + assert divide(a, b) == expected + + +@pytest.mark.parametrize( + "a, b", + [ + (0, 0), + (10, 0), + (-10, 0), + ], +) +def test_divide_by_zero(a, b): + with pytest.raises(ValueError, match="Division by zero is not allowed."): + divide(a, b)