Skip to content

Commit 545db69

Browse files
committed
Update README and docs to match cryptoscan style
- Rewrite README with clearer structure and correct installation instructions - Add CI workflow with tests across Python 3.10-3.12 - Add coverage reporting via Codecov - Simplify INSTALLATION.md with source-based install - Add badges for CI, coverage, license, Python version
1 parent 4856453 commit 545db69

File tree

4 files changed

+367
-360
lines changed

4 files changed

+367
-360
lines changed

.github/workflows/ci.yml

Lines changed: 67 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,67 @@
1+
name: CI
2+
3+
on:
4+
push:
5+
branches: [main]
6+
pull_request:
7+
branches: [main]
8+
9+
jobs:
10+
test:
11+
runs-on: ubuntu-latest
12+
strategy:
13+
matrix:
14+
python-version: ['3.10', '3.11', '3.12']
15+
16+
steps:
17+
- uses: actions/checkout@v4
18+
19+
- name: Set up Python ${{ matrix.python-version }}
20+
uses: actions/setup-python@v5
21+
with:
22+
python-version: ${{ matrix.python-version }}
23+
24+
- name: Install dependencies
25+
run: |
26+
python -m pip install --upgrade pip
27+
pip install -e ".[dev,all]"
28+
29+
- name: Lint with ruff
30+
run: ruff check src/qbom
31+
32+
- name: Type check with mypy
33+
run: mypy src/qbom --ignore-missing-imports
34+
35+
- name: Run tests with coverage
36+
run: pytest --cov=src/qbom --cov-report=xml --cov-report=term-missing
37+
38+
- name: Upload coverage to Codecov
39+
if: matrix.python-version == '3.11'
40+
uses: codecov/codecov-action@v4
41+
with:
42+
token: ${{ secrets.CODECOV_TOKEN }}
43+
files: ./coverage.xml
44+
fail_ci_if_error: false
45+
46+
quality:
47+
runs-on: ubuntu-latest
48+
steps:
49+
- uses: actions/checkout@v4
50+
51+
- name: Set up Python
52+
uses: actions/setup-python@v5
53+
with:
54+
python-version: '3.11'
55+
56+
- name: Install dependencies
57+
run: |
58+
python -m pip install --upgrade pip
59+
pip install -e ".[dev]"
60+
61+
- name: Check formatting
62+
run: ruff format --check src/qbom
63+
64+
- name: Security check with bandit
65+
run: |
66+
pip install bandit
67+
bandit -r src/qbom -ll || true

0 commit comments

Comments
 (0)