hut-services 0.1.0__tar.gz

hut_services-0.1.0/.bumpversion.cfg

@@ -0,0 +1,9 @@
+[bumpversion]
+current_version = 0.1.0
+commit = False
+tag = False
+allow_dirty = True
+
+[bumpversion:file:pyproject.toml]
+search = version = "{current_version}"
+replace = version = "{new_version}"

hut_services-0.1.0/.editorconfig

@@ -0,0 +1,5 @@
+max_line_length = 120
+
+[*.json]
+indent_style = space
+indent_size = 4

hut_services-0.1.0/.github/actions/setup-venv/action.yml

@@ -0,0 +1,28 @@
+name: "setup-uv-env"
+description: "Composite action to setup the Python and uv environment."
+
+inputs:
+  python-version:
+    required: false
+    description: "The python version to use"
+    default: "3.12"
+
+runs:
+  using: "composite"
+  steps:
+    - name: "Install uv"
+      uses: astral-sh/setup-uv@v4
+      with:
+        # Install a specific version of uv.
+        version: "0.5.8"
+        enable-cache: true
+        cache-dependency-glob: "uv.lock"
+
+    - name: "Set up Python"
+      uses: actions/setup-python@v5
+      with:
+        python-version-file: ".python-version"
+
+    - name: Install the project
+      run: uv sync --all-extras --dev
+      shell: bash

hut_services-0.1.0/.github/workflows/docu.yml

@@ -0,0 +1,33 @@
+name: Build & Publish Docu
+
+on:
+  push:
+    tags:
+      - "v*.*.*"
+  workflow_dispatch:
+  repository_dispatch:
+    types: [new-tag-created]
+
+jobs:
+  deploy:
+    runs-on: ubuntu-latest
+    # Sets the permissions granted to the `GITHUB_TOKEN` for the actions in this job.
+    permissions:
+      contents: write
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v4
+      - name: Configure Git Credentials
+        run: |
+          git config user.name github-actions[bot]
+          git config user.email 41898282+github-actions[bot]@users.noreply.github.com
+      - name: Set up the environment
+        uses: ./.github/actions/setup-venv
+      - run: echo "cache_id=$(date --utc '+%V')" >> $GITHUB_ENV
+      - uses: actions/cache@v4
+        with:
+          key: mkdocs-material-${{ env.cache_id }}
+          path: .cache
+          restore-keys: |
+            mkdocs-material-
+      - run: uv run mkdocs gh-deploy --force

hut_services-0.1.0/.github/workflows/main.yml

@@ -0,0 +1,36 @@
+name: Main
+
+on:
+  push:
+    branches:
+      - main
+  pull_request:
+    types: [opened, synchronize, reopened, ready_for_review]
+
+jobs:
+  quality:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Check out
+        uses: actions/checkout@v4
+
+      - name: Set up the environment
+        uses: ./.github/actions/setup-venv
+
+      - name: Run checks
+        run: uv run inv check
+
+      - name: Run test
+        run: uv run inv tests.run
+
+  #check-docs:
+  #  runs-on: ubuntu-latest
+  #  steps:
+  #    - name: Check out
+  #      uses: actions/checkout@v4
+
+  #    - name: Set up the environment
+  #      uses: ./.github/actions/setup-venv
+
+  #    - name: Check if documentation can be built
+  #      run: uv run mkdocs build -s

hut_services-0.1.0/.github/workflows/main.yml.old

@@ -0,0 +1,70 @@
+name: Main
+
+on:
+  push:
+    branches:
+      - main
+  pull_request:
+    types: [opened, synchronize, reopened, ready_for_review]
+
+jobs:
+  quality:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Check out
+        uses: actions/checkout@v3
+
+      - uses: actions/cache@v3
+        with:
+          path: ~/.cache/pre-commit
+          key: pre-commit-${{ hashFiles('.pre-commit-config.yaml') }}
+
+      - name: Set up the environment
+        uses: ./.github/actions/setup-uv-env
+
+      - name: Run checks
+        run: make check
+
+  #tox:
+  #  runs-on: ubuntu-latest
+  #  strategy:
+  #    matrix:
+  #      python-version: ["3.10", "3.11"]
+  #    fail-fast: false
+  #  steps:
+  #    - name: Check out
+  #      uses: actions/checkout@v3
+
+  #    - name: Set up python
+  #      uses: actions/setup-python@v4
+  #      with:
+  #        python-version: ${{ matrix.python-version }}
+
+  #    - name: Install Poetry
+  #      uses: snok/install-poetry@v1
+
+  #    - name: Load cached venv
+  #      uses: actions/cache@v3
+  #      with:
+  #        path: .tox
+  #        key: venv-${{ runner.os }}-${{ matrix.python-version }}-${{ hashFiles('poetry.lock') }}
+
+  #    - name: Install tox
+  #      run: |
+  #        python -m pip install --upgrade pip
+  #        python -m pip install tox tox-gh-actions
+
+  #    - name: Test with tox
+  #      run: tox
+
+  #check-docs:
+  #  runs-on: ubuntu-latest
+  #  steps:
+  #    - name: Check out
+  #      uses: actions/checkout@v3
+
+  #    - name: Set up the environment
+  #      uses: ./.github/actions/setup-poetry-env
+
+  #    - name: Check if documentation can be built
+  #      run: poetry run mkdocs build -s

hut_services-0.1.0/.github/workflows/new-version.yml

@@ -0,0 +1,51 @@
+name: New Version
+
+on:
+  workflow_run:
+    workflows: ["Main"]
+    types:
+      - completed
+
+jobs:
+  check-and-tag:
+    if: ${{ github.event.workflow_run.conclusion == 'success' }}
+    runs-on: ubuntu-latest
+    permissions:
+      contents: write
+
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v4
+
+      - name: Set up the environment
+        uses: ./.github/actions/setup-venv
+
+      - name: Extract latest version
+        id: latest-version
+        run: |
+          VERSION=$(uv run inv version); echo "Current version: $VERSION"
+          echo "version=$VERSION" >> $GITHUB_ENV
+
+      - name: Check if tag exists
+        uses: mukunku/tag-exists-action@v1.6.0
+        id: check-tag
+        with:
+          tag: "v${{ env.version }}"
+
+      - name: Create and push tag if not exists
+        if: steps.check-tag.outputs.exists == 'false'
+        run: |
+          echo "Creating new tag: v${{ env.version }}"
+          git tag "v${{ env.version }}"
+          git push origin "v${{ env.version }}"
+
+      - name: Trigger repository_dispatch if tag is created
+        if: steps.check-tag.outputs.exists == 'false'
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+        run: |
+          curl -X POST \
+            -H "Accept: application/vnd.github.everest-preview+json" \
+            -H "Authorization: token $GITHUB_TOKEN" \
+            https://api.github.com/repos/${{ github.repository }}/dispatches \
+            -d '{"event_type": "new-tag-created", "client_payload": { "version": "${{ env.version }}" }}'

hut_services-0.1.0/.github/workflows/publish-pypi.yml

@@ -0,0 +1,32 @@
+name: Publish to PyPi
+
+# Configures this workflow to run every time a change is pushed to the branch called `release`.
+on:
+  push:
+    tags:
+      - "v*.*.*"
+  repository_dispatch:
+    types: [new-tag-created]
+
+jobs:
+  pypi-publish:
+    name: Upload release to PyPI
+    runs-on: ubuntu-latest
+    environment:
+      name: pypi
+      url: https://pypi.org/p/${{ github.repository }}
+    permissions:
+      id-token: write # IMPORTANT: this permission is mandatory for trusted publishing
+    steps:
+      # retrieve your distributions here
+      - name: Checkout code
+        uses: actions/checkout@v4
+
+      - name: Set up the environment
+        uses: ./.github/actions/setup-venv
+
+      - name: Build Package
+        run: uv build
+
+      - name: Publish package distributions to PyPI
+        uses: pypa/gh-action-pypi-publish@release/v1

hut_services-0.1.0/.github/workflows/release.yml.wait

@@ -0,0 +1,41 @@
+name: Create Release
+
+on:
+  push:
+    tags:
+      - "v*.*.*"
+  repository_dispatch:
+    types: [new-tag-created]
+
+jobs:
+  create-release:
+    runs-on: ubuntu-latest
+    permissions:
+      contents: write
+
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v4
+
+      - name: Set up the environment
+        uses: ./.github/actions/setup-venv
+
+      - name: Get latest changelog
+        id: changelog
+        run: |
+          VERSION=$(uv run inv version); echo "Current version: $VERSION"
+          echo "version=${VERSION}" >> $GITHUB_ENV
+          echo "body<<EOF" >> $GITHUB_ENV
+          BODY=$(uv run inv changelog); echo "Changelog body:"; echo "$BODY"
+          echo "${BODY}" >> $GITHUB_ENV
+          echo "EOF" >> $GITHUB_ENV
+
+      - name: Create GitHub Release
+        uses: softprops/action-gh-release@v2
+        with:
+          tag_name: v${{ env.version }}
+          name: ${{ env.version }}
+          body: ${{ env.body }}
+          draft: false
+          prerelease: false
+          make_latest: true

hut_services-0.1.0/.gitignore

@@ -0,0 +1,167 @@
+docs/source
+
+# From https://raw.githubusercontent.com/github/gitignore/main/Python.gitignore
+
+# 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/
+
+# Vscode config files
+.vscode/
+
+# 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/

hut_services-0.1.0/.pre-commit-config.yaml

@@ -0,0 +1,24 @@
+repos:
+  - repo: https://github.com/pre-commit/pre-commit-hooks
+    rev: "v5.0.0"
+    hooks:
+      - id: check-case-conflict
+      - id: check-merge-conflict
+      - id: check-toml
+      - id: check-yaml
+        args: [--unsafe]
+      - id: end-of-file-fixer
+      - id: trailing-whitespace
+
+  - repo: https://github.com/astral-sh/ruff-pre-commit
+    rev: "v0.8.2"
+    hooks:
+      - id: ruff
+        args: [--exit-non-zero-on-fix]
+      - id: ruff-format
+
+  - repo: https://github.com/pre-commit/mirrors-prettier
+    rev: "v3.0.3"
+    hooks:
+      - id: prettier
+        types_or: [css, javascript, json, scss, yaml]

hut_services-0.1.0/.python-version

@@ -0,0 +1 @@
+3.10

hut_services-0.1.0/CHANGELOG.md

@@ -0,0 +1,34 @@
+<!-- Auto generated. Run 'inv release' in order to update -->
+
+# Changelog
+
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+## [0.1.0] - 2025-01-05
+
+#### 🚀 Features
+- Add photos support ([#3]) - [dc2caed]
+
+#### 📘 Documentation
+- Add documentation page ([#6]) - [a630a92]
+
+#### 💻 Tooling
+- Replace `make` with [`invoke`](https://www.pyinvoke.org/) (see `inv help`) ([#5]) - [1c26026]
+- Change from `poetry` to [`uv`](https://docs.astral.sh/uv/) ([#4]) - [748bca2]
+
+
+[#3]: https://github.com/wodore/hut-services/pull/3
+[dc2caed]: https://github.com/wodore/hut-services/commit/dc2caed474dec35516c2b551dd47f5c187513603
+
+[#6]: https://github.com/wodore/hut-services/pull/6
+[a630a92]: https://github.com/wodore/hut-services/commit/a630a92420d80e0bcfd42d998de9b9dfa1f374d9
+
+[#5]: https://github.com/wodore/hut-services/pull/5
+[1c26026]: https://github.com/wodore/hut-services/commit/1c2602652e3e279d4c62f62179c19d9ff3b00c07
+[#4]: https://github.com/wodore/hut-services/pull/4
+[748bca2]: https://github.com/wodore/hut-services/commit/748bca223545c160fb0f817cd78966c63883a17c
+
+[0.1.0]: https://github.com/wodore/hut-services/releases/tag/v0.1.0

hut_services-0.1.0/CONTRIBUTING.md

@@ -0,0 +1,98 @@
+# Contributing to `hut-services`
+
+Contributions are welcome, and they are greatly appreciated!
+Every little bit helps, and credit will always be given.
+
+You can contribute in many ways:
+
+# Types of Contributions
+
+## Report Bugs
+
+Report bugs at https://github.com/wodore/hut-services/issues
+
+If you are reporting a bug, please include:
+
+- Your operating system name and version.
+- Any details about your local setup that might be helpful in troubleshooting.
+- Detailed steps to reproduce the bug.
+
+## Submit Feedback
+
+The best way to send feedback is to file an issue at https://github.com/wodore/hut-services/issues.
+
+If you are proposing a new feature:
+
+- Explain in detail how it would work.
+- Keep the scope as narrow as possible, to make it easier to implement.
+- Remember that this is a volunteer-driven project, and that contributions
+  are welcome :)
+
+# Get Started!
+
+Ready to contribute? Here's how to set up `hut-services` for local development.
+Please note this documentation assumes you already have `poetry` and `Git` installed and ready to go.
+
+1. Fork the `hut-services` repo on GitHub.
+
+2. Clone your fork locally:
+
+```bash
+cd <directory_in_which_repo_should_be_created>
+git clone git@github.com:YOUR_NAME/hut-services.git
+```
+
+3. Now we need to install the environment. Navigate into the directory
+
+```bash
+cd hut-services
+```
+
+
+Then, install and activate the environment with:
+
+```bash
+make init
+source .venv/bin/activate
+```
+
+4. Create a branch for local development:
+
+```bash
+git checkout -b name-of-your-bugfix-or-feature
+```
+
+Now you can make your changes locally.
+
+5. Don't forget to add test cases for your added functionality to the `tests` directory.
+
+6. When you're done making changes, check that your changes pass the formatting tests.
+
+```bash
+inv check
+```
+
+Now, validate that all unit tests are passing:
+
+```bash
+inv tests.run
+```
+
+7. Commit your changes and push your branch to GitHub:
+
+```bash
+git add .
+git commit -m "Your detailed description of your changes."
+git push origin name-of-your-bugfix-or-feature
+```
+
+8. Submit a pull request through the GitHub website.
+
+# Pull Request Guidelines
+
+Before you submit a pull request, check that it meets these guidelines:
+
+1. The pull request should include tests.
+
+2. If the pull request adds functionality, the docs should be updated.
+   Put your new functionality into a function with a docstring, and add the feature to the list in `README.md`.

hut_services-0.1.0/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2023, TBxy
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

hut_services-0.1.0/Makefile

@@ -0,0 +1,20 @@
+
+.PHONY: init
+init: ## Install the uv environment and install the pre-commit hooks
+	@echo "Creating virtual environment using uv"
+	@uv sync
+	@ uv run invoke install
+
+.PHONY: docs-test
+docs-test: ## Test if documentation can be built without warnings or errors
+	@uv run mkdocs build -s
+
+.PHONY: docs
+docs: ## Build and serve the documentation
+	@uv run mkdocs serve -a localhost:8083 -w src
+
+.PHONY: help
+help:
+	@grep -E '^[a-zA-Z_-]+:.*?## .*$$' $(MAKEFILE_LIST) | awk 'BEGIN {FS = ":.*?## "}; {printf "\033[36m%-20s\033[0m %s\n", $$1, $$2}'
+
+.DEFAULT_GOAL := help