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.2.1.tar.gz (14.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.2.1-py3-none-any.whl (19.5 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: clustools-0.2.1.tar.gz
  • Upload date:
  • Size: 14.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.2.1.tar.gz
Algorithm Hash digest
SHA256 7049d37dd940c809391184660f54173ca91591ffa0f283814fc48d361a40f700
MD5 820f46653661ce3a378b16521b3e530b
BLAKE2b-256 34413882c509292f7bc38c9198fe54d1085d9c04062b4cc6366da2e29da5aa13

See more details on using hashes here.

Provenance

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

File metadata

  • Download URL: clustools-0.2.1-py3-none-any.whl
  • Upload date:
  • Size: 19.5 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.2.1-py3-none-any.whl
Algorithm Hash digest
SHA256 54eda0a93a1581fe09d92bbfc6437c633556583eca6fe08b11919f29685e289f
MD5 242fcbdf97a422df8b26c61a51517ada
BLAKE2b-256 ed360ed58e11f5c645926c578b4a730ff0e00baa7ac150aa280f15a6e5343f53

See more details on using hashes here.

Provenance

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