From a9095e8c6896c367ff9ff1ca52793c7afe0139d8 Mon Sep 17 00:00:00 2001 From: franneck94 Date: Fri, 16 Feb 2024 19:39:07 +0100 Subject: [PATCH] updated to new configs --- .github/workflows/codecov.yml | 29 --------- .github/workflows/codeql-analysis.yaml | 30 ++++++++++ .github/workflows/documentation.yaml | 19 ++++++ .github/workflows/pre-commit.yaml | 17 ++++++ .../workflows/{publish.yml => publish.yaml} | 12 ++-- .github/workflows/ruff.yml | 8 --- .github/workflows/test.yaml | 60 +++++++++++++++++++ .github/workflows/test.yml | 28 --------- mkdocs.yaml | 37 ++++++++++++ mkdocs.yml | 20 ------- pyproject.toml | 8 +-- requirements-dev.txt | 42 ++++++++----- requirements.txt | 2 + 13 files changed, 201 insertions(+), 111 deletions(-) delete mode 100644 .github/workflows/codecov.yml create mode 100644 .github/workflows/codeql-analysis.yaml create mode 100644 .github/workflows/documentation.yaml create mode 100644 .github/workflows/pre-commit.yaml rename .github/workflows/{publish.yml => publish.yaml} (70%) delete mode 100644 .github/workflows/ruff.yml create mode 100644 .github/workflows/test.yaml delete mode 100644 .github/workflows/test.yml create mode 100644 mkdocs.yaml delete mode 100644 mkdocs.yml diff --git a/.github/workflows/codecov.yml b/.github/workflows/codecov.yml deleted file mode 100644 index 7edfbe9..0000000 --- a/.github/workflows/codecov.yml +++ /dev/null @@ -1,29 +0,0 @@ -name: Codecov - -on: - push: - branches: [ main, dev ] - pull_request: - branches: [ main, dev ] - -jobs: - build: - - runs-on: ubuntu-latest - - steps: - - uses: actions/checkout@v2 - - name: Set up Python 3.10 - uses: actions/setup-python@v2 - with: - python-version: "3.10" - - name: Install dependencies - run: | - python -m pip install --upgrade pip - pip install -r requirements.txt - pip install -r requirements-dev.txt - python setup.py develop - - name: Coverage - run: | - pytest --cov=tensorcross tests - codecov diff --git a/.github/workflows/codeql-analysis.yaml b/.github/workflows/codeql-analysis.yaml new file mode 100644 index 0000000..7a78c9d --- /dev/null +++ b/.github/workflows/codeql-analysis.yaml @@ -0,0 +1,30 @@ +name: "CodeQL" + +on: + release: + types: [created] + +jobs: + analyze: + name: Analyze + runs-on: ubuntu-latest + + strategy: + fail-fast: false + matrix: + language: ['python'] + + steps: + - name: Checkout repository + uses: actions/checkout@v2 + + - name: Initialize CodeQL + uses: github/codeql-action/init@v2 + with: + languages: ${{ matrix.language }} + + - name: Autobuild + uses: github/codeql-action/autobuild@v2 + + - name: Perform CodeQL Analysis + uses: github/codeql-action/analyze@v2 diff --git a/.github/workflows/documentation.yaml b/.github/workflows/documentation.yaml new file mode 100644 index 0000000..24672b1 --- /dev/null +++ b/.github/workflows/documentation.yaml @@ -0,0 +1,19 @@ +name: Documentation + +on: + release: + types: [created] + +jobs: + deploy: + runs-on: ubuntu-latest + steps: + - uses: actions/checkout@v2 + - uses: actions/setup-python@v2 + with: + python-version: 3.11 + - run: | + python -m pip install --upgrade pip + pip install -r requirements-dev.txt + pip install -e . + - run: mkdocs gh-deploy --force diff --git a/.github/workflows/pre-commit.yaml b/.github/workflows/pre-commit.yaml new file mode 100644 index 0000000..8d4b9e8 --- /dev/null +++ b/.github/workflows/pre-commit.yaml @@ -0,0 +1,17 @@ +name: pre-commit + +on: + pull_request: + push: + branches: [ main, master ] + +jobs: + pre-commit: + runs-on: ubuntu-latest + steps: + - uses: actions/checkout@v2 + - name: Set up Python + uses: actions/setup-python@v2 + with: + python-version: '3.11' + - uses: pre-commit/action@v2.0.0 diff --git a/.github/workflows/publish.yml b/.github/workflows/publish.yaml similarity index 70% rename from .github/workflows/publish.yml rename to .github/workflows/publish.yaml index 1e5da15..3a99bf2 100644 --- a/.github/workflows/publish.yml +++ b/.github/workflows/publish.yaml @@ -6,24 +6,24 @@ on: jobs: deploy: - runs-on: ubuntu-latest - steps: - uses: actions/checkout@v2 - name: Set up Python uses: actions/setup-python@v2 with: - python-version: "3.10" + python-version: '3.11' - name: Install dependencies run: | python -m pip install --upgrade pip + pip install --upgrade setuptools + pip install --upgrade build + pip install --upgrade twine pip install -r requirements.txt - pip install -r requirements-dev.txt - name: Build and publish env: TWINE_USERNAME: ${{ secrets.PYPI_USERNAME }} TWINE_PASSWORD: ${{ secrets.PYPI_PASSWORD }} run: | - python setup.py sdist bdist_wheel - twine upload dist/* + python -m build + python -m twine upload dist/* diff --git a/.github/workflows/ruff.yml b/.github/workflows/ruff.yml deleted file mode 100644 index 757cae6..0000000 --- a/.github/workflows/ruff.yml +++ /dev/null @@ -1,8 +0,0 @@ -name: Ruff -on: [ push, pull_request ] -jobs: - ruff: - runs-on: ubuntu-latest - steps: - - uses: actions/checkout@v3 - - uses: chartboost/ruff-action@v1 diff --git a/.github/workflows/test.yaml b/.github/workflows/test.yaml new file mode 100644 index 0000000..8a30b24 --- /dev/null +++ b/.github/workflows/test.yaml @@ -0,0 +1,60 @@ +name: ci-test + +on: + push: + branches: [ main, master ] + pull_request: + branches: [ main, master ] + +jobs: + build-windows: + runs-on: windows-latest + steps: + - uses: actions/checkout@v2 + - name: Set up Python 3.11 + uses: actions/setup-python@v2 + with: + python-version: 3.11 + - name: Install dependencies + run: | + python -m pip install --upgrade pip + pip install -r requirements-dev.txt + pip install -e . + - name: Testing + run: | + python -m pytest tests + + build-linux: + runs-on: ubuntu-latest + steps: + - uses: actions/checkout@v2 + - name: Set up Python 3.11 + uses: actions/setup-python@v2 + with: + python-version: 3.11 + - name: Install dependencies + run: | + python -m pip install --upgrade pip + pip install -r requirements-dev.txt + pip install -e . + - name: Testing + run: | + python -m pytest --cov=fastvector tests + python -m codecov + + build-macos: + runs-on: macos-latest + steps: + - uses: actions/checkout@v2 + - name: Set up Python 3.11 + uses: actions/setup-python@v2 + with: + python-version: 3.11 + - name: Install dependencies + run: | + python -m pip install --upgrade pip + pip install -r requirements-dev.txt + pip install -e . + - name: Testing + run: | + python -m pytest tests diff --git a/.github/workflows/test.yml b/.github/workflows/test.yml deleted file mode 100644 index bcd997a..0000000 --- a/.github/workflows/test.yml +++ /dev/null @@ -1,28 +0,0 @@ -name: Test - -on: - push: - branches: [ main, dev ] - pull_request: - branches: [ main, dev ] - -jobs: - build: - - runs-on: ubuntu-latest - - steps: - - uses: actions/checkout@v2 - - name: Set up Python 3.10 - uses: actions/setup-python@v2 - with: - python-version: "3.10" - - name: Install dependencies - run: | - python -m pip install --upgrade pip - pip install -r requirements.txt - pip install -r requirements-dev.txt - python setup.py develop - - name: Test - run: | - pytest tests diff --git a/mkdocs.yaml b/mkdocs.yaml new file mode 100644 index 0000000..38099e7 --- /dev/null +++ b/mkdocs.yaml @@ -0,0 +1,37 @@ +site_name: DISTNAME +site_description: "This is a simple vector python package." + +repo_url: https://github.com/franneck94/Python-Project-Template +repo_name: franneck94/Python-Project-Template + +theme: + icon: + repo: fontawesome/brands/github + name: "material" + palette: + - media: "(prefers-color-scheme: light)" + primary: "blue" + accent: "grey" + scheme: default + toggle: + icon: material/toggle-switch-off-outline + name: Switch to dark mode + - media: "(prefers-color-scheme: dark)" + primary: "blue" + accent: "white" + scheme: slate + toggle: + icon: material/toggle-switch + name: Switch to light mode + +plugins: + - search + - mkdocstrings + +markdown_extensions: + - pymdownx.highlight + - pymdownx.superfences + +nav: + - "Start": index.md + - "API": api.md diff --git a/mkdocs.yml b/mkdocs.yml deleted file mode 100644 index a71dd3b..0000000 --- a/mkdocs.yml +++ /dev/null @@ -1,20 +0,0 @@ -# mkdocs.yml -site_name: TensorCross - -theme: - name: "material" - palette: - primary: "orange" - accent: "grey" - -plugins: - - search - - mkdocstrings - -markdown_extensions: - - pymdownx.highlight - - pymdownx.superfences - -nav: - - "Start": index.md - - "API": api.md diff --git a/pyproject.toml b/pyproject.toml index 6e7c9c3..76dc6af 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -72,7 +72,6 @@ extend-select = [ "SLOT", "SIM", "TID", - "TCH", "INT", "ARG", "PTH", @@ -90,16 +89,15 @@ extend-select = [ ignore = [ "ANN101", "ANN102", + "ANN401", "I001", "NPY002", "INP001", "TRY003", "ISC001", "COM812", - "UP", - "TCH003", - "ANN401", - "TCH", + "UP006", + "UP007", "PTH", ] fixable = ["ALL"] diff --git a/requirements-dev.txt b/requirements-dev.txt index 93f0894..084c5ee 100644 --- a/requirements-dev.txt +++ b/requirements-dev.txt @@ -1,24 +1,36 @@ -setuptools>=68.2.2 +# Packaging +# python -m pip install -U pip build>=1.0.3 -twine>=4.0.2 +twine>=5.0.0 +setuptools>=69.1.0 -# Linting/Tooling -black>=23.10.1 -isort>=5.12.0 -mypy>=1.6.1 -pre-commit>=3.5.0 -ruff>=0.1.3 -pyright>=1.1.333 +# Jupyter +ipython>=8.21.0 +ipykernel>=6.29.2 + +# Linting/Formatting +ruff>=0.2.1 +black>=24.2.0 +isort>=5.13.2 + +# Tooling +pre-commit>=3.6.1 + +# Type Checker +mypy>=1.8.0 +mypy-extensions>=1.0.0 +pyright>=1.1.350 # Testing -pytest>=7.4.3 -codecov>=2.1.13 +pytest>=8.0.0 pytest-cov>=4.1.0 pytest-benchmark>=4.0.0 +codecov>=2.1.13 +tox>=4.12.1 # Documentation mkdocs>=1.5.3 -mkdocstrings>=0.23.0 -mkdocstrings-python>=1.7.3 -mkdocs-material>=9.4.6 -Pygments>=2.16.1 +mkdocstrings>=0.24.0 +mkdocs-material>=9.5.9 +mkdocstrings-python>=1.8.0 +Pygments>=2.17.2 diff --git a/requirements.txt b/requirements.txt index 2755088..ebd5735 100644 --- a/requirements.txt +++ b/requirements.txt @@ -8,3 +8,5 @@ keras>=2.0 scikit-learn scipy numpy + +-r requirements-dev.txt \ No newline at end of file