webloom 1.0.2__tar.gz

webloom-1.0.2/.github/workflows/code_style.yml

@@ -0,0 +1,36 @@
+name: Lint and Format
+
+on:
+  push:
+    branches: [ main ]
+
+  pull_request:
+    branches: [ main ]
+    paths: [ '**/*.py' ]
+
+  workflow_dispatch:
+
+concurrency:
+  group: ${{ github.workflow }}/${{ github.ref }}
+  cancel-in-progress: true
+
+jobs:
+  python-format:
+    name: Ruff Lint and Format
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Checkout Repository
+        uses: actions/checkout@v6
+
+      - name: Setup Ruff
+        uses: astral-sh/ruff-action@v3
+        with:
+          args: --version
+
+      - name: Enforce Lint
+        run: ruff check .
+
+      - name: Enforce Format
+        run: |
+          ruff format --diff .

webloom-1.0.2/.github/workflows/code_test.yml

@@ -0,0 +1,96 @@
+name: Code Test
+
+on:
+  push:
+    branches: [ main ]
+
+  pull_request:
+    branches: [ main ]
+
+  workflow_dispatch:
+  workflow_call:
+    outputs:
+      artifact_name:
+        value: ${{ jobs.fresh_build.outputs.artifact_name }}
+      artifact_run_id:
+        value: ${{ jobs.fresh_build.outputs.run_id }}
+
+concurrency:
+  group: ${{ github.workflow }}-${{ github.ref }}
+  cancel-in-progress: true
+
+jobs:
+
+  setup:
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Fetch Supported Python
+        id: fetch-versions
+        run: |
+          versions=$(curl -fsSL https://endoflife.date/api/v1/products/python/ \
+                     | jq '[ .result.releases[] | select(.isEol == false) | .label ]')
+
+          echo "supported_versions=$(echo $versions |jq -c '.')"        >> $GITHUB_OUTPUT
+          echo "bound_versions=$(echo $versions |jq -c '[.[0],.[-1]]')" >> $GITHUB_OUTPUT
+
+    outputs:
+      supported_versions: ${{ steps.fetch-versions.outputs.supported_versions }}
+      bound_versions: ${{ steps.fetch-versions.outputs.bound_versions }}
+
+  fresh_build:
+    uses: ./.github/workflows/dist_build.yml
+
+  testing:
+    runs-on: ${{ matrix.os }}
+
+    permissions:
+      id-token: write  # for working of oidc of codecov
+
+    strategy:
+      matrix:
+        os: [ ubuntu-latest ]
+        py-version: ${{ fromJson(needs.setup.outputs.supported_versions) }}
+        include:
+          - os: windows-latest
+            py-version: ${{ fromJson(needs.setup.outputs.bound_versions)[0] }}
+          - os: windows-latest
+            py-version: ${{ fromJson(needs.setup.outputs.bound_versions)[1] }}
+          - os: macos-latest
+            py-version: ${{ fromJson(needs.setup.outputs.bound_versions)[0] }}
+          - os: macos-latest
+            py-version: ${{ fromJson(needs.setup.outputs.bound_versions)[1] }}
+
+    needs:
+      - fresh_build
+      - setup
+
+    steps:
+      - uses: actions/checkout@v6
+
+      - name: Download Build Artifacts
+        uses: actions/download-artifact@v7
+        with:
+          name: ${{ needs.fresh_build.outputs.artifact_name }}
+          run-id: ${{ needs.fresh_build.outputs.run_id }}
+          path: ./dist
+
+      - uses: astral-sh/setup-uv@v7
+        with:
+          python-version: ${{ matrix.py-version }}
+
+      - name: Install Packages
+        shell: bash
+        run: |
+          uv sync --no-dev --group test
+          uv pip install -v ./dist/*.whl
+
+      - name: Run Tests
+        run: uv run --no-sync pytest -v -n auto --cov --cov-report=xml
+
+      - name: Upload coverage to Codecov
+        uses: codecov/codecov-action@v5
+        with:
+          fail_ci_if_error: true
+          use_oidc: true
+          verbose: true

webloom-1.0.2/.github/workflows/dist_build.yml

@@ -0,0 +1,40 @@
+name: Build Distribution
+
+on:
+  workflow_call:
+    outputs:
+      artifact_name:
+        value: ${{ jobs.build.outputs.artifact_name }}
+      run_id:
+        value: ${{ github.run_id }}
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/checkout@v6
+        with:
+          fetch-depth: 0
+
+      - name: Setup uv
+        uses: astral-sh/setup-uv@v7
+
+      - name: Build distribution
+        run: uv build -v --clear .
+
+      - name: Set Artifact Name
+        id: artifact-name
+        run: |
+          echo "artifact_name=${{ github.run_id }}[${{ github.run_attempt }}]--build-artifacts" \
+          | tee -a $GITHUB_OUTPUT
+
+      - name: Upload Build Artifacts
+        uses: actions/upload-artifact@v6
+        with:
+          name: ${{ steps.artifact-name.outputs.artifact_name }}
+          path: dist
+          if-no-files-found: error
+
+    outputs:
+      artifact_name: ${{ steps.artifact-name.outputs.artifact_name }}

webloom-1.0.2/.github/workflows/docs_build.yml

@@ -0,0 +1,52 @@
+name: Build Documentation
+permissions:
+  pages: write
+  id-token: write
+
+on:
+  pull_request:
+    branches: [ main ]
+  workflow_call:
+    inputs: &build-docs-inputs
+      deploy:
+        type: boolean
+        required: false
+        default: false
+
+  workflow_dispatch:
+    inputs: *build-docs-inputs
+
+concurrency:
+  group: docs-build
+
+jobs:
+
+  build:
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/checkout@v6
+
+      - name: Setup uv
+        uses: astral-sh/setup-uv@v7
+
+      - name: Build Documentation
+        run: uv run --no-dev --group docs mkdocs build --clean --strict
+
+      - name: Set Artifact Name
+        id: artifact-name
+        run: |
+          echo "artifact_name=${{ github.run_id }}[${{ github.run_attempt }}]--build-artifacts" \
+          | tee -a $GITHUB_OUTPUT
+
+      - name: Upload Pages Artifacts
+        uses: actions/upload-pages-artifact@v4
+        with:
+          name: ${{ steps.artifact-name.outputs.artifact_name }}
+          path: build/docs
+
+      - name: Deploy to GitHub Pages
+        if: ${{ inputs.deploy }}
+        uses: actions/deploy-pages@v4
+        with:
+          artifact_name: ${{ steps.artifact-name.outputs.artifact_name }}

webloom-1.0.2/.github/workflows/publish_dist.yml

@@ -0,0 +1,82 @@
+name: Publish to PyPI
+
+on:
+  push:
+    tags: [ 'v*.*.*' ]
+
+permissions:
+  id-token: write
+
+concurrency:
+  group: ${{ github.workflow }}
+
+jobs:
+  testing:
+    uses: ./.github/workflows/code_test.yml
+
+  publish-test-pypi:
+    runs-on: ubuntu-latest
+
+    environment:
+      name: test-pypi
+      url: https://test.pypi.org/p/webloom
+
+    needs: testing
+
+    steps:
+
+      - &download_dist
+        name: Download Distributions
+        uses: actions/download-artifact@v7
+        with:
+          name: ${{ needs.testing.outputs.artifact_name }}
+          run-id: ${{ needs.testing.outputs.artifact_run_id }}
+          path: ./dist
+
+      - name: Publish to Test PyPI
+        uses: pypa/gh-action-pypi-publish@release/v1
+        with:
+          repository-url: https://test.pypi.org/legacy/
+          verbose: true
+
+      - name: Smoke Test on Test PyPI
+        run: |
+          pip install -v --index-url https://test.pypi.org/simple/ \
+          --extra-index-url https://pypi.org/simple/ webloom
+          python -c "import webloom;print(webloom.__version__)"
+
+  publish-to-pypi:
+    runs-on: ubuntu-latest
+
+    permissions:
+      id-token: write
+
+    environment:
+      name: pypi
+      url: https://pypi.org/p/webloom
+
+    needs: testing
+
+    steps:
+
+      - *download_dist
+      - name: Publish to PyPI
+        uses: pypa/gh-action-pypi-publish@release/v1
+        with:
+          verbose: true
+
+      - name: Smoke Test on PyPI
+        run: |
+          pip install -v --index-url https://pypi.org/simple/ webloom
+          python -c "import webloom;print(webloom.__version__)"
+
+  publish_docs:
+    needs: publish-to-pypi
+
+    permissions:
+      pages: write
+      id-token: write
+
+    uses: ./.github/workflows/docs_build.yml
+    with:
+      deploy: true

webloom-1.0.2/.gitignore

@@ -0,0 +1,16 @@
+# Python-generated files
+__pycache__/
+*.py[oc]
+build/
+dist/
+wheels/
+*.egg-info
+
+# Virtual environments
+.venv
+
+# tests and coverage
+.coverage
+.coverage.*
+htmlcov/
+coverage.xml

webloom-1.0.2/.python-version

@@ -0,0 +1 @@
+3.12

webloom-1.0.2/PKG-INFO

@@ -0,0 +1,14 @@
+Metadata-Version: 2.4
+Name: webloom
+Version: 1.0.2
+Author-email: M Laraib Ali <laraibg786@outlook.com>
+Requires-Python: >=3.9
+Requires-Dist: numpy>=2.0.2
+Requires-Dist: scipy>=1.13.1
+Description-Content-Type: text/markdown
+
+This is dummy project created for sole purpose of testing. If you require this
+project for some real use case, please contact the author. I will be happy to
+take down the project or give you the ownership whatever suits you best.
+
+Thanks!

webloom-1.0.2/README.md

@@ -0,0 +1,5 @@
+This is dummy project created for sole purpose of testing. If you require this
+project for some real use case, please contact the author. I will be happy to
+take down the project or give you the ownership whatever suits you best.
+
+Thanks!

webloom-1.0.2/docs/about.md

@@ -0,0 +1,13 @@
+# About Webloom
+
+This is a dummy project to test the github actions.
+
+## Project Structure
+
+- `src/webloom/`: Main package code
+- `docs/`: Documentation files
+- `pyproject.toml`: Project configuration
+
+## Contributing
+
+Contributions are welcome! Please see the main repository for guidelines.

webloom-1.0.2/docs/index.md

@@ -0,0 +1,21 @@
+# Welcome to Webloom
+
+Webloom is a powerful tool for [describe what it does here].
+
+## Features
+
+- Feature 1: Description
+- Feature 2: Description
+- Feature 3: Description
+
+## Getting Started
+
+To get started with Webloom, follow these steps:
+
+1. Install the package: `pip install webloom`
+2. Import in your code: `import webloom`
+3. Use it!
+
+## Documentation
+
+For more detailed information, check out the [About](about.md) page.

webloom-1.0.2/mkdocs.yml

@@ -0,0 +1,17 @@
+site_name: Webloom Documentation
+site_description: Documentation for the Webloom project
+site_author: M Laraib Ali
+site_dir: build/docs
+
+theme:
+  name: material
+  palette:
+    primary: blue
+    accent: blue
+
+nav:
+  - Home: index.md
+  - About: about.md
+
+plugins:
+  - search

webloom-1.0.2/pyproject.toml

@@ -0,0 +1,76 @@
+[project]
+name = "webloom"
+dynamic = ["version"]
+readme = "README.md"
+authors = [
+    { name = "M Laraib Ali", email = "laraibg786@outlook.com" }
+]
+requires-python = ">=3.9"
+dependencies = [
+    "numpy>=2.0.2",
+    "scipy>=1.13.1",
+]
+
+[project.scripts]
+webloom = "webloom:main"
+
+[build-system]
+requires = ["hatchling>=1.26", "hatch-vcs"]
+build-backend = "hatchling.build"
+
+[tool.hatch.version]
+source = "vcs"
+
+[tool.ruff]
+line-length = 80
+indent-width = 4
+preview = true
+output-format = "grouped"
+
+select = [
+    "ANN", # flake8-annotations (required strict type annotations for public functions)
+    "S",   # flake8-bandit (checks basic security issues in code)
+    "BLE", # flake8-blind-except (checks the except blocks that do not specify exception)
+    "FBT", # flake8-boolean-trap (ensure that boolean args can be used with kw only)
+    "E",   # pycodestyle errors (PEP 8 style guide violations)
+    "W",   # pycodestyle warnings (e.g., extra spaces, indentation issues)
+    "DOC", # pydoclint issues (e.g., extra or missing return, yield, warnings)
+    "A",   # flake8-buitins (check variable and function names to not shadow builtins)
+    "N",   # Naming convention checks (e.g., PEP 8 variable and function names)
+    "F",   # Pyflakes errors (e.g., unused imports, undefined variables)
+    "I",   # isort (Ensures imports are sorted properly)
+    "B",   # flake8-bugbear (Detects likely bugs and bad practices)
+    "TID", # flake8-tidy-imports (Checks for banned or misplaced imports)
+    "UP",  # pyupgrade (Automatically updates old Python syntax)
+    "YTT", # flake8-2020 (Detects outdated Python 2/3 compatibility issues)
+    "FLY", # flynt (Converts old-style string formatting to f-strings)
+    "PIE", # flake8-pie
+    "PL",  # pylint
+    "RUF", # Ruff-specific rules (Additional optimizations and best practices)
+]
+
+[tool.ruff.format]
+docstring-code-format = true
+skip-magic-trailing-comma = true
+
+[tool.pytest.ini_options]
+addopts = "--doctest-modules"
+
+[dependency-groups]
+dev = [
+  {include-group = "docs"},
+  {include-group = "lint"},
+  {include-group = "test"}
+]
+docs = [
+    "mkdocs>=1.6.1",
+    "mkdocs-material>=9.7.1",
+]
+lint = [
+    "ruff>=0.15.0",
+]
+test = [
+    "pytest>=8.4.2",
+    "pytest-cov>=7.0.0",
+    "pytest-xdist>=3.8.0",
+]

webloom-1.0.2/src/webloom/__init__.py

@@ -0,0 +1,14 @@
+from importlib.metadata import PackageNotFoundError, version
+
+from webloom.utils import add_numbers, multiply_numbers, is_even, fibonacci
+
+try:  # noqa: RUF067
+    __version__ = version(__name__)
+except PackageNotFoundError:
+    __version__ = "unknown"
+
+def main() -> None:
+    print("Hello from webloom!")
+    print(__version__)
+
+__all__ = ["add_numbers", "multiply_numbers", "is_even", "fibonacci", "main", "__version__"]

webloom-1.0.2/src/webloom/utils.py

@@ -0,0 +1,94 @@
+"""Utility functions for Webloom."""
+
+
+def add_numbers(a: int, b: int) -> int:
+    """
+    Add two numbers together.
+
+    Args:
+        a: First number
+        b: Second number
+
+    Returns:
+        The sum of a and b
+
+    Examples:
+        >>> add_numbers(1, 2)
+        3
+        >>> add_numbers(-1, 1)
+        0
+    """
+    return a + b
+
+
+def multiply_numbers(a: int, b: int) -> int:
+    """
+    Multiply two numbers.
+
+    Args:
+        a: First number
+        b: Second number
+
+    Returns:
+        The product of a and b
+
+    Examples:
+        >>> multiply_numbers(2, 3)
+        6
+        >>> multiply_numbers(0, 5)
+        0
+    """
+    return a * b
+
+
+def is_even(n: int) -> bool:
+    """
+    Check if a number is even.
+
+    Args:
+        n: The number to check
+
+    Returns:
+        True if n is even, False otherwise
+
+    Examples:
+        >>> is_even(2)
+        True
+        >>> is_even(3)
+        False
+        >>> is_even(0)
+        True
+    """
+    return n % 2 == 0
+
+
+def fibonacci(n: int) -> int:
+    """
+    Calculate the nth Fibonacci number.
+
+    Args:
+        n: The position in the Fibonacci sequence (0-based)
+
+    Returns:
+        The nth Fibonacci number
+
+    Examples:
+        >>> fibonacci(0)
+        0
+        >>> fibonacci(1)
+        1
+        >>> fibonacci(5)
+        5
+        >>> fibonacci(10)
+        55
+    """
+    if n < 0:
+        raise ValueError("n must be non-negative")
+    if n == 0:
+        return 0
+    if n == 1:
+        return 1
+    a, b = 0, 1
+    for _ in range(2, n + 1):
+        a, b = b, a + b
+    return b

webloom-1.0.2/tests/test_utils.py

@@ -0,0 +1,91 @@
+"""Tests for webloom.utils module."""
+
+import pytest
+
+from webloom.utils import add_numbers, multiply_numbers, is_even, fibonacci
+
+
+class TestAddNumbers:
+    """Test cases for add_numbers function."""
+
+    def test_positive_numbers(self):
+        """Test adding positive numbers."""
+        assert add_numbers(1, 2) == 3
+        assert add_numbers(10, 20) == 30
+
+    def test_negative_numbers(self):
+        """Test adding negative numbers."""
+        assert add_numbers(-1, -2) == -3
+        assert add_numbers(-5, 5) == 0
+
+    def test_zero(self):
+        """Test adding with zero."""
+        assert add_numbers(0, 5) == 5
+        assert add_numbers(5, 0) == 5
+
+
+class TestMultiplyNumbers:
+    """Test cases for multiply_numbers function."""
+
+    def test_basic_multiplication(self):
+        """Test basic multiplication."""
+        assert multiply_numbers(2, 3) == 6
+        assert multiply_numbers(5, 4) == 20
+
+    def test_with_zero(self):
+        """Test multiplication with zero."""
+        assert multiply_numbers(0, 5) == 0
+        assert multiply_numbers(5, 0) == 0
+
+    def test_negative_numbers(self):
+        """Test multiplication with negative numbers."""
+        assert multiply_numbers(-2, 3) == -6
+        assert multiply_numbers(-2, -3) == 6
+
+
+class TestIsEven:
+    """Test cases for is_even function."""
+
+    def test_even_numbers(self):
+        """Test even numbers."""
+        assert is_even(0) is True
+        assert is_even(2) is True
+        assert is_even(100) is True
+
+    def test_odd_numbers(self):
+        """Test odd numbers."""
+        assert is_even(1) is False
+        assert is_even(3) is False
+        assert is_even(99) is False
+
+    def test_negative_even(self):
+        """Test negative even numbers."""
+        assert is_even(-2) is True
+        assert is_even(-4) is True
+
+
+class TestFibonacci:
+    """Test cases for fibonacci function."""
+
+    def test_base_cases(self):
+        """Test base cases."""
+        assert fibonacci(0) == 0
+        assert fibonacci(1) == 1
+
+    def test_small_values(self):
+        """Test small Fibonacci numbers."""
+        assert fibonacci(2) == 1
+        assert fibonacci(3) == 2
+        assert fibonacci(4) == 3
+        assert fibonacci(5) == 5
+        assert fibonacci(6) == 8
+
+    def test_larger_value(self):
+        """Test a larger Fibonacci number."""
+        assert fibonacci(10) == 55
+        assert fibonacci(15) == 610
+
+    def test_negative_raises_error(self):
+        """Test that negative n raises ValueError."""
+        with pytest.raises(ValueError, match="n must be non-negative"):
+            fibonacci(-1)