Skip to main content

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

Project description

clustools


Docs Documentation Status
Package PyPI - Version PyPI - Downloads PyPI - Python Version
CI/CD CI - Test CD - Build
GitHub clustools Forks Stars Issues
Code style linting - Ruff code style - Ruff formatter types - Mypy
License License - BSD-3-Clause-Clear

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
uv run pre-commit 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.1.0.tar.gz (14.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.1.0-py3-none-any.whl (3.6 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: clustools-0.1.0.tar.gz
  • Upload date:
  • Size: 14.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.1.0.tar.gz
Algorithm Hash digest
SHA256 7267e176757d5bccb156afedc5509b80812532fca55649dbdd49c2000ef4c99f
MD5 840f5c37708db9a6d1cb1bf22116db11
BLAKE2b-256 63b140c2def75d258cc243f359d8319c0e9a018bdb60e0d8abd8ffa0e3a5bc4f

See more details on using hashes here.

Provenance

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

File metadata

  • Download URL: clustools-0.1.0-py3-none-any.whl
  • Upload date:
  • Size: 3.6 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.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 92cfefa836bcd285d811e5d306d3168b6a49ddffdffb8b62da2e221dc450f7fa
MD5 8cf830d8a02dc7c1538329aa051eff0e
BLAKE2b-256 c99ace14951a202df139bf6a2e2e839ace464f80431d392fc2d240f615a8565a

See more details on using hashes here.

Provenance

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