updated to new configs

.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

.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

.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/[email protected]

.github/workflows/publish.yml → .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/*

.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

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

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"]

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

requirements.txt

@@ -8,3 +8,5 @@ keras>=2.0
 scikit-learn
 scipy
 numpy
+
+-r requirements-dev.txt