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.1.tar.gz (16.4 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.1-py3-none-any.whl (23.4 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: clustools-0.3.1.tar.gz
  • Upload date:
  • Size: 16.4 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.1.tar.gz
Algorithm Hash digest
SHA256 3a070bd1f33ffb1643c5dc52a311fdcfe3a4b15c3bd103da2ca004caae244724
MD5 7bbfe4dead873d2d32d819d738292749
BLAKE2b-256 f455de522f7ac689f53b1059f91581919475e14069d710e000cce09b3887a40f

See more details on using hashes here.

Provenance

The following attestation bundles were made for clustools-0.3.1.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.1-py3-none-any.whl.

File metadata

  • Download URL: clustools-0.3.1-py3-none-any.whl
  • Upload date:
  • Size: 23.4 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.1-py3-none-any.whl
Algorithm Hash digest
SHA256 9a457f24a820ad107a18a73a90f403e7c1d7d1723c29da10b62749ac0c285f7b
MD5 b729abfa99bd8280650f57cb99267c72
BLAKE2b-256 fc3206ccbc66cff1c07339976181004f988cbe99af960459077e3bd63c67a05f

See more details on using hashes here.

Provenance

The following attestation bundles were made for clustools-0.3.1-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