Merge pull request #27 from isakruas/chore/improve-docs-tests-and-ci

chore: Improve documentation, test coverage and CI workflow

Author: isakruas

.github/workflows/ci.yml

@@ -0,0 +1,78 @@
+name: CI
+
+on:
+  push:
+    branches:
+      - master
+    tags:
+      - "v*.*.*"
+  pull_request:
+    branches:
+      - master
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        python-version: ["3.9", "3.10", "3.11"]
+
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v4
+
+      - name: Set up Python ${{ matrix.python-version }}
+        uses: actions/setup-python@v5
+        with:
+          python-version: ${{ matrix.python-version }}
+
+      - name: Install dependencies
+        run: |
+          python -m venv .venv
+          .venv/bin/pip install --upgrade pip
+          .venv/bin/pip install -r requirements-tests.txt
+          .venv/bin/pip install .
+
+      - name: Lint and Format Check
+        run: |
+          .venv/bin/ruff format --check .
+          .venv/bin/ruff check .
+
+      - name: Run tests with coverage
+        run: |
+          .venv/bin/pytest --cov=ecutils --cov-report=xml tests/
+
+      - name: Upload coverage to Codecov
+        if: matrix.python-version == '3.11'
+        uses: codecov/codecov-action@v4
+        with:
+          token: ${{ secrets.CODECOV_TOKEN }}
+          files: ./coverage.xml
+          fail_ci_if_error: true
+
+  publish:
+    needs: test
+    if: startsWith(github.ref, 'refs/tags/v')
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v4
+
+      - name: Set up Python
+        uses: actions/setup-python@v5
+        with:
+          python-version: '3.9'
+
+      - name: Install build dependencies
+        run: |
+          python -m pip install --upgrade pip
+          pip install build
+
+      - name: Build package
+        run: python -m build
+
+      - name: Publish to PyPI
+        uses: pypa/gh-action-pypi-publish@release/v1
+        with:
+          password: ${{ secrets.PYPI_TOKEN }}

.github/workflows/codecov.yml

@@ -1,11 +1,12 @@
 .ipynb_checkpoints/
 .pytest_cache/
 __pycache__/
-venv/
+.venv/
 *.ipynb
 .idea/
 .coverage
 htmlcov/
 site/
 .pypirc
-dist/
+dist/
+.ruff_cache

.github/workflows/pypi.yml

@@ -4,6 +4,25 @@ 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.0.0/), and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
+## [v1.1.5] - 2025-01-21
+
+### Added
+- Benchmarks documentation page with performance data for all curves and configurations
+- Security considerations documentation page
+- Configuration documentation page for LRU cache and coordinate systems
+- Benchmark scripts for performance testing
+- Ruff configuration for linting and formatting
+
+### Changed
+- Reorganized documentation structure using mkdocstrings for API reference
+- Consolidated CI workflows into single ci.yml
+- Updated README with performance data and supported curves table
+- Improved test coverage to 100%
+
+### Removed
+- Deprecated separate documentation files (moved to reference/ structure)
+- Old workflow files (codecov.yml, pypi.yml)
+
 ## [v1.1.4] - 2024-10-26
 
 ### Changed