labtasker 0.1.0__tar.gz

labtasker-0.1.0/.coveragerc

@@ -0,0 +1,4 @@
+[run]
+omit =
+# skip those auto-generated codes by antlr
+    labtasker/client/core/cmd_parser/LabCmd*

labtasker-0.1.0/.dockerignore

@@ -0,0 +1,12 @@
+# exclude all,
+**
+
+# except
+!pyproject.toml
+!MANIFEST.in
+!setup.cfg
+!setup.py
+!labtasker/
+
+# also exclude run caches
+**/__pycache__/

labtasker-0.1.0/.gitattributes

@@ -0,0 +1 @@
+* text eol=lf

labtasker-0.1.0/.github/workflows/deploy-doc.yml

@@ -0,0 +1,46 @@
+name: deploy-doc
+on:
+  push:
+    branches:
+      - main
+    tags:
+      - 'v*' # version number
+  workflow_dispatch:
+
+permissions:
+  contents: write
+
+jobs:
+  deploy:
+    runs-on: ubuntu-latest
+    steps:
+      - name: checkout
+        uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
+
+      - name: configure git credentials
+        run: |
+          git config user.name github-actions[bot]
+          git config user.email github-actions[bot]@users.noreply.github.com
+
+      - name: setup python environment
+        uses: actions/setup-python@v5
+        with:
+          python-version: 3.11
+
+      - run: pwd
+      - run: ls -la
+      - run: pip install -e ".[doc]"
+
+      - name: deploy release doc
+        if: ${{ github.ref_type == 'tag' }}
+        run: |
+          cd docs
+          mike deploy --update-alias ${{ github.ref_name }} latest --push --message "Deploy release docs for ${{ github.ref_name }}"
+
+      - name: deploy dev doc
+        if: ${{ github.ref_type == 'branch' }}
+        run: |
+          cd docs
+          mike deploy dev --push

labtasker-0.1.0/.github/workflows/push-ghcr.yml

@@ -0,0 +1,34 @@
+name: push-ghcr-latest
+
+on:
+  push:
+    branches:
+      - main
+  workflow_dispatch:
+
+permissions:
+  contents: read
+  packages: write
+  attestations: write
+  id-token: write
+
+jobs:
+  push-store-image:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
+
+      - name: Login to GitHub Container Registry
+        uses: docker/login-action@v3
+        with:
+          registry: ghcr.io
+          username: ${{github.actor}}
+          password: ${{secrets.GITHUB_TOKEN}}
+
+      - name: Build Inventory Image
+        run: |
+          docker build --tag ghcr.io/fkcptlst/labtasker-api:latest .
+          docker push ghcr.io/fkcptlst/labtasker-api:latest

labtasker-0.1.0/.github/workflows/release.yml

@@ -0,0 +1,50 @@
+name: release to PyPI
+
+on:
+  release:
+    types: [ published ]
+  workflow_dispatch:
+
+permissions:
+  contents: read
+
+jobs:
+  release-build:
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/checkout@v4
+
+      - uses: actions/setup-python@v5
+        with:
+          python-version: "3.13"
+
+      - name: Build release distributions
+        run: |
+          python -m pip install build
+          python -m build
+
+      - name: Upload distributions
+        uses: actions/upload-artifact@v4
+        with:
+          name: release-dists
+          path: dist/
+
+  pypi-publish:
+    name: upload release to PyPI
+    runs-on: ubuntu-latest
+    needs:
+      - release-build
+    environment: pypi
+    permissions:
+      # IMPORTANT: this permission is mandatory for Trusted Publishing
+      id-token: write
+    steps:
+      - name: Retrieve release distributions
+        uses: actions/download-artifact@v4
+        with:
+          name: release-dists
+          path: dist/
+
+      - name: Publish package distributions to PyPI
+        uses: pypa/gh-action-pypi-publish@release/v1

labtasker-0.1.0/.github/workflows/test-doc.yml

@@ -0,0 +1,32 @@
+name: test-doc
+on:
+  pull_request:
+  workflow_dispatch:
+
+jobs:
+  deploy:
+    runs-on: ubuntu-latest
+    steps:
+      - name: checkout
+        uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
+
+      - name: configure git credentials
+        run: |
+          git config user.name github-actions[bot]
+          git config user.email github-actions[bot]@users.noreply.github.com
+
+      - name: setup python environment
+        uses: actions/setup-python@v5
+        with:
+          python-version: 3.11
+
+      - run: pwd
+      - run: ls -la
+      - run: pip install -e ".[doc]"
+
+      - name: build dev doc
+        run: |
+          cd docs
+          mike deploy dev

labtasker-0.1.0/.github/workflows/unit-test-coverage.yml

@@ -0,0 +1,33 @@
+name: unit-test-coverage
+on:
+  push:
+    branches:
+      - main
+  workflow_dispatch:
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    steps:
+      - name: checkout
+        uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
+
+      - name: Set up Python 3.10
+        uses: actions/setup-python@v5
+        with:
+          python-version: "3.10"
+
+      - name: Install Dependencies
+        run: |
+          python -m pip install --upgrade pip
+          pip install ".[dev]"
+
+      - name: Test and Coverage
+        run: pytest -m "unit" --cov=labtasker --cov-report=term-missing --cov-report=xml
+
+      - name: Upload coverage reports to Codecov
+        uses: codecov/codecov-action@v5
+        with:
+          token: ${{ secrets.CODECOV_TOKEN }}

labtasker-0.1.0/.github/workflows/unit-test-matrix.yml

@@ -0,0 +1,33 @@
+name: unit-test-matrix
+on:
+  push:
+    branches:
+      - main
+      - dev
+  pull_request:
+  workflow_dispatch:
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        python-version: [ "3.8", "3.9", "3.10", "3.11", "3.12", "3.13" ]
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
+
+      - name: Set up Python ${{ matrix.python-version }}
+        uses: actions/setup-python@v5
+        with:
+          python-version: ${{ matrix.python-version }}
+
+      - name: Install Dependencies
+        run: |
+          python -m pip install --upgrade pip
+          pip install ".[dev]"
+
+      - name: Run Unit Tests
+        run: pytest -m "unit"

labtasker-0.1.0/.gitignore

@@ -0,0 +1,186 @@
+# Created by https://www.toptal.com/developers/gitignore/api/python
+# Edit at https://www.toptal.com/developers/gitignore?templates=python
+
+# Antlr intermediate files
+**/*.interp
+**/*.tokens
+
+tmp/
+
+.idea/
+
+### 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
+.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
+
+# End of https://www.toptal.com/developers/gitignore/api/python
+.DS_Store

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

@@ -0,0 +1,41 @@
+repos:
+-   repo: https://github.com/pre-commit/pre-commit-hooks
+    rev: v5.0.0
+    hooks:
+    -   id: trailing-whitespace
+    -   id: end-of-file-fixer
+    -   id: check-yaml
+    -   id: check-added-large-files
+        exclude: ^docs/docs/assets/
+    -   id: mixed-line-ending
+        args: [--fix=lf]
+
+-   repo: https://github.com/psf/black
+    rev: 24.8.0
+    hooks:
+    -   id: black
+
+-   repo: https://github.com/pycqa/isort
+    rev: 5.13.2
+    hooks:
+    -   id: isort
+
+# -   repo: https://github.com/pycqa/flake8
+#     rev: 6.0.0
+#     hooks:
+#     -   id: flake8
+#         additional_dependencies: [
+#             'flake8-docstrings',
+#             'flake8-bugbear',
+#             'flake8-comprehensions',
+#             'flake8-simplify',
+#         ]
+
+# -   repo: https://github.com/pre-commit/mirrors-mypy
+#     rev: v1.3.0
+#     hooks:
+#     -   id: mypy
+#         additional_dependencies:
+#             - types-requests
+#         args: [--ignore-missing-imports]
+#         exclude: ^tests/

labtasker-0.1.0/.pytest.ini

@@ -0,0 +1,9 @@
+[pytest]
+minversion = 6.0
+addopts = -ra -q -s -v --cov=labtasker
+testpaths = tests
+markers =
+    unit: marks tests as unit tests
+    integration: marks tests as integration tests
+    e2e: marks tests as end-to-end tests
+asyncio_default_fixture_loop_scope=function

labtasker-0.1.0/.python-version

@@ -0,0 +1,6 @@
+3.8
+3.9
+3.10
+3.11
+3.12
+3.13

labtasker-0.1.0/Dockerfile

@@ -0,0 +1,22 @@
+FROM python:3.13.1-slim-bullseye
+
+WORKDIR /app
+
+# Install system dependencies and clean up in one layer
+RUN apt-get update && apt-get install -y \
+    curl \
+    && rm -rf /var/lib/apt/lists/* \
+    && pip install --no-cache-dir pip --upgrade
+
+# Copy project files first
+COPY . .
+
+# Install Python dependencies
+RUN pip install --no-cache-dir "."
+
+# Health check
+HEALTHCHECK --interval=30s --timeout=10s --start-period=5s --retries=3 \
+    CMD curl -f http://localhost:${API_PORT:-8080}/health || exit 1
+
+# Run the application
+CMD ["python", "-m", "labtasker.server.run"]

labtasker-0.1.0/MANIFEST.in

@@ -0,0 +1,27 @@
+graft labtasker
+graft tests
+
+include tox.ini
+
+exclude build/*
+exclude dist/*
+exclude labtasker.egg-info/*
+
+exclude .venv/*
+exclude .tox/*
+exclude .benchmarks/*
+
+exclude Makefile
+exclude coverage.xml
+
+exclude poetry.lock
+exclude poetry.toml
+
+exclude .vscode/*
+exclude .github/*
+
+exclude plugins/*
+
+global-exclude *~ *.py[cod] *.so *.coverage
+
+prune __pycache__

labtasker-0.1.0/PKG-INFO

@@ -0,0 +1,89 @@
+Metadata-Version: 2.2
+Name: labtasker
+Version: 0.1.0
+Summary: A task queue system for lab experiments
+Author-email: Your Name <your.email@example.com>
+License: MIT
+Project-URL: Homepage, https://github.com/fkcptlst/labtasker
+Project-URL: Documentation, https://fkcptlst.github.io/labtasker
+Project-URL: Repository, https://github.com/fkcptlst/labtasker.git
+Classifier: Intended Audience :: Science/Research
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.8
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Requires-Python: <4.0,>=3.8.1
+Description-Content-Type: text/markdown
+Requires-Dist: python-dotenv<2.0.0,>=1.0.1
+Requires-Dist: pymongo<5.0.0,>=4.0.0
+Requires-Dist: fastapi<0.116.0,>=0.115.0
+Requires-Dist: uvicorn[standard]<0.35.0,>=0.15.0
+Requires-Dist: click<9.0.0,>=8.1.0
+Requires-Dist: passlib<2.0.0,>=1.7.0
+Requires-Dist: antlr4-python3-runtime<5.0.0,>=4.13.0
+Requires-Dist: pydantic-settings<3.0.0,>=2.8.0
+Requires-Dist: httpx[socks]<0.29.0,>=0.28.0
+Requires-Dist: typer<0.16.0,>=0.15.0
+Requires-Dist: loguru<0.8.0,>=0.7.0
+Requires-Dist: ruamel-yaml<0.19.0,>=0.18.10
+Requires-Dist: pyyaml<7.0.0,>=6.0.0
+Requires-Dist: tomlkit<0.14.0,>=0.13.2
+Requires-Dist: importlib-metadata<9.0.0,>=8.5.0
+Requires-Dist: packaging<25.0,>=24.2
+Provides-Extra: dev
+Requires-Dist: pytest<9.0.0,>=8.0.0; extra == "dev"
+Requires-Dist: pytest-cov<7.0.0,>=5.0.0; extra == "dev"
+Requires-Dist: mongomock<4.4.0,>=4.3.0; extra == "dev"
+Requires-Dist: black<26.0.0,>=24.0.0; extra == "dev"
+Requires-Dist: isort<7.0.0,>=5.13.0; extra == "dev"
+Requires-Dist: mypy<2.0.0,>=1.14.0; extra == "dev"
+Requires-Dist: flake8<8.0.0,>=7.0.0; extra == "dev"
+Requires-Dist: pre-commit<5.0.0,>=3.0.0; extra == "dev"
+Requires-Dist: freezegun<2.0.0,>=1.5.0; extra == "dev"
+Requires-Dist: pytest-docker<4.0.0,>=3.0.0; extra == "dev"
+Requires-Dist: pytest-benchmark<6.0.0,>=4.0.0; extra == "dev"
+Requires-Dist: pytest-asyncio<0.26.0,>=0.24.0; extra == "dev"
+Requires-Dist: asgi-lifespan<3.0.0,>=2.1.0; extra == "dev"
+Requires-Dist: tox<4.25.0,>=4.24.0; extra == "dev"
+Requires-Dist: pytest-dependency<0.7.0,>=0.6.0; extra == "dev"
+Provides-Extra: doc
+Requires-Dist: mkdocs-material<9.7.0,>=9.6.5; extra == "doc"
+Requires-Dist: mike<2.2.0,>=2.1.3; extra == "doc"
+
+# Labtasker
+
+![unit-test-matrix](https://github.com/fkcptlst/labtasker/actions/workflows/unit-test-matrix.yml/badge.svg)
+[![codecov](https://codecov.io/gh/fkcptlst/labtasker/graph/badge.svg?token=KQFBV3QRPY)](https://codecov.io/gh/fkcptlst/labtasker)
+![Python version](https://img.shields.io/badge/Python-3.8%20|%203.9%20|%203.10%20|%203.11%20|%203.12%20|%203.13-blue)
+
+A easy-to-use task management tool for lab experiments.
+
+## Features
+
+- Easy configuration and setup.
+- Versatile and minimalistic design.
+- Supports both CLI and Python API for task scheduling.
+- Customizable plugin system.
+
+## Installation
+
+To install client tools:
+
+```bash
+pip install labtasker
+```
+
+or
+
+```bash
+pip install git+https://github.com/fkcptlst/labtasker.git
+```
+
+## Documentation
+
+For extra information on demo, tutorial, deployment, usage, please refer to the [documentation](https://fkcptlst.github.io/labtasker/).

labtasker-0.1.0/PRIVACY.md

@@ -0,0 +1 @@
+# Privacy Policy

labtasker-0.1.0/README.md

@@ -0,0 +1,32 @@
+# Labtasker
+
+![unit-test-matrix](https://github.com/fkcptlst/labtasker/actions/workflows/unit-test-matrix.yml/badge.svg)
+[![codecov](https://codecov.io/gh/fkcptlst/labtasker/graph/badge.svg?token=KQFBV3QRPY)](https://codecov.io/gh/fkcptlst/labtasker)
+![Python version](https://img.shields.io/badge/Python-3.8%20|%203.9%20|%203.10%20|%203.11%20|%203.12%20|%203.13-blue)
+
+A easy-to-use task management tool for lab experiments.
+
+## Features
+
+- Easy configuration and setup.
+- Versatile and minimalistic design.
+- Supports both CLI and Python API for task scheduling.
+- Customizable plugin system.
+
+## Installation
+
+To install client tools:
+
+```bash
+pip install labtasker
+```
+
+or
+
+```bash
+pip install git+https://github.com/fkcptlst/labtasker.git
+```
+
+## Documentation
+
+For extra information on demo, tutorial, deployment, usage, please refer to the [documentation](https://fkcptlst.github.io/labtasker/).