feat: Initial commit

.editorconfig

@@ -0,0 +1,29 @@
+# top-most EditorConfig file
+root = true
+
+# Unix-style newlines with a newline ending every file
+[*]
+charset = utf-8
+end_of_line = lf
+indent_style = space
+insert_final_newline = true
+trim_trailing_whitespace = false
+
+# Windows files
+[*.{bat}]
+indent_style = space
+indent_size = 4
+end_of_line = crlf
+charset = sjis
+
+# 2 space indentation
+[*.{yml,js,json,rst,html,css,md,toml}]
+indent_size = 2
+
+# 4 space indentation
+[*.{py}]
+indent_size = 4
+
+# Tab indentation (no size specified)
+[Makefile,*.{cfg}]
+indent_style = tab

.github/workflows/main.yml

@@ -0,0 +1,50 @@
+name: Continuous Integration
+
+on:
+  push:
+  pull_request:
+  workflow_dispatch:
+
+jobs:
+  lint:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+      - name: Setup python
+        uses: actions/setup-python@v4
+        with:
+          architecture: x64
+          python-version: '3.11'
+      - name: Lint by pre-commit
+        run: |
+          pip install pre-commit
+          pre-commit run --all-files
+  test:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        python-version: ['3.8', '3.9', '3.10', '3.11', '3.12']
+    steps:
+      - uses: actions/checkout@v3
+      - name: Set up Python
+        uses: actions/setup-python@v4
+        with:
+          architecture: x64
+          python-version: ${{ matrix.python-version }}
+      - name: Install dependencies
+        run: pip install '.[test]'
+      - name: Run test
+        run: pytest
+  docs:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+      - name: Set up Python
+        uses: actions/setup-python@v4
+        with:
+          architecture: x64
+          python-version: '3.11'
+      - name: Install dependencies
+        run: pip install '.[doc]'
+      - name: Run check
+        run: make -C docs linkcheck

.github/workflows/release.yml

@@ -0,0 +1,84 @@
+name: Release new version
+
+on:
+  push:
+    tags:
+      - 'v*.*.*'
+
+jobs:
+  # Build and configure package(s)
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+      - uses: actions/setup-python@v4
+        with:
+          architecture: x64
+          python-version: '3.11'
+      - name: Build packages
+        run: |
+          pip install flit
+          flit build
+      - name: Store filepath
+        id: store-filepath
+        run: |
+          echo ::set-output name=targz::$(basename $(ls dist/*tar.gz))
+          echo ::set-output name=wheel::$(basename $(ls dist/*whl))
+      - uses: actions/upload-artifact@v3
+        with:
+          name: dist-packages
+          path: dist
+    outputs:
+      package-targz: ${{ steps.store-filepath.outputs.targz }}
+      package-wheel: ${{ steps.store-filepath.outputs.wheel }}
+  # Collect information from tagged release
+  prepare:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Check stage from tag
+        id: parse-tag
+        run: |
+          echo ::set-output name=is-core-release::$(echo ${{ github.ref_name }} | grep '^v[0-9]\+\.[0-9]\+\.[0-9]\+$'|wc -l)
+    outputs:
+      is-prerelease: ${{ steps.parse-tag.outputs.is-core-release != '1' }}
+      is-release: ${{ steps.parse-tag.outputs.is-core-release == '1' }}
+  publish-pypi:
+    runs-on: ubuntu-latest
+    needs:
+      - build
+      - prepare
+    if: success() && ${{ needs.prepare.outputs.is-release }}
+    steps:
+      - uses: actions/download-artifact@v3
+        with:
+          name: dist-packages
+          path: dist/
+      - name: Publish to PyPI
+        uses: pypa/gh-action-pypi-publish@release/v1
+        with:
+          user: __token__
+          password: ${{ secrets.PYPI_API_TOKEN }}
+  github-releases:
+    runs-on: ubuntu-latest
+    needs:
+      - build
+      - prepare
+    permissions:
+      contents: write
+    env:
+      GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+    steps:
+      - uses: actions/download-artifact@v3
+        with:
+          name: dist-packages
+          path: dist/
+      - name: Create release on GitHub
+        id: create-release
+        uses: ncipollo/release-action@v1
+        with:
+          name: Release ${{ github.ref_name }}
+          body: |
+            To know update details, please see [Changelog](/CHANGES.rst)
+          draft: false
+          prerelease: ${{ needs.prepare.outputs.is-prerelease }}
+          artifacts: 'dist/*'

.gitignore

@@ -0,0 +1,174 @@
+### GIGI version 0.1.0
+### command with: python
+
+### Python ###
+# 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/
+
+### Python Patch ###
+# Poetry local configuration file - https://python-poetry.org/docs/configuration/#local-configuration
+poetry.toml
+
+# ruff
+.ruff_cache/
+
+# LSP config files
+pyrightconfig.json

.pre-commit-config.yaml

@@ -0,0 +1,25 @@
+repos:
+  - repo: https://github.com/psf/black
+    rev: 22.10.0
+    hooks:
+      - id: black
+  - repo: https://github.com/PyCQA/doc8
+    rev: v1.0.0
+    hooks:
+      - id: doc8
+        args:
+          - '--max-line-length=119'
+  - repo: https://github.com/PyCQA/flake8
+    rev: 5.0.4
+    hooks:
+      - id: flake8
+        args:
+          - '--max-line-length=88'
+  - repo: https://github.com/PyCQA/isort
+    rev: 5.12.0
+    hooks:
+      - id: isort
+  - repo: https://github.com/PyCQA/pydocstyle
+    rev: 6.1.1
+    hooks:
+      - id: pydocstyle

CHANGES.rst

@@ -0,0 +1,10 @@
+===========
+Change logs
+===========
+
+v0.0.0
+======
+
+:date: 2023-05-01
+
+Initial commit.