Merge pull request #1 from dapper91/dev

- first library version implemented
- pre-commit hooks added
- examples added
- documentation added
- github test workflow added
- github release workflow added

Author: dapper91

.flake8

@@ -0,0 +1,6 @@
+[flake8]
+max-line-length = 120
+exclude =
+    tests/**
+per-file-ignores =
+    */__init__.py: F401

.github/workflows/release.yml

@@ -0,0 +1,24 @@
+name: release
+
+on:
+  release:
+    types:
+      - released
+
+jobs:
+  release:
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v2
+    - name: Set up Python
+      uses: actions/setup-python@v2
+      with:
+        python-version: '3.x'
+    - name: Install dependencies
+      run: |
+        python -m pip install --upgrade pip poetry
+        poetry install
+    - name: Build and publish
+      run: |
+        poetry build
+        poetry publish -u __token__ -p ${{ secrets.PYPI_TOKEN }}

.github/workflows/test.yml

@@ -0,0 +1,41 @@
+name: test
+
+on:
+  pull_request:
+    branches:
+      - dev
+      - master
+  push:
+    branches:
+      - master
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        python-version: ['3.8', '3.9', '3.10']
+    steps:
+    - uses: actions/checkout@v2
+    - name: Set up Python ${{ matrix.python-version }}
+      uses: actions/setup-python@v2
+      with:
+        python-version: ${{ matrix.python-version }}
+    - name: Install dependencies
+      run: |
+        python -m pip install --upgrade pip
+        pip install poetry
+        poetry install --no-root -E lxml
+    - name: Run pre-commit hooks
+      run: poetry run pre-commit run --hook-stage merge-commit --all-files
+    - name: Run tests (lxml)
+      run: PYTHONPATH="$(pwd):$PYTHONPATH" poetry run py.test tests
+    - name: Run tests (std)
+      run: PYTHONPATH="$(pwd):$PYTHONPATH" FORCE_STD_XML=true poetry run py.test --cov=pydantic_xml --cov-report=xml tests
+    - name: Upload coverage to Codecov
+      uses: codecov/codecov-action@v1
+      with:
+        token: ${{ secrets.CODECOV_TOKEN }}
+        files: ./coverage.xml
+        flags: unittests
+        fail_ci_if_error: true

.gitignore

@@ -127,3 +127,6 @@ dmypy.json
 
 # Pyre type checker
 .pyre/
+
+# IDEs
+.idea

.pre-commit-config.yaml

@@ -0,0 +1,76 @@
+default_stages:
+ - commit
+ - merge-commit
+
+repos:
+  - repo: https://github.com/pre-commit/pre-commit-hooks
+    rev: v4.1.0
+    hooks:
+      - id: check-yaml
+      - id: check-toml
+      - id: trailing-whitespace
+      - id: end-of-file-fixer
+        stages:
+          - commit
+      - id: mixed-line-ending
+        name: fix line ending
+        stages:
+          - commit
+        args:
+          - --fix=lf
+      - id: mixed-line-ending
+        name: check line ending
+        stages:
+          - merge-commit
+        args:
+          - --fix=no
+  - repo: https://github.com/asottile/add-trailing-comma
+    rev: v2.2.1
+    hooks:
+      - id: add-trailing-comma
+        stages:
+          - commit
+  - repo: https://github.com/pre-commit/mirrors-autopep8
+    rev: v1.6.0
+    hooks:
+      - id: autopep8
+        stages:
+          - commit
+        args:
+          - --diff
+  - repo: https://gitlab.com/pycqa/flake8
+    rev: 3.9.2
+    hooks:
+      - id: flake8
+  - repo: https://github.com/pycqa/isort
+    rev: 5.10.1
+    hooks:
+      - id: isort
+        name: fix import order
+        stages:
+          - commit
+        args:
+          - --line-length=120
+          - --multi-line=9
+          - --project=pydantic_xml
+      - id: isort
+        name: check import order
+        stages:
+          - merge-commit
+        args:
+          - --check-only
+          - --line-length=120
+          - --multi-line=9
+          - --project=pydantic_xml
+  - repo: https://github.com/pre-commit/mirrors-mypy
+    rev: v0.942
+    hooks:
+      - id: mypy
+        stages:
+          - commit
+        name: mypy
+        pass_filenames: false
+        args: ["--package", "pydantic_xml"]
+        additional_dependencies:
+          - pydantic
+          - lxml-stubs

CHANGELOG.rst

@@ -0,0 +1,8 @@
+Changelog
+=========
+
+
+0.1.0 (2021-08-17)
+------------------
+
+- Initial release