Merge pull request #11 from pharmaverse/main

nanxstats · web-flow · commit e52a633610b5 · 2025-11-30T02:14:50.000-05:00
Synchronize changes until v0.1.9
diff --git a/.github/workflows/ci-tests.yml b/.github/workflows/ci-tests.yml
@@ -1,3 +1,5 @@
+name: CI tests
+
 on:
   push:
     branches:
@@ -6,8 +8,6 @@ on:
     branches:
       - main
 
-name: CI Tests
-
 jobs:
   build:
     runs-on: ubuntu-latest
@@ -17,7 +17,7 @@ jobs:
       fail-fast: false
 
     steps:
-      - uses: actions/checkout@v5
+      - uses: actions/checkout@v6
       - name: Set up Python ${{ matrix.python-version }}
         uses: actions/setup-python@v6
         with:
@@ -42,7 +42,7 @@ jobs:
   test-windows:
     runs-on: windows-latest
     steps:
-      - uses: actions/checkout@v5
+      - uses: actions/checkout@v6
       - name: Set up Python
         uses: actions/setup-python@v6
         with:
diff --git a/.github/workflows/mkdocs.yml b/.github/workflows/mkdocs.yml
@@ -12,7 +12,7 @@ jobs:
   deploy:
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v5
+      - uses: actions/checkout@v6
       - name: Configure Git Credentials
         run: |
           git config user.name github-actions[bot]
diff --git a/.github/workflows/mypy.yml b/.github/workflows/mypy.yml
@@ -6,20 +6,20 @@ on:
       - main
   pull_request:
     branches:
-      - '**'
+      - "**"
 
 jobs:
   mypy:
     runs-on: ubuntu-latest
 
     steps:
       - name: Checkout repository
-        uses: actions/checkout@v5
+        uses: actions/checkout@v6
 
       - name: Set up Python
         uses: actions/setup-python@v6
         with:
-          python-version: 3.14.0
+          python-version: "3.14"
 
       - name: Install uv
         run: |
diff --git a/.github/workflows/ruff-check.yml b/.github/workflows/ruff-check.yml
@@ -0,0 +1,25 @@
+name: Ruff check
+
+on:
+  push:
+    branches:
+      - main
+  pull_request:
+    branches:
+      - "**"
+
+jobs:
+  ruff-check:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v6
+      - name: Install Python
+        uses: actions/setup-python@v6
+        with:
+          python-version: "3.14"
+      - name: Install dependencies
+        run: |
+          python -m pip install --upgrade pip
+          pip install ruff
+      - name: Run Ruff
+        run: ruff check --output-format=github .
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,5 +1,19 @@
 # Changelog
 
+## py-pkglite 0.1.9
+
+### Documentation
+
+- Improved installation instructions in `README.md` by adding explicit
+  `pipx` installation command and adding option to use `uvx` to try the
+  CLI tool without installing it (#53).
+
+### Maintenance
+
+- Added GitHub Actions workflow to run `ruff check` for code linting (#55).
+- Updated GitHub Actions workflows to use `actions/checkout@v6` (#55).
+- Updated badges in `README.md` (#55).
+
 ## py-pkglite 0.1.8
 
 ### Linting
diff --git a/README.md b/README.md
@@ -3,8 +3,9 @@
 [![PyPI version](https://img.shields.io/pypi/v/pkglite)](https://pypi.org/project/pkglite/)
 ![Python versions](https://img.shields.io/pypi/pyversions/pkglite)
 [![pharmaverse py-pkglite badge](http://pharmaverse.org/shields/pkglite.svg)](https://pharmaverse.org)
-[![Checked with mypy](https://www.mypy-lang.org/static/mypy_badge.svg)](https://mypy-lang.org/)
-[![CI Tests](https://github.com/pharmaverse/py-pkglite/actions/workflows/ci-tests.yml/badge.svg)](https://github.com/pharmaverse/py-pkglite/actions/workflows/ci-tests.yml)
+[![CI tests](https://github.com/pharmaverse/py-pkglite/actions/workflows/ci-tests.yml/badge.svg)](https://github.com/pharmaverse/py-pkglite/actions/workflows/ci-tests.yml)
+[![Mypy check](https://github.com/pharmaverse/py-pkglite/actions/workflows/mypy.yml/badge.svg)](https://github.com/pharmaverse/py-pkglite/actions/workflows/mypy.yml)
+[![Ruff check](https://github.com/pharmaverse/py-pkglite/actions/workflows/ruff-check.yml/badge.svg)](https://github.com/pharmaverse/py-pkglite/actions/workflows/ruff-check.yml)
 [![mkdocs](https://github.com/pharmaverse/py-pkglite/actions/workflows/mkdocs.yml/badge.svg)](https://pharmaverse.github.io/py-pkglite/)
 ![License](https://img.shields.io/pypi/l/pkglite)
 
@@ -30,7 +31,18 @@ python3 -m pip install -e .
 ```
 
 To install the command line tool globally,
-[use pipx](https://packaging.python.org/en/latest/guides/installing-stand-alone-command-line-tools/).
+[use pipx](https://packaging.python.org/en/latest/guides/installing-stand-alone-command-line-tools/):
+
+```bash
+pipx install pkglite
+```
+
+You can also use `uvx` to [try the tool without installing
+it](https://docs.astral.sh/uv/guides/tools/):
+
+```bash
+uvx pkglite --help
+```
 
 ## Usage
 
diff --git a/docs/changelog.md b/docs/changelog.md
@@ -1,5 +1,19 @@
 # Changelog
 
+## py-pkglite 0.1.9
+
+### Documentation
+
+- Improved installation instructions in `README.md` by adding explicit
+  `pipx` installation command and adding option to use `uvx` to try the
+  CLI tool without installing it (#53).
+
+### Maintenance
+
+- Added GitHub Actions workflow to run `ruff check` for code linting (#55).
+- Updated GitHub Actions workflows to use `actions/checkout@v6` (#55).
+- Updated badges in `README.md` (#55).
+
 ## py-pkglite 0.1.8
 
 ### Linting
diff --git a/docs/index.md b/docs/index.md
@@ -3,8 +3,9 @@
 [![PyPI version](https://img.shields.io/pypi/v/pkglite)](https://pypi.org/project/pkglite/)
 ![Python versions](https://img.shields.io/pypi/pyversions/pkglite)
 [![pharmaverse py-pkglite badge](http://pharmaverse.org/shields/pkglite.svg)](https://pharmaverse.org)
-[![Checked with mypy](https://www.mypy-lang.org/static/mypy_badge.svg)](https://mypy-lang.org/)
-[![CI Tests](https://github.com/pharmaverse/py-pkglite/actions/workflows/ci-tests.yml/badge.svg)](https://github.com/pharmaverse/py-pkglite/actions/workflows/ci-tests.yml)
+[![CI tests](https://github.com/pharmaverse/py-pkglite/actions/workflows/ci-tests.yml/badge.svg)](https://github.com/pharmaverse/py-pkglite/actions/workflows/ci-tests.yml)
+[![Mypy check](https://github.com/pharmaverse/py-pkglite/actions/workflows/mypy.yml/badge.svg)](https://github.com/pharmaverse/py-pkglite/actions/workflows/mypy.yml)
+[![Ruff check](https://github.com/pharmaverse/py-pkglite/actions/workflows/ruff-check.yml/badge.svg)](https://github.com/pharmaverse/py-pkglite/actions/workflows/ruff-check.yml)
 [![mkdocs](https://github.com/pharmaverse/py-pkglite/actions/workflows/mkdocs.yml/badge.svg)](https://pharmaverse.github.io/py-pkglite/)
 ![License](https://img.shields.io/pypi/l/pkglite)
 
@@ -30,7 +31,18 @@ python3 -m pip install -e .
 ```
 
 To install the command line tool globally,
-[use pipx](https://packaging.python.org/en/latest/guides/installing-stand-alone-command-line-tools/).
+[use pipx](https://packaging.python.org/en/latest/guides/installing-stand-alone-command-line-tools/):
+
+```bash
+pipx install pkglite
+```
+
+You can also use `uvx` to [try the tool without installing
+it](https://docs.astral.sh/uv/guides/tools/):
+
+```bash
+uvx pkglite --help
+```
 
 ## Usage
 
diff --git a/docs/overrides/main.html b/docs/overrides/main.html
@@ -0,0 +1,8 @@
+{% extends "base.html" %}
+
+{% block announce %}
+Learn how to create clinical study reports and eCTD submissions with Python at
+<a href="https://pycsr.org">
+    <strong>pycsr.org</strong>
+</a>
+{% endblock %}
diff --git a/docs/stylesheets/extra.css b/docs/stylesheets/extra.css
@@ -67,4 +67,9 @@ code {
 .md-typeset .admonition,
 .md-typeset details {
     font-size: 0.85rem;
+}
+
+.md-banner {
+    color: var(--md-typeset-color);
+    background-color: oklch(96.2% 0.059 95.617);
 }
diff --git a/mkdocs.yml b/mkdocs.yml
@@ -42,6 +42,7 @@ markdown_extensions:
 
 theme:
   name: material
+  custom_dir: docs/overrides
   font:
     text: Lato
   logo: assets/logo.png
diff --git a/pyproject.toml b/pyproject.toml
@@ -1,6 +1,6 @@
 [project]
 name = "pkglite"
-version = "0.1.8"
+version = "0.1.9"
 description = "Pack and unpack source projects of any language into portable text files"
 authors = [
     { name = "Nan Xiao", email = "nan.xiao1@msd.com" }
diff --git a/uv.lock b/uv.lock
