Merge pull request #381 from cleder/develop

Release 1.0.0b2

.github/workflows/run-all-tests.yml

@@ -70,7 +70,7 @@ jobs:
           pip install -e ".[tests, lxml, docs]"
       - name: test the pythoncode in the documentation
         run: |
-          python -m doctest docs/*.rst -v
+          python -m doctest docs/*.rst
       - name: Run the pythoncode in the examples
         run: |
           python examples/read_kml.py

.github/workflows/sonarcloud.yml

@@ -0,0 +1,20 @@
+name: SonarBuild
+on:
+  push:
+    branches:
+      - develop
+  pull_request:
+    types: [opened, synchronize, reopened]
+jobs:
+  sonarcloud:
+    name: SonarCloud
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+        with:
+          fetch-depth: 0  # Shallow clones should be disabled for a better relevancy of analysis
+      - name: SonarCloud Scan
+        uses: SonarSource/sonarcloud-github-action@master
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}  # Needed to get PR information, if any
+          SONAR_TOKEN: ${{ secrets.SONAR_TOKEN }}

.pre-commit-config.yaml

@@ -1,5 +1,11 @@
 ---
+default_language_version:
+  python: python3.12
 repos:
+  - repo: https://github.com/pre-commit-ci/pre-commit-ci-config
+    rev: v1.6.1
+    hooks:
+      - id: check-pre-commit-ci-config
   - repo: https://github.com/pre-commit/pre-commit-hooks
     rev: v5.0.0
     hooks:
@@ -36,18 +42,11 @@ repos:
     rev: v0.3.1
     hooks:
       - id: absolufy-imports
-  - repo: https://github.com/psf/black
-    rev: 24.10.0
-    hooks:
-      - id: black
-  - repo: https://github.com/pycqa/isort
-    rev: 5.13.2
-    hooks:
-      - id: isort
   - repo: https://github.com/astral-sh/ruff-pre-commit
     rev: 'v0.7.2'
     hooks:
       - id: ruff
+      - id: ruff-format
   - repo: https://github.com/PyCQA/flake8
     rev: 7.1.1
     hooks:

README.rst

@@ -28,7 +28,7 @@ Fastkml is continually tested
     :target: https://github.com/cleder/fastkml/actions/workflows/run-all-tests.yml
     :alt: Test
 
-.. |cov| image:: http://codecov.io/github/cleder/fastkml/coverage.svg?branch=main
+.. |cov| image:: https://codecov.io/gh/cleder/fastkml/branch/main/graph/badge.svg?token=VIuhPHq0ow
     :target: http://codecov.io/github/cleder/fastkml?branch=main
     :alt: codecov.io
 
@@ -108,7 +108,9 @@ Requirements
 Optional
 ---------
 
-* lxml_::
+* lxml_:
+
+.. code-block:: bash
 
     pip install --pre "fastkml[lxml]"
 

docs/conf.py

@@ -176,6 +176,14 @@
 # If true, links to the reST sources are added to the pages.
 # html_show_sourcelink = True
 
+html_context = {
+    "display_github": True,  # Integrate GitHub
+    "github_user": "cleder",  # Username
+    "github_repo": "fastkml",  # Repo name
+    "github_version": "main",  # Version
+    "conf_py_path": "/docs/",  # Path in the checkout to the docs root
+}
+
 # If true, "Created using Sphinx" is shown in the HTML footer. Default is True.
 # html_show_sphinx = True
 

docs/configuration.rst

@@ -11,7 +11,9 @@ as its parser, but you can change this by setting the
 implementation.
 
 E.g. if you have lxml installed, but you want to use the
-standard ``xml.etree.ElementTree``, you can do this::
+standard ``xml.etree.ElementTree``, you can do this:
+
+.. code-block:: pycon
 
     >>> import fastkml.config
     >>> import xml.etree.ElementTree