Merge branch 'master' into dependabot/pip/tomlkit-0.11.8

.github/workflows/test.yml

@@ -14,34 +14,25 @@ jobs:
     strategy:
       fail-fast: false
       matrix:
-        python-version: ["3.8"]
+        python-version: ["3.8", "3.9", "3.10", "3.11", "3.12"]
 
     name: Python ${{ matrix.python-version }}
 
     steps:
       - name: Checkout
         uses: actions/checkout@v3
 
-      - name: Set up Node.js
-        uses: actions/setup-node@v3
-        with:
-          node-version: 16
-
-      - name: Install @devcontainers/cli
-        run: npm install --location=global @devcontainers/[email protected]
+      - name: Install poetry
+        run: pip install poetry
 
-      - name: Start Dev Container
-        env:
-          DOCKER_BUILDKIT: 1
-        run: |
-          git config --global init.defaultBranch main
-          PYTHON_VERSION=${{ matrix.python-version }} devcontainer up --workspace-folder .
+      - name: Install dependencies
+        run: poetry install
 
-      - name: Lint package
-        run: devcontainer exec --workspace-folder . poe lint
+      - name: Lint project
+        run: poetry run poe lint
 
       - name: Test package
-        run: devcontainer exec --workspace-folder . poe test
+        run: poetry run poe test
 
       - name: Upload coverage
         uses: codecov/codecov-action@v3

.pre-commit-config.yaml

@@ -22,7 +22,7 @@ repos:
     rev: 23.12.0
     hooks:
       - id: black
-        language_version: python3.8
+        language_version: python3
   - repo: https://github.com/astral-sh/ruff-pre-commit
     rev: v0.1.7
     hooks:
@@ -54,7 +54,6 @@ repos:
       - id: mixed-line-ending
       - id: name-tests-test
         args: [--pytest-test-first]
-      - id: no-commit-to-branch
       - id: trailing-whitespace
         types: [python]
   - repo: https://github.com/commitizen-tools/commitizen

.readthedocs.yaml

@@ -0,0 +1,38 @@
+# Read the Docs configuration file
+# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details
+
+# Required
+version: 2
+
+# Set the OS, Python version and other tools you might need
+build:
+  os: ubuntu-22.04
+  tools:
+    python: "3.8"
+    # You can also specify other tool versions:
+    # nodejs: "19"
+    # rust: "1.64"
+    # golang: "1.19"
+  jobs:
+    post_create_environment:
+      # Install poetry
+      # https://python-poetry.org/docs/#installing-manually
+      - pip install poetry
+      # Tell poetry to not use a virtual environment
+      - poetry config virtualenvs.create false
+    post_install:
+      # Install dependencies with 'docs' dependency group
+      # https://python-poetry.org/docs/managing-dependencies/#dependency-groups
+      - poetry install --with docs
+
+# Build documentation in the "docs/" directory with Sphinx
+mkdocs:
+  configuration: documentation/mkdocs.yml
+
+
+# Optional but recommended, declare the Python requirements required
+# to build your documentation
+# See https://docs.readthedocs.io/en/stable/guides/reproducible-builds.html
+# python:
+#    install:
+#    - requirements: docs/requirements.txt

documentation/docs/index.md

@@ -0,0 +1,8 @@
+# Python-KSEF documentation
+
+
+!!! warning "Warning"
+
+    This Library is not yet production ready. It is in early alpha development right now.
+
+A python library for Polish KSEF (National e-invoice system, original: Krajowy System e-Faktur) system.

documentation/docs/tutorials/getting-started/installation.md

@@ -0,0 +1,9 @@
+# 1. Installation
+
+You can install the package using `pip`:
+
+```shell
+pip install ksef
+```
+
+Other build tools such as `pipenv` or `poetry` are also supported.

documentation/mkdocs.yml

@@ -0,0 +1,7 @@
+site_name: My Docs
+theme:
+  name: material
+markdown_extensions:
+  - admonition
+  - pymdownx.details
+  - pymdownx.superfences