Skip to main content

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

Project description

<style> p[align="center"] { margin: 0px 0; /* adjust as needed */ } </style>

clustools

Documentation Status PyPI - Version PyPI - Downloads PyPI - Python Version

CI - Test CD - Build GitHub stars GitHub forks GitHub issues

License - BSD-3-Clause Linting - Ruff Ruff formatter Types - Mypy

GitHub · PyPI · Docs · Issues

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

Uploaded Python 3

File details

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

File metadata

  • Download URL: clustools-0.1.1.tar.gz
  • Upload date:
  • Size: 14.8 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.1.tar.gz
Algorithm Hash digest
SHA256 20f827d9595b45ddedcc1b74c0fd295dfcb593df638a352ccadfd7a97cf18876
MD5 5ec64a07141d1360e728484b1784aaf9
BLAKE2b-256 77deeee3a35c0b167ad3ec7bf2b9dd35de38ae8ce3bbfbd87ff091d52c5668c6

See more details on using hashes here.

Provenance

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

File metadata

  • Download URL: clustools-0.1.1-py3-none-any.whl
  • Upload date:
  • Size: 3.7 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.1-py3-none-any.whl
Algorithm Hash digest
SHA256 e3753000220df11b9a455b2128c9c8bd334a9890b9f7fbfb4ebce7605a125378
MD5 f735f8437dc61dd61a32204a879f162b
BLAKE2b-256 60fba1ec73c1e64546af0d4f50ad0768a545d08af9d8d1da2b64e023c840faf0

See more details on using hashes here.

Provenance

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