Skip to main content

A lightweight Python package providing essential clustering utilities for clustering workflows.

Project description

clustools


Documentation Status License - BSD-3-Clause
PyPI - Version PyPI - Downloads PyPI - Python Version
CI - Tests CD - Publish GitHub stars GitHub forks GitHub issues
Linting - Ruff Formatter - Ruff Types - Mypy

GitHub · PyPI · Docs · Issues

A lightweight Python package providing essential clustering utilities for clustering workflows.



A lightweight Python package that extends scikit-learn's clustering ecosystem with additional algorithms and utilities. Features sklearn-compatible wrappers for Fuzzy C-Means, Faiss-based clustering, and supplementary functions for comprehensive clustering workflows.

Features

TODO

Installation

From PyPI

pip install clustools

or

uv add clustools

From Source

git clone https://github.com/psolsfer/clustools.git
cd clustools
uv sync

Usage

Python API

import clustools

# TODO: Add usage examples

Development

Setup

git clone https://github.com/psolsfer/clustools.git
cd clustools
uv sync

Install the prek git hook

uv run prek install

Running Tests

uv run pytest

Code Quality

uv run ruff check .
uv run ruff format .
uv run mypy src/clustools

Contributing

Contributions are welcome! Please feel free to submit a Pull Request.

Credits

This package was created with Copier and the Copier PyPackage uv project template.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

clustools-0.3.0.tar.gz (15.6 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

clustools-0.3.0-py3-none-any.whl (21.9 kB view details)

Uploaded Python 3

File details

Details for the file clustools-0.3.0.tar.gz.

File metadata

  • Download URL: clustools-0.3.0.tar.gz
  • Upload date:
  • Size: 15.6 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for clustools-0.3.0.tar.gz
Algorithm Hash digest
SHA256 f1c8e3675f903c2c0aa64073c0e7ee39beac276e163251ce7b3cf2ca411cbb77
MD5 c0bd278adb70586c9d3427b98cd6f7a2
BLAKE2b-256 228c9386c6156e28465bbeaa5487101206b2e37dcbd1bd14970574873a3366b3

See more details on using hashes here.

Provenance

The following attestation bundles were made for clustools-0.3.0.tar.gz:

Publisher: python-publish.yml on psolsfer/clustools

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file clustools-0.3.0-py3-none-any.whl.

File metadata

  • Download URL: clustools-0.3.0-py3-none-any.whl
  • Upload date:
  • Size: 21.9 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for clustools-0.3.0-py3-none-any.whl
Algorithm Hash digest
SHA256 b6eea7ec672a0d70497c29714e2d85609a47a108b9f235564f6fb1ff6c59e596
MD5 0f31e0c8ac67c4bc283ac22361493215
BLAKE2b-256 aecfcf752004af7b5d8ceb8d4c4703400316cc95d0caa99cab7809eb47fc7113

See more details on using hashes here.

Provenance

The following attestation bundles were made for clustools-0.3.0-py3-none-any.whl:

Publisher: python-publish.yml on psolsfer/clustools

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page