alpyki 0.2.0__tar.gz

alpyki-0.2.0/.editorconfig

@@ -0,0 +1,15 @@
+root = true
+
+[*]
+charset = utf-8
+end_of_line = lf
+insert_final_newline = true
+indent_style = space
+indent_size = 4
+trim_trailing_whitespace = true
+
+[*.{yml, yaml, sh}]
+indent_size = 2
+
+[Makefile]
+indent_style = tab

alpyki-0.2.0/.flake8

@@ -0,0 +1,2 @@
+[flake8]
+max-line-length = 120

alpyki-0.2.0/.gitea/actions/lint/action.yaml

@@ -0,0 +1,26 @@
+name: lint
+description: Run alpyki tests
+runs:
+  using: composite
+  steps:
+    - name: Lint changelog
+      uses: docker://avtodev/markdown-lint:v1
+      with:
+        rules: "/lint/rules/changelog.js"
+        config: "/lint/config/changelog.yml"
+        args: "CHANGELOG.md"
+    - name: Lint other Markdown files
+      uses: articulate/actions-markdownlint@main
+      with:
+        files: "**/*.md"
+        ignore: CHANGELOG.md
+        config: .markdownlint.yaml
+        version: 0.28.1
+    - uses: ricardochaves/python-lint@v1.4.0
+      with:
+        use-pylint: false
+        use-pycodestyle: false
+        use-flake8: true
+        use-black: true
+        use-mypy: false
+        use-isort: false

alpyki-0.2.0/.gitea/actions/test/action.yaml

@@ -0,0 +1,31 @@
+name: test
+description: Run alpyki tests
+inputs:
+  python-version:
+    description: The Python version to use
+    required: false
+    default: "3.11"
+runs:
+  using: composite
+  steps:
+    - name: Set up Python ${{ inputs.python-version }}
+      uses: actions/setup-python@v7.0.0
+      with:
+        python-version: ${{ inputs.python-version }}
+        cache: pip
+    - name: Install dependencies
+      shell: bash
+      run: |
+        pip install -e '.[test]' -e '.[doc]'
+    - name: Run pytest
+      shell: bash
+      run: |
+        pytest
+    - name: mypy
+      shell: bash
+      run: |
+        mypy alpyki
+    - name: Try to generate documentation
+      shell: bash
+      run: |
+        pdoc --output-dir docs alpyki

alpyki-0.2.0/.gitea/workflows/publish_pypi.yaml

@@ -0,0 +1,80 @@
+name: Publish to PyPI
+
+on:
+  push:
+    tags:
+      - 'v[0-9]+.[0-9]+.[0-9]+'
+
+permissions:
+  contents: write
+
+jobs:
+  publish:
+    name: Publish to PyPI
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: builtin:checkout
+        with:
+          fetch-depth: 0
+
+      - name: Set up Python
+        uses: actions/setup-python@v7.0.0
+        with:
+          python-version: "3.11"
+
+      - name: Install build dependencies
+        run: pip install build twine
+
+      - name: Build package
+        run: python -m build
+
+      - name: Validate version
+        run: |
+          pip install .
+          python script/validate_version.py -e "${{ github.ref_name }}"
+
+      - name: Build Changelog
+        id: changelog
+        uses: mikepenz/release-changelog-builder-action@v6.4.0
+        with:
+          platform: gitea
+          baseUrl: ${{ gitea.server_url }}
+        env:
+          GITEA_TOKEN: ${{ secrets.GITEA_TOKEN }}
+
+      - name: Create Gitea release
+        uses: softprops/action-gh-release@v2
+        with:
+          files: dist/*
+          body: ${{ steps.changelog.outputs.changelog }}
+
+      - name: Install GitHub CLI
+        if: ${{ secrets.GH_TOKEN != '' }}
+        run: |
+          (type -p wget >/dev/null || (sudo apt update && sudo apt install wget -y)) \
+          && sudo mkdir -p -m 755 /etc/apt/keyrings \
+          && out=$(mktemp) && wget -nv -O$out https://cli.github.com/packages/githubcli-archive-keyring.gpg \
+          && cat $out | sudo tee /etc/apt/keyrings/githubcli-archive-keyring.gpg > /dev/null \
+          && sudo chmod go+r /etc/apt/keyrings/githubcli-archive-keyring.gpg \
+          && sudo mkdir -p -m 755 /etc/apt/sources.list.d \
+          && echo "deb [arch=$(dpkg --print-architecture) signed-by=/etc/apt/keyrings/githubcli-archive-keyring.gpg] https://cli.github.com/packages stable main" | sudo tee /etc/apt/sources.list.d/github-cli.list > /dev/null \
+          && sudo apt update \
+          && sudo apt install gh -y
+
+      - name: Create GitHub release
+        if: ${{ secrets.GH_TOKEN != '' }}
+        run: |
+          gh release create ${{ github.ref_name }} \
+            --repo ${GITHUB_REPOSITORY/$GITHUB_REPOSITORY_OWNER/NotCharlie} \
+            --title ${{ github.ref_name }} \
+            --notes '${{ steps.changelog.outputs.changelog }}' \
+            dist/*
+        env:
+          GH_TOKEN: ${{ secrets.GH_TOKEN }}
+
+      - name: Publish to PyPI
+        env:
+          TWINE_USERNAME: __token__
+          TWINE_PASSWORD: ${{ secrets.PYPI_TOKEN }}
+        run: twine upload dist/*

alpyki-0.2.0/.gitea/workflows/publish_testpypi.yaml

@@ -0,0 +1,41 @@
+name: Publish to TestPyPI
+
+on:
+  push:
+    tags:
+      - 'test-v[0-9]+.[0-9]+.[0-9]+'
+
+permissions:
+  contents: read
+
+jobs:
+  publish:
+    name: Publish to TestPyPI
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: builtin:checkout
+        with:
+          fetch-depth: 0
+
+      - name: Set up Python
+        uses: actions/setup-python@v7.0.0
+        with:
+          python-version: "3.11"
+
+      - name: Install build dependencies
+        run: pip install build twine
+
+      - name: Build package
+        run: python -m build
+
+      - name: Validate version
+        run: |
+          pip install .
+          python script/validate_version.py -e "${{ github.ref_name }}"
+
+      - name: Publish to TestPyPI
+        env:
+          TWINE_USERNAME: __token__
+          TWINE_PASSWORD: ${{ secrets.TESTPYPI_TOKEN }}
+        run: twine upload --repository testpypi dist/*

alpyki-0.2.0/.gitea/workflows/release.yaml

@@ -0,0 +1,77 @@
+name: Publish
+
+on:
+  push:
+    tags:
+      - 'DISABLED-v*'
+
+jobs:
+  tests-release:
+    name: Tests for release
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        python-version: ["3.9", "3.10", "3.11"]
+    steps:
+      - uses: builtin:checkout
+      - name: Run checks
+        uses: ./.gitea/actions/lint
+      - name: Run tests
+        uses: ./.gitea/actions/test
+        with:
+          python-version: ${{ matrix.python-version }}
+
+  publish:
+    name: Publish package
+    runs-on: ubuntu-latest
+    needs: [tests-release]
+
+    steps:
+    - uses: builtin:checkout
+    - name: Set up Python 3.11
+      uses: actions/setup-python@v7.0.0
+      with:
+        python-version: "3.11"
+        cache: pip
+    - name: Install dependencies
+      run: pip install build
+    - name: Validate that tag matches committed version
+      run: python script/validate_version.py --expected_version=${{ gitea.ref_name }}
+    - name: Build
+      run: python -m build
+    - name: Create Gitea release
+      uses: gitea/gh-release@v1
+      with:
+        files: dist/*
+    - name: Publish package to PyPI
+      uses: pypa/gh-action-pypi-publish@release/v1
+      with:
+        password: ${{ secrets.PYPI_TOKEN }}
+
+  generate-docs:
+    name: Generate docs
+    runs-on: ubuntu-latest
+    needs: [publish]
+
+    steps:
+    - uses: builtin:checkout
+    - name: Set up Python 3.11
+      uses: actions/setup-python@v7.0.0
+      with:
+        python-version: "3.11"
+        cache: pip
+    - name: Install dependencies
+      shell: bash
+      run: |
+        pip install -e '.' -e '.[doc]'
+    - name: Generate docs
+      shell: bash
+      run: |
+        pdoc --output-dir docs alpyki
+    - name: Upload docs artifact
+      uses: gitea/upload-artifact@v1
+      with:
+        name: docs
+        path: docs/
+
+  # TODO: publish release docs to ???

alpyki-0.2.0/.gitea/workflows/test.yaml

@@ -0,0 +1,30 @@
+name: Test
+
+on:
+  pull_request:
+    branches:
+      - main
+  push:
+    branches: "*"
+    tags-ignore:
+      - v*
+      - test-v*
+
+permissions:
+  contents: read
+
+jobs:
+  tests-push-pr:
+    name: Tests
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        python-version: ["3.9", "3.10", "3.11"]
+    steps:
+      - uses: builtin:checkout
+      - name: Run checks
+        uses: ./.gitea/actions/lint
+      - name: Run tests
+        uses: ./.gitea/actions/test
+        with:
+          python-version: ${{ matrix.python-version }}

alpyki-0.2.0/.gitignore

@@ -0,0 +1,163 @@
+# 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
+
+# Documentation
+docs
+
+# 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/