Skip to content

Updated and cleaner version of the README.md #148

Updated and cleaner version of the README.md

Updated and cleaner version of the README.md #148

Workflow file for this run

name: ci
on:
push:
branches: [main]
pull_request:
jobs:
tests:
runs-on: ubuntu-latest
timeout-minutes: 30
strategy:
matrix:
python-version: ["3.11", "3.12", "3.13"]
name: Run tests
steps:
- name: Checkout repo
uses: actions/checkout@v4
- name: Set up Python ${{ matrix.python-version }}
uses: actions/setup-python@v5
with:
python-version: ${{ matrix.python-version }}
- name: Install CodeEntropy and its testing dependencies
shell: bash
run: pip install -e .[testing]
- name: Run test suite
shell: bash
run: pytest --cov CodeEntropy --cov-report term-missing --cov-append .
- name: Coveralls GitHub Action
uses: coverallsapp/github-action@v2.3.6
with:
github-token: ${{ secrets.COVERALLS_REPO_TOKEN }}
docs:
runs-on: ubuntu-latest
timeout-minutes: 15
steps:
- uses: actions/checkout@v4
- name: Set up Python 3.12
uses: actions/setup-python@v5
with:
python-version: 3.12
- name: Install python dependencies
run: |
pip install --upgrade pip
pip install -e .[docs]
- name: Build docs
run: cd docs && make
pre-commit:
runs-on: ubuntu-latest
timeout-minutes: 15
steps:
- uses: actions/checkout@v4
- name: Set up Python 3.11
uses: actions/setup-python@v5
with:
python-version: 3.11
- name: Install python dependencies
run: |
pip install --upgrade pip
pip install -e .[pre-commit,docs,testing]
- name: Run pre-commit
run: |
pre-commit install
pre-commit run --all-files || ( git status --short ; git diff ; exit 1 )