initial commit

.github/workflows/docs.yml

@@ -0,0 +1,57 @@
+# Simple workflow for deploying static content to GitHub Pages
+name: Deploy Documentation to GitHub pages
+
+on:
+  release:
+    types: [published]
+
+  # Allows you to run this workflow manually from the Actions tab
+  workflow_dispatch:
+
+# Sets permissions of the GITHUB_TOKEN to allow deployment to GitHub Pages
+permissions:
+  contents: read
+  pages: write
+  id-token: write
+
+# Allow only one concurrent deployment,
+# skipping runs queued between the run in-progress and latest queued.
+# However, do NOT cancel in-progress runs as we want to allow
+# these production deployments to complete.
+concurrency:
+  group: "pages"
+  cancel-in-progress: false
+
+jobs:
+  # Single deploy job since we're just deploying
+  deploy:
+    environment:
+      name: github-pages
+      url: ${{ steps.deployment.outputs.page_url }}
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v3
+      - name: Set up Python 3.10
+        uses: actions/setup-python@v3
+        with:
+          python-version: "3.10"
+      - name: Install dependencies
+        run: |
+          python -m pip install --upgrade pip
+          pip install -r requirements.txt
+          pip install -r doc-requirements.txt
+      - name: Build documentation
+        run: |
+          cd docs
+          make html
+      - name: Setup Pages
+        uses: actions/configure-pages@v3
+      - name: Upload artifact
+        uses: actions/upload-pages-artifact@v2
+        with:
+          # Upload entire repository
+          path: './docs/_build/html'
+      - name: Deploy to GitHub Pages
+        id: deployment
+        uses: actions/deploy-pages@v2

.github/workflows/lint.yml

@@ -0,0 +1,21 @@
+name: Lint
+
+on: [push]
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v3
+    - name: Set up Python
+      uses: actions/setup-python@v3
+      with:
+        python-version: '3.10'
+    - name: Install dependencies
+      run: |
+        python -m pip install --upgrade pip
+        if [ -f requirements.txt ]; then pip install -r requirements.txt; fi
+        if [ -f requirements.txt ]; then pip install -r dev-requirements.txt; fi
+    - name: Analysing the code with pylint and yamllint
+      run: |
+        make lint

.github/workflows/pypi-publish.yml

@@ -0,0 +1,35 @@
+name: Upload Python Package To pypi
+
+on:
+  release:
+    types: [published]
+
+  # Allows you to run this workflow manually from the Actions tab
+  workflow_dispatch:
+
+permissions:
+  contents: read
+
+jobs:
+  deploy:
+
+    runs-on: ubuntu-latest
+
+    steps:
+    - uses: actions/checkout@v3
+    - name: Set up Python
+      uses: actions/setup-python@v3
+      with:
+        python-version: '3.x'
+    - name: Install dependencies
+      run: |
+        python -m pip install --upgrade pip
+        pip install build
+    - name: Build package
+      run: |
+        python -m build
+    - name: Publish package
+      uses: pypa/gh-action-pypi-publish@27b31702a0e7fc50959f5ad993c78deac1bdfc29
+      with:
+        user: __token__
+        password: ${{ secrets.PYPI_API_TOKEN }}

.github/workflows/run-tests.yml

@@ -0,0 +1,28 @@
+name: Run Tests
+
+on: [push, pull_request]
+
+permissions:
+  contents: read
+
+jobs:
+  build:
+
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        python-version: ["3.10", "3.11"]
+    steps:
+    - uses: actions/checkout@v3
+    - name: Set up Python ${{ matrix.python-version }}
+      uses: actions/setup-python@v3
+      with:
+        python-version: ${{ matrix.python-version }}
+    - name: Install dependencies
+      run: |
+        python -m pip install --upgrade pip
+        if [ -f requirements.txt ]; then pip install -r requirements.txt; fi
+        if [ -f dev-requirements.txt ]; then pip install -r requirements.txt; fi
+    - name: Test with pytest
+      run: |
+        make coverage

.gitignore

@@ -1 +1,160 @@
-.idea
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[cod]
+*$py.class
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+share/python-wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+MANIFEST
+
+# PyInstaller
+#  Usually these files are written by a python script from a template
+#  before PyInstaller builds the exe, so as to inject date/other infos into it.
+*.manifest
+*.spec
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.nox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*.cover
+*.py,cover
+.hypothesis/
+.pytest_cache/
+cover/
+
+# Translations
+*.mo
+*.pot
+
+# Django stuff:
+*.log
+local_settings.py
+db.sqlite3
+db.sqlite3-journal
+
+# Flask stuff:
+instance/
+.webassets-cache
+
+# Scrapy stuff:
+.scrapy
+
+# Sphinx documentation
+docs/_build/
+
+# PyBuilder
+.pybuilder/
+target/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# IPython
+profile_default/
+ipython_config.py
+
+# pyenv
+#   For a library or package, you might want to ignore these files since the code is
+#   intended to run in multiple environments; otherwise, check them in:
+# .python-version
+
+# pipenv
+#   According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
+#   However, in case of collaboration, if having platform-specific dependencies or dependencies
+#   having no cross-platform support, pipenv may install dependencies that don't work, or not
+#   install all needed dependencies.
+#Pipfile.lock
+
+# poetry
+#   Similar to Pipfile.lock, it is generally recommended to include poetry.lock in version control.
+#   This is especially recommended for binary packages to ensure reproducibility, and is more
+#   commonly ignored for libraries.
+#   https://python-poetry.org/docs/basic-usage/#commit-your-poetrylock-file-to-version-control
+#poetry.lock
+
+# pdm
+#   Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control.
+#pdm.lock
+#   pdm stores project-wide configurations in .pdm.toml, but it is recommended to not include it
+#   in version control.
+#   https://pdm.fming.dev/#use-with-ide
+.pdm.toml
+
+# PEP 582; used by e.g. github.com/David-OConnor/pyflow and github.com/pdm-project/pdm
+__pypackages__/
+
+# Celery stuff
+celerybeat-schedule
+celerybeat.pid
+
+# SageMath parsed files
+*.sage.py
+
+# Environments
+.env
+.venv
+env/
+venv/
+ENV/
+env.bak/
+venv.bak/
+
+# Spyder project settings
+.spyderproject
+.spyproject
+
+# Rope project settings
+.ropeproject
+
+# mkdocs documentation
+/site
+
+# mypy
+.mypy_cache/
+.dmypy.json
+dmypy.json
+
+# Pyre type checker
+.pyre/
+
+# pytype static type analyzer
+.pytype/
+
+# Cython debug symbols
+cython_debug/
+
+# PyCharm
+#  JetBrains specific template is maintained in a separate JetBrains.gitignore that can
+#  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/

CHECKLIST.md

@@ -1,38 +1,39 @@
 [Main points](https://github.com/libresource/open-source-checklist#main-points)
 - [x] [Open Source Project Checklist](https://github.com/libresource/open-source-checklist#open-source-project-checklist)
-- [ ] [Existing Analogues](https://github.com/libresource/open-source-checklist#existing-analogues)
-- [ ] [Good Project Name](https://github.com/libresource/open-source-checklist#good-project-name)
-- [ ] [Mission](https://github.com/libresource/open-source-checklist#mission)
-- [ ] [State What the Project Is Free](https://github.com/libresource/open-source-checklist#state-what-the-project-is-free)
-- [ ] [Features](https://github.com/libresource/open-source-checklist#features)
-- [ ] [Requirements](https://github.com/libresource/open-source-checklist#requirements)
-- [ ] [Development Status](https://github.com/libresource/open-source-checklist#development-status)
-- [ ] [Download Page](https://github.com/libresource/open-source-checklist#download-page)
-- [ ] [Version Control Access](https://github.com/libresource/open-source-checklist#version-control-access)
-- [ ] [Bug Tracker Access](https://github.com/libresource/open-source-checklist#bug-tracker-access)
-- [ ] [Communication Channels](https://github.com/libresource/open-source-checklist#communication-channels)
-- - [ ] Discussions
+- [x] [Existing Analogues](https://github.com/libresource/open-source-checklist#existing-analogues)
+- [x] [Good Project Name](https://github.com/libresource/open-source-checklist#good-project-name)
+- [x] [Mission](https://github.com/libresource/open-source-checklist#mission)
+- [x] [State What the Project Is Free](https://github.com/libresource/open-source-checklist#state-what-the-project-is-free)
+- [x] [Features](https://github.com/libresource/open-source-checklist#features)
+- [x] [Requirements](https://github.com/libresource/open-source-checklist#requirements)
+- [x] [Development Status](https://github.com/libresource/open-source-checklist#development-status)
+- [x] [Download Page](https://github.com/libresource/open-source-checklist#download-page)
+- [x] [Version Control Access](https://github.com/libresource/open-source-checklist#version-control-access)
+- [x] [Bug Tracker Access](https://github.com/libresource/open-source-checklist#bug-tracker-access)
+- [x] [Communication Channels](https://github.com/libresource/open-source-checklist#communication-channels)
+- - [x] Discussions
 - - [ ] Mailing List
 - - [ ] Real-time chat
 - - [ ] Forum
-- [ ] [Developer Guidelines](https://github.com/libresource/open-source-checklist#developer-guidelines)
-- [ ] [Documentation](https://github.com/libresource/open-source-checklist#documentation)
-- [ ] [Developer Documentation](https://github.com/libresource/open-source-checklist#developer-documentation)
-- [ ] [Availability of Documentation](https://github.com/libresource/open-source-checklist#availability-of-documentation)
-- [ ] [FAQ](https://github.com/libresource/open-source-checklist#faq)
+- [x] [Developer Guidelines](https://github.com/libresource/open-source-checklist#developer-guidelines)
+- [x] [Documentation](https://github.com/libresource/open-source-checklist#documentation)
+- [x] [Developer Documentation](https://github.com/libresource/open-source-checklist#developer-documentation)
+- [x] [Availability of Documentation](https://github.com/libresource/open-source-checklist#availability-of-documentation)
+- [x] [FAQ](https://github.com/libresource/open-source-checklist#faq)
 - [ ] [Examples Output and Screenshots](https://github.com/libresource/open-source-checklist#examples-output-and-screenshots)
-- [ ] [License](https://github.com/libresource/open-source-checklist#license)
-- [ ] [Code of Conduct](https://github.com/libresource/open-source-checklist#code-of-conduct)
-- [ ] [Security Policy](https://github.com/libresource/open-source-checklist#security-policy)
-- [ ] [Governance](https://github.com/libresource/open-source-checklist#governance)
-- [ ] [Issue templates](https://github.com/libresource/open-source-checklist#issue-templates)
-- [ ] [Support](https://github.com/libresource/open-source-checklist#support)
+- [x] [License](https://github.com/libresource/open-source-checklist#license)
+- [x] [Code of Conduct](https://github.com/libresource/open-source-checklist#code-of-conduct)
+- [x] [Security Policy](https://github.com/libresource/open-source-checklist#security-policy)
+- [x] [Governance](https://github.com/libresource/open-source-checklist#governance)
+- [x] [Issue templates](https://github.com/libresource/open-source-checklist#issue-templates)
+- [x] [Support](https://github.com/libresource/open-source-checklist#support)
 
 [CI and CD](https://github.com/libresource/open-source-checklist#ci-and-cd)
-- [ ] Tests
-- [ ] Test Coverage
-- [ ] Test Coverage 100%
-- [ ] Linters
-- [ ] Build
-- [ ] Deploy
-- [ ] [New User Greetings](https://github.com/libresource/open-source-checklist#new-user-greetings)
+- [x] Tests
+- [x] Test Coverage
+- [x] Test Coverage 100%
+- [x] Linters
+- [x] Build
+- [x] Deploy
+- [x] Build and Deploy documentation
+- [x] [New User Greetings](https://github.com/libresource/open-source-checklist#new-user-greetings)