Implement Standard Library

.github/CODEOWNERS

@@ -0,0 +1,4 @@
+# Changes in .github repository shall always be approved by an owner
+.github @dl1998
+setup.py @dl1998
+.pylintrc @dl1998

.github/workflows/default.yml

@@ -0,0 +1,111 @@
+name: Perform Checks
+on:
+  pull_request:
+    branches:
+      - main
+  workflow_dispatch:
+env:
+  GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+  REPOSITORY_NAME: 'py-git'
+  THRESHOLD: 0.9
+permissions: write-all
+jobs:
+  standard-checks:
+    name: Perform Standard Checks
+    permissions:
+      contents: write
+      pull-requests: write
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout Repository
+        uses: actions/checkout@v2
+      - name: Install Dependencies
+        run: python3 -m pip install -r requirements.txt
+      - name: Run Pylint
+        uses: dciborow/[email protected]
+        with:
+          github_token: ${{ secrets.github_token }}
+          # Change reviewdog reporter if you need [github-pr-check,github-check,github-pr-review].
+          reporter: github-pr-review
+          # Change reporter level if you need.
+          # GitHub Status Check won't become failure with warning.
+          level: warning
+          glob_pattern: "sources/**/*.py"
+      - name: Behave Tests
+        run: coverage run --source="sources" -m behave tests/qualification_tests
+      - name: Generate XML coverage report
+        run: coverage xml
+      - name: Get Coverage
+        uses: orgoro/[email protected]
+        with:
+          coverageFile: coverage.xml
+          token: ${{ secrets.GITHUB_TOKEN }}
+          thresholdAll: ${{ env.THRESHOLD }}
+      - name: Retrieve Total Coverage
+        id: coverage
+        if: '!cancelled()'
+        run: echo "TOTAL_COVERAGE=$(coverage report | grep TOTAL | awk '{ print $4 }' | sed 's/%//g')" >> "$GITHUB_ENV"
+      - name: Retrieve Coverage Color
+        if: '!cancelled()'
+        uses: jannekem/run-python-script-action@v1
+        id: coverage-color
+        with:
+          fail-on-error: false
+          script: |
+            if (int("${{ env.TOTAL_COVERAGE }}") / 100.0) < float("${{ env.THRESHOLD }}"):
+              print("red", end='')
+            else:
+              print("green", end='')
+      - name: Retrieve Release Version
+        id: version
+        if: '!cancelled()'
+        run: echo "VERSION=$(python3 setup.py --version)" >> "$GITHUB_ENV"
+      - name: Add Badges
+        if: '!cancelled()'
+        # You may pin to the exact commit or the version.
+        # uses: wow-actions/add-badges@43f2c1eaecfb2596b89a8136a3fbda4f18d1d188
+        uses: wow-actions/[email protected]
+        env:
+          repo_url: ${{ github.event.repository.html_url }}
+          repo_name: ${{ github.event.repository.name }}
+          repo_owner: ${{ github.event.repository.owner.login }}
+        with:
+          # Your GitHub token for authentication.
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+          # The badges to add with JSON format
+          badges: |
+            [
+              {
+                "badge": "https://img.shields.io/badge/License-MIT-yellow.svg?style=for-the-badge",
+                "alt": "MIT License",
+                "link": "${{ env.repo_url }}/blob/main/LICENSE"
+              },
+              {
+                "badge": "https://img.shields.io/badge/Language-Python-blue?style=for-the-badge&logo=python",
+                "alt": "Language",
+                "link": "https://www.python.org/"
+              },
+              {
+                "badge": "https://img.shields.io/badge/PRs-Welcome-brightgreen.svg?style=for-the-badge",
+                "alt": "PRs Welcome",
+                "link": "${{ env.repo_url }}/pulls"
+              },
+              {
+                "badge": "https://img.shields.io/badge/TestPyPi-${{ env.VERSION }}-brightgreen.svg?style=for-the-badge",
+                "alt": "TestPyPi ${{ env.VERSION }}",
+                "link": "https://test.pypi.org/project/${{ env.REPOSITORY_NAME }}/"
+              },
+              {
+                "badge": "https://img.shields.io/badge/PyPi-${{ env.VERSION }}-brightgreen.svg?style=for-the-badge",
+                "alt": "PyPi ${{ env.VERSION }}",
+                "link": "https://pypi.org/project/${{ env.REPOSITORY_NAME }}/"
+              },
+              {
+                "badge": "https://img.shields.io/badge/Coverage-${{ env.TOTAL_COVERAGE }}%25-${{ steps.coverage-color.outputs.stdout }}.svg?style=for-the-badge",
+                "alt": "Coverage ${{ env.TOTAL_COVERAGE }}%"
+              }
+            ]
+          # Path and file name to add badges
+          path: README.md
+          # Should center align the badges
+          center: false

.github/workflows/publish-documentation.yml

@@ -0,0 +1,33 @@
+name: Publish Documentation
+on:
+  push:
+    branches: ['main', 'release']
+permissions:
+    contents: write
+jobs:
+  sphinx-docs:
+    name: Sphinx Documentation
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout Repository
+        uses: actions/checkout@v3
+      - name: Setup Python
+        uses: actions/setup-python@v4
+        with:
+          python-version: "3.7"
+      - name: Update pip
+        run: python3 -m pip install --upgrade pip
+      - name: Install dependencies
+        run: python3 -m pip install -r requirements.txt
+      - name: Generate documentation for modules
+        run: python3 setup.py sphinx_update_modules
+      - name: Build Sphinx documentation
+        run: python3 setup.py sphinx_build
+      - name: Publish Documentation
+        uses: peaceiris/actions-gh-pages@v3
+        with:
+          publish_branch: gh-pages
+          github_token: ${{ secrets.GITHUB_TOKEN }}
+          publish_dir: docs/build/
+          force_orphan: true
+          keep_files: true

.github/workflows/release.yml

@@ -0,0 +1,80 @@
+name: Release New Version
+on:
+  push:
+    branches:
+      - main
+env:
+  REPOSITORY_NAME: py-git
+jobs:
+  create-release:
+    name: Create a new release
+    permissions: write-all
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout Repository
+        uses: actions/checkout@v2
+      - name: Setup Python
+        uses: actions/setup-python@v4
+        with:
+          python-version: "3.7"
+      - name: Retrieve Release Version
+        id: version
+        run: echo "VERSION=$(python3 setup.py --version)" >> "$GITHUB_ENV"
+      - name: "✏️ Generate release changelog"
+        uses: heinrichreimer/[email protected]
+        with:
+          token: ${{ secrets.GITHUB_TOKEN }}
+          futureRelease: "v${{ env.VERSION }}"
+      - name: Create GitHub Release
+        uses: ncipollo/release-action@v1
+        with:
+          tag: "v${{ env.VERSION }}"
+          name: "Release v${{ env.VERSION }}"
+          bodyFile: CHANGELOG.md
+      - name: Install pypa/build
+        run: python3 -m pip install build --user
+      - name: Build a binary wheel and a source tarball
+        run: python3 -m build --sdist --wheel --outdir dist/
+      - name: Publish Artifacts
+        uses: actions/upload-artifact@v3
+        with:
+          name: linux-dist
+          path: dist/
+  publish-library-dev:
+    name: Publish new release on dev
+    needs: ['create-release']
+    permissions: write-all
+    runs-on: ubuntu-latest
+    environment:
+      name: dev
+      url: "https://test.pypi.org/project/${{ env.REPOSITORY_NAME }}/"
+    steps:
+      - name: Checkout Repository
+        uses: actions/checkout@v2
+      - name: Download Artifacts
+        uses: actions/download-artifact@v3
+        with:
+          name: linux-dist
+          path: dist/
+      - name: Publish package distributions to TestPyPI
+        uses: pypa/gh-action-pypi-publish@release/v1
+        with:
+          repository-url: "https://test.pypi.org/legacy/"
+  publish-library-prod:
+    name: Publish new release on prod
+    needs: ['create-release', 'publish-library-dev']
+    permissions: write-all
+    runs-on: ubuntu-latest
+    environment:
+      name: prod
+      url: "https://pypi.org/project/${{ env.REPOSITORY_NAME }}/"
+    steps:
+      - name: Checkout Repository
+        uses: actions/checkout@v2
+      - name: Download Artifacts
+        uses: actions/download-artifact@v3
+        with:
+          name: linux-dist
+          path: dist/
+      - name: Publish package distributions to PyPI
+        uses: pypa/gh-action-pypi-publish@release/v1

.gitignore

@@ -70,6 +70,7 @@ instance/
 
 # Sphinx documentation
 docs/_build/
+docs/build/
 
 # PyBuilder
 .pybuilder/
@@ -157,4 +158,7 @@ cython_debug/
 #  be found at https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore
 #  and can be added to the global gitignore or merged into this file.  For a more nuclear
 #  option (not recommended) you can uncomment the following to ignore the entire idea folder.
-#.idea/
+.idea/
+
+# MacOS DB file
+.DS_Store