crosszip 0.1.0__tar.gz

crosszip-0.1.0/.github/dependabot.yaml

@@ -0,0 +1,8 @@
+version: 2
+
+updates:
+  # Keep dependencies for GitHub Actions up-to-date
+  - package-ecosystem: "github-actions"
+    directory: "/"
+    schedule:
+      interval: "weekly"

crosszip-0.1.0/.github/workflows/ci.yml

@@ -0,0 +1,61 @@
+name: Package Checks
+
+on:
+  push:
+    branches: [main]
+  pull_request:
+    branches: [main]
+
+jobs:
+  qa:
+    name: QA
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Checkout Code
+        uses: actions/checkout@v4
+
+      - name: Set up Python
+        uses: actions/setup-python@v5
+        with:
+          python-version: 3.13
+
+      - name: Install Dependencies
+        run: |
+          python3 -m venv .venv
+          .venv/bin/pip install --upgrade pip
+          pip install uv
+          uv sync --frozen
+
+      - name: Run pre-commit hooks
+        run: .venv/bin/pre-commit run --all-files
+
+      - name: Compute Coverage
+        run: |
+          .venv/bin/coverage run -m pytest tests/ && .venv/bin/coverage report --fail-under=95 && .venv/bin/coverage html
+
+  test:
+    name: Run Tests
+    runs-on: ${{ matrix.os }}
+    strategy:
+      matrix:
+        os: [ubuntu-latest, macos-latest]
+        python-version: [3.12, 3.13]
+    steps:
+      - name: Checkout Code
+        uses: actions/checkout@v4
+
+      - name: Set up Python
+        uses: actions/setup-python@v5
+        with:
+          python-version: ${{ matrix.python-version }}
+
+      - name: Install Dependencies
+        run: |
+          python3 -m venv .venv
+          .venv/bin/pip install --upgrade pip
+          pip install uv
+          uv sync --frozen
+
+      - name: Run Tests
+        run: .venv/bin/pytest . -vv --random-order

crosszip-0.1.0/.github/workflows/docs.yml

@@ -0,0 +1,39 @@
+name: Docs
+
+on:
+  push:
+    branches: [main]
+  pull_request:
+    branches: [main]
+
+permissions:
+  contents: write
+
+jobs:
+  build-docs:
+    runs-on: ubuntu-latest
+    steps:
+      - 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
+
+      - uses: actions/setup-python@v5
+        with:
+          python-version: 3.13
+
+      - 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: pip install mkdocs-material
+
+      - name: Deploy
+        if: github.ref == 'refs/heads/main'
+        run: mkdocs gh-deploy --force

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

@@ -0,0 +1,25 @@
+name: Publish to PyPI
+on:
+  release:
+    types: [published]
+
+jobs:
+  pypi-publish:
+    name: Upload release to PyPI
+    runs-on: ubuntu-latest
+    permissions:
+      id-token: write
+    steps:
+      - uses: actions/checkout@v4
+      - name: Set up Python
+        uses: actions/setup-python@v5
+        with:
+          python-version: 3.13
+      - name: Install dependencies
+        run: |
+          python -m pip install --upgrade pip
+          pip install build
+      - name: Build package
+        run: python -m build
+      - name: Publish package
+        uses: pypa/gh-action-pypi-publish@release/v1

crosszip-0.1.0/.gitignore

@@ -0,0 +1,38 @@
+# Python-generated files
+__pycache__/
+*.py[oc]
+build/
+dist/
+wheels/
+*.egg-info
+
+# Virtual environments
+.venv
+.DS_Store
+
+# mkdocs documentation
+/site
+README.html
+README_files/
+
+# 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/
+repos/
+.Rproj.user
+.Rhistory

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

@@ -0,0 +1,21 @@
+default_stages: [pre-commit]
+default_language_version:
+  python: python3.13
+
+repos:
+  - repo: https://github.com/astral-sh/ruff-pre-commit
+    rev: v0.8.0
+    hooks:
+      - id: ruff
+        args: [--fix]
+      - id: ruff-format
+
+  - repo: https://github.com/pre-commit/mirrors-mypy
+    rev: v1.13.0
+    hooks:
+      - id: mypy
+
+  - repo: https://github.com/asottile/dead
+    rev: v1.5.2
+    hooks:
+      - id: dead

crosszip-0.1.0/.python-version

@@ -0,0 +1 @@
+3.13

crosszip-0.1.0/CODE_OF_CONDUCT.md

@@ -0,0 +1,126 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+We as members, contributors, and leaders pledge to make participation in our
+community a harassment-free experience for everyone, regardless of age, body
+size, visible or invisible disability, ethnicity, sex characteristics, gender
+identity and expression, level of experience, education, socio-economic status,
+nationality, personal appearance, race, caste, color, religion, or sexual
+identity and orientation.
+
+We pledge to act and interact in ways that contribute to an open, welcoming,
+diverse, inclusive, and healthy community.
+
+## Our Standards
+
+Examples of behavior that contributes to a positive environment for our
+community include:
+
+* Demonstrating empathy and kindness toward other people
+* Being respectful of differing opinions, viewpoints, and experiences
+* Giving and gracefully accepting constructive feedback
+* Accepting responsibility and apologizing to those affected by our mistakes,
+  and learning from the experience
+* Focusing on what is best not just for us as individuals, but for the overall
+  community
+
+Examples of unacceptable behavior include:
+
+* The use of sexualized language or imagery, and sexual attention or advances of
+  any kind
+* Trolling, insulting or derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or email address,
+  without their explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Enforcement Responsibilities
+
+Community leaders are responsible for clarifying and enforcing our standards of
+acceptable behavior and will take appropriate and fair corrective action in
+response to any behavior that they deem inappropriate, threatening, offensive,
+or harmful.
+
+Community leaders have the right and responsibility to remove, edit, or reject
+comments, commits, code, wiki edits, issues, and other contributions that are
+not aligned to this Code of Conduct, and will communicate reasons for moderation
+decisions when appropriate.
+
+## Scope
+
+This Code of Conduct applies within all community spaces, and also applies when
+an individual is officially representing the community in public spaces.
+Examples of representing our community include using an official e-mail address,
+posting via an official social media account, or acting as an appointed
+representative at an online or offline event.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported to the community leaders responsible for enforcement at codeofconduct@rstudio.com. 
+All complaints will be reviewed and investigated promptly and fairly.
+
+All community leaders are obligated to respect the privacy and security of the
+reporter of any incident.
+
+## Enforcement Guidelines
+
+Community leaders will follow these Community Impact Guidelines in determining
+the consequences for any action they deem in violation of this Code of Conduct:
+
+### 1. Correction
+
+**Community Impact**: Use of inappropriate language or other behavior deemed
+unprofessional or unwelcome in the community.
+
+**Consequence**: A private, written warning from community leaders, providing
+clarity around the nature of the violation and an explanation of why the
+behavior was inappropriate. A public apology may be requested.
+
+### 2. Warning
+
+**Community Impact**: A violation through a single incident or series of
+actions.
+
+**Consequence**: A warning with consequences for continued behavior. No
+interaction with the people involved, including unsolicited interaction with
+those enforcing the Code of Conduct, for a specified period of time. This
+includes avoiding interactions in community spaces as well as external channels
+like social media. Violating these terms may lead to a temporary or permanent
+ban.
+
+### 3. Temporary Ban
+
+**Community Impact**: A serious violation of community standards, including
+sustained inappropriate behavior.
+
+**Consequence**: A temporary ban from any sort of interaction or public
+communication with the community for a specified period of time. No public or
+private interaction with the people involved, including unsolicited interaction
+with those enforcing the Code of Conduct, is allowed during this period.
+Violating these terms may lead to a permanent ban.
+
+### 4. Permanent Ban
+
+**Community Impact**: Demonstrating a pattern of violation of community
+standards, including sustained inappropriate behavior, harassment of an
+individual, or aggression toward or disparagement of classes of individuals.
+
+**Consequence**: A permanent ban from any sort of public interaction within the
+community.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage],
+version 2.1, available at
+<https://www.contributor-covenant.org/version/2/1/code_of_conduct.html>.
+
+Community Impact Guidelines were inspired by
+[Mozilla's code of conduct enforcement ladder][https://github.com/mozilla/inclusion].
+
+For answers to common questions about this code of conduct, see the FAQ at
+<https://www.contributor-covenant.org/faq>. Translations are available at <https://www.contributor-covenant.org/translations>.
+
+[homepage]: https://www.contributor-covenant.org

crosszip-0.1.0/LICENSE.md

@@ -0,0 +1,21 @@
+# MIT License
+
+Copyright (c) 2024 crosszip authors
+
+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.

crosszip-0.1.0/Makefile

@@ -0,0 +1,78 @@
+.EXPORT_ALL_VARIABLES:
+SHELL=/bin/bash
+VIRTUAL_ENV ?= ${PWD}/.venv
+
+venv:
+	rm -rf $(VIRTUAL_ENV) && python3.13 -m venv $(VIRTUAL_ENV)
+	$(VIRTUAL_ENV)/bin/pip install --upgrade pip
+	pip install uv
+	uv sync --frozen
+
+activate:
+	. $(VIRTUAL_ENV)/bin/activate
+
+## Test package
+
+test: activate
+	$(VIRTUAL_ENV)/bin/pytest . -vv --random-order
+
+coverage: activate
+	$(VIRTUAL_ENV)/bin/coverage run -m pytest . && $(VIRTUAL_ENV)/bin/coverage report --fail-under=95 && $(VIRTUAL_ENV)/bin/coverage html;
+
+test-package: test coverage
+
+## Code quality
+
+format:
+	$(VIRTUAL_ENV)/bin/pre-commit run --hook-stage commit ruff-format --all-files
+
+lint:
+	$(VIRTUAL_ENV)/bin/pre-commit run --hook-stage commit ruff --all-files
+
+mypy:
+	$(VIRTUAL_ENV)/bin/pre-commit run --hook-stage commit mypy --all-files
+
+qa: format lint mypy
+
+## Check package
+
+build: activate
+	uv build
+
+check-package: test-package qa build
+
+
+help:
+	@echo "Usage: make [target]"
+	@echo ""
+	@echo "Targets:"
+	@echo "  venv           Create a virtual environment"
+	@echo "  activate       Activate the virtual environment"
+	@echo "  test           Run tests"
+	@echo "  coverage       Run tests and generate coverage report"
+	@echo "  test-package   Run tests, generate coverage report and check coverage"
+	@echo "  format         Format code"
+	@echo "  lint           Lint code"
+	@echo "  mypy           Type check code"
+	@echo "  qa             Run format, lint and mypy"
+	@echo "  build          Build package"
+	@echo "  check-package  Run tests, generate coverage report, check coverage, format, lint, mypy and build"
+	@echo "  help           Show this help message"
+	@echo ""
+	@echo "Variables:"
+	@echo "  VIRTUAL_ENV    Path to the virtual environment"
+	@echo ""
+	@echo "Examples:"
+	@echo "  make test"
+	@echo "  make coverage"
+	@echo "  make test-package"
+	@echo "  make format"
+	@echo "  make lint"
+	@echo "  make mypy"
+	@echo "  make qa"
+	@echo "  make build"
+	@echo "  make check-package"
+	@echo "  make help"
+	@echo ""
+	@echo "For more information, see the Makefile"
+	@echo ""

crosszip-0.1.0/PKG-INFO

@@ -0,0 +1,133 @@
+Metadata-Version: 2.3
+Name: crosszip
+Version: 0.1.0
+Summary: Apply a given function to all combinations of elements from multiple iterables
+Project-URL: Repository, https://github.com/IndrajeetPatil/crosszip
+Project-URL: Changelog, https://github.com/IndrajeetPatil/crosszip/blob/main/CHANGELOG.md
+Author-email: Indrajeet Patil <patilindrajeet.science@gmail.com>
+License: # MIT License
+        
+        Copyright (c) 2024 crosszip authors
+        
+        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.
+Keywords: iterables
+Classifier: Development Status :: 4 - Beta
+Classifier: Environment :: Console
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python
+Classifier: Programming Language :: Python :: 3 :: Only
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Topic :: Software Development :: Libraries :: Python Modules
+Requires-Python: >=3.12
+Description-Content-Type: text/markdown
+
+# crosszip <img src="docs/assets/logo.png" align="right" width="240" />
+
+[![PyPI Version](https://img.shields.io/pypi/v/crosszip.svg)](https://pypi.org/project/crosszip/)
+[![License: MIT](https://img.shields.io/badge/license-MIT-blue.svg)](https://opensource.org/licenses/MIT)
+
+`crosszip` is a Python utility that makes it easy to apply a function to all possible combinations of elements from multiple iterables.
+It combines the power of the Cartesian product and functional programming into a single, intuitive tool.
+
+Additionally, `crosszip_parametrize` Pytest plugin is a decorator that simplifies running tests with all possible combinations of parameter values.
+This is particularly useful for testing functions or components across multiple dimensions of input parameters.
+
+---
+
+## Installation
+
+Install `crosszip` via pip:
+
+```bash
+pip install crosszip
+```
+
+Registering the crosszip marker for pytest is simple. Just add the following to your `pytest.ini` file:
+
+```
+[pytest]
+markers =
+    crosszip_parametrize: "mark test function for crosszip parametrization"
+```
+
+---
+
+## Key Features
+
+- **Flexible Input**: Works with any iterables, including lists, tuples, sets, and generators.
+- **pytest Plugin**: Supports parametrization of tests using `crosszip`.
+- **Simple API**: Minimalist, intuitive design for quick integration into your projects.
+
+---
+
+## Usage
+
+Example of using `crosszip`:
+
+```python
+# Label Generation for Machine Learning
+
+from crosszip import crosszip
+
+def create_label(category, subcategory, version):
+    return f"{category}_{subcategory}_v{version}"
+
+categories = ["cat", "dog"]
+subcategories = ["small", "large"]
+versions = ["1.0", "2.0"]
+
+labels = crosszip(create_label, categories, subcategories, versions)
+print(labels)
+# Output: ['cat_small_v1.0', 'cat_small_v2.0', 'cat_large_v1.0', 'cat_large_v2.0', 'dog_small_v1.0', 'dog_small_v2.0', 'dog_large_v1.0', 'dog_large_v2.0']
+```
+
+Example of using `pytest` marker `crosszip_parametrize`:
+
+```python
+# Testing Power Function
+
+import math
+from crosszip_parametrize import crosszip_parametrize
+
+@crosszip_parametrize(
+    "base", [2, 10],
+    "exponent", [-1, 0, 1],
+)
+def test_power_function(base, exponent):
+    result = math.pow(base, exponent)
+    assert result == base ** exponent
+```
+
+For more examples, check out the package documentation at:
+https://indrajeetpatil.github.io/crosszip/
+
+---
+
+## License
+
+This project is licensed under the [MIT License](LICENSE.md).
+
+---
+
+## Acknowledgements
+
+Hex sticker font is `Rubik`, and the image is taken from icon made by Freepik and available at flaticon.com.

crosszip-0.1.0/README.md

@@ -0,0 +1,91 @@
+# crosszip <img src="docs/assets/logo.png" align="right" width="240" />
+
+[![PyPI Version](https://img.shields.io/pypi/v/crosszip.svg)](https://pypi.org/project/crosszip/)
+[![License: MIT](https://img.shields.io/badge/license-MIT-blue.svg)](https://opensource.org/licenses/MIT)
+
+`crosszip` is a Python utility that makes it easy to apply a function to all possible combinations of elements from multiple iterables.
+It combines the power of the Cartesian product and functional programming into a single, intuitive tool.
+
+Additionally, `crosszip_parametrize` Pytest plugin is a decorator that simplifies running tests with all possible combinations of parameter values.
+This is particularly useful for testing functions or components across multiple dimensions of input parameters.
+
+---
+
+## Installation
+
+Install `crosszip` via pip:
+
+```bash
+pip install crosszip
+```
+
+Registering the crosszip marker for pytest is simple. Just add the following to your `pytest.ini` file:
+
+```
+[pytest]
+markers =
+    crosszip_parametrize: "mark test function for crosszip parametrization"
+```
+
+---
+
+## Key Features
+
+- **Flexible Input**: Works with any iterables, including lists, tuples, sets, and generators.
+- **pytest Plugin**: Supports parametrization of tests using `crosszip`.
+- **Simple API**: Minimalist, intuitive design for quick integration into your projects.
+
+---
+
+## Usage
+
+Example of using `crosszip`:
+
+```python
+# Label Generation for Machine Learning
+
+from crosszip import crosszip
+
+def create_label(category, subcategory, version):
+    return f"{category}_{subcategory}_v{version}"
+
+categories = ["cat", "dog"]
+subcategories = ["small", "large"]
+versions = ["1.0", "2.0"]
+
+labels = crosszip(create_label, categories, subcategories, versions)
+print(labels)
+# Output: ['cat_small_v1.0', 'cat_small_v2.0', 'cat_large_v1.0', 'cat_large_v2.0', 'dog_small_v1.0', 'dog_small_v2.0', 'dog_large_v1.0', 'dog_large_v2.0']
+```
+
+Example of using `pytest` marker `crosszip_parametrize`:
+
+```python
+# Testing Power Function
+
+import math
+from crosszip_parametrize import crosszip_parametrize
+
+@crosszip_parametrize(
+    "base", [2, 10],
+    "exponent", [-1, 0, 1],
+)
+def test_power_function(base, exponent):
+    result = math.pow(base, exponent)
+    assert result == base ** exponent
+```
+
+For more examples, check out the package documentation at:
+https://indrajeetpatil.github.io/crosszip/
+
+---
+
+## License
+
+This project is licensed under the [MIT License](LICENSE.md).
+
+---
+
+## Acknowledgements
+
+Hex sticker font is `Rubik`, and the image is taken from icon made by Freepik and available at flaticon.com.

crosszip-0.1.0/crosszip.Rproj

@@ -0,0 +1,18 @@
+Version: 1.0
+
+RestoreWorkspace: Default
+SaveWorkspace: Default
+AlwaysSaveHistory: Default
+
+EnableCodeIndexing: Yes
+UseSpacesForTab: Yes
+NumSpacesForTab: 2
+Encoding: UTF-8
+
+RnwWeave: knitr
+LaTeX: pdfLaTeX
+
+AutoAppendNewline: Yes
+StripTrailingWhitespace: Yes
+
+BuildType: Makefile

crosszip-0.1.0/crosszip.code-workspace

@@ -0,0 +1,8 @@
+{
+	"folders": [
+		{
+			"path": "."
+		}
+	],
+	"settings": {}
+}