Merge branch 'release/2.2'

Author: Liu Xue Yan

.dockerignore

@@ -0,0 +1,23 @@
+.git/
+
+**/__pycache__
+*.egg-info
+*.egg/
+*.pyc
+
+build
+dist
+docs/_build
+
+.mypy_cache/
+.ruff_cache
+
+*.swp
+
+html/*
+
+**/Dockerfile
+**/Dockerfile.*
+**/*.Dockerfile
+**/docker-compose.*
+**/*.docker-compose.*

.github/workflows/python-package.yml

@@ -32,7 +32,7 @@ jobs:
     runs-on: ubuntu-latest
     strategy:
       matrix:
-        python-version: ["3.8", "3.9", "3.10", "3.11", "3.12"]
+        python-version: ["3.8", "3.9", "3.10", "3.11", "3.12", "3.13"]
     steps:
       - name: Checkout
         uses: actions/checkout@v4

.pre-commit-config.yaml

@@ -1,6 +1,6 @@
 repos:
   - repo: https://github.com/pre-commit/pre-commit-hooks
-    rev: v4.6.0
+    rev: v5.0.0
     hooks:
       - id: check-case-conflict
       - id: check-added-large-files
@@ -20,7 +20,7 @@ repos:
       - id: check-docstring-first
 
   - repo: https://github.com/astral-sh/ruff-pre-commit
-    rev: v0.6.5
+    rev: v0.7.0
     hooks:
       - id: ruff # Run the linter.
         types_or: [python, pyi, jupyter]
@@ -29,14 +29,14 @@ repos:
         types_or: [python, pyi, jupyter]
 
   - repo: https://github.com/pre-commit/mirrors-mypy
-    rev: "v1.11.2"
+    rev: "v1.13.0"
     hooks:
       - id: mypy
         args: [--ignore-missing-imports, --config-file, .mypy.ini]
         additional_dependencies: [types-PyYAML]
 
   - repo: https://github.com/python-jsonschema/check-jsonschema
-    rev: "0.29.2"
+    rev: "0.29.4"
     hooks:
       - id: check-github-workflows
       - id: check-readthedocs

CHANGELOG.md

@@ -1,17 +1,21 @@
 # CHANGELOG
 
-## 2.2a1
+## 2.2
 
-> 📅 **Date** 2024-9-22
+> 📅 **Date** 2024-11-9
 
 - New:
 
-  - Add `flatten` argument. See [#46](https://github.com/tanbro/pyyaml-include/issues/46) for detail
+  - Add a `flatten` argument. See [#46](https://github.com/tanbro/pyyaml-include/issues/46) for detail
 
 - Bug fix:
 
   - fix issue if glob_params is not int. See [#48](https://github.com/tanbro/pyyaml-include/pull/48) for detail
 
+- Test:
+
+  - PyPy 3.9 and 3.10 in docker compose based unit-test
+
 - Other update and improvement
 
 ## 2.1

README.md

@@ -19,7 +19,7 @@ In version `2.0`, [fsspec][] was introduced. With it, we can even include files
 pip install "pyyaml-include"
 ```
 
-Since we are using [fsspec][] to open including files from v2.0, an installation can be performed like below, if want to open remote files:
+Because [fsspec][] was introduced to open the including files since v2.0, an installation can be performed like below, if want to open remote files:
 
 - for files on website:
 
@@ -63,7 +63,7 @@ Consider we have such [YAML][] files:
 
 To include `1.yml`, `2.yml` in `0.yml`, we shall:
 
-1. Register a `yaml_include.Constructor` to [PyYAML][]'s loader class, with `!inc` as it's tag:
+1. Register a `yaml_include.Constructor` to [PyYAML][]'s loader class, with `!inc`(or any other tags start with `!` character) as it's tag:
 
    ```python
    import yaml
@@ -73,14 +73,14 @@ To include `1.yml`, `2.yml` in `0.yml`, we shall:
    yaml.add_constructor("!inc", yaml_include.Constructor(base_dir='/your/conf/dir'))
    ```
 
-1. Write `!inc` tags in `0.yaml`:
+1. Use `!inc` tag(s) in `0.yaml`:
 
    ```yaml
    file1: !inc include.d/1.yml
    file2: !inc include.d/2.yml
    ```
 
-1. Load it
+1. Load `0.yaml` in your Python program
 
    ```python
    with open('0.yml') as f:
@@ -91,7 +91,7 @@ To include `1.yml`, `2.yml` in `0.yml`, we shall:
    we'll get:
 
    ```python
-   {'file1':{'name':'1'},'file2':{'name':'2'}}
+   {'file1': {'name': '1'}, 'file2': {'name': '2'}}
    ```
 
 1. (optional) the constructor can be unregistered:

docs/README.rst

@@ -27,7 +27,7 @@ How to build docs
 
       .. code:: sh
 
-         make -C docs/make html
+         make -C docs html
 
    * Windows:
 

tests/docker-compose.yml

@@ -2,7 +2,7 @@ name: pyyaml_include-tests
 
 services:
   unittest:
-    image: quay.io/pypa/manylinux_2_28_x86_64:latest
+    image: quay.io/pypa/manylinux_2_28_x86_64
     volumes:
       - type: bind
         source: ..

tests/run-compose-test.sh

@@ -5,7 +5,7 @@ export PIP_DISABLE_PIP_VERSION_CHECK=1
 export PIP_ROOT_USER_ACTION=ignore
 export PIP_NO_WARN_SCRIPT_LOCATION=1
 
-PYTHON_LIST=(python3.8 python3.9 python3.10 python3.11 python3.12)
+PYTHON_LIST=(python3.8 python3.9 python3.10 python3.11 python3.12 python3.13 pypy3.9 pypy3.10)
 for PYTHON in ${PYTHON_LIST[@]}
 do
     echo