Skip to main content

XspecT

Test linting: pylint Code style: black

XspecT is a Python-based tool to taxonomically classify sequence-reads (or assembled genomes) on the species and/or MLST level using kmer indices and a Support Vector Machine.

XspecT utilizes the uniqueness of kmers and compares extracted kmers from the input-data to a kmer index. Probablistic data structures ensure a fast lookup in this process. For a final prediction, the results are classified using a Support Vector Machine.

The tool is available as a web-based application and as a command line interface.

Installation

To install XspecT, please download the lastest 64 bit Python version and install the package using pip:

pip install xspect

Please note that Windows and Alpine Linux are currently not supported.

Usage

Get the models

To download basic pre-trained models, you can use the built-in command:

xspect models download

Additional species models can be trained using:

xspect models train ncbi

How to run the web app

To run the web app, simply execute:

xspect web

This will start a local web server. You can access the web app by navigating to http://localhost:8000 in your web browser.

How to use the XspecT command line interface

To use the XspecT command line interface, execute xspect with the desired subcommand and parameters.

Example:

xspect classify species

If you do not provide the required parameters, the command line interface will prompt you for them. For further instructions on how to use the command line interface, please refer to the documentation or execute:

xspect --help

Metadata

Release files for XspecT 0.5.1

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for XspecT 0.5.1
File Size Uploaded Provenance Actions
xspect-0.5.1.tar.gz 489.7 kB With provenance Details for xspect-0.5.1.tar.gz

Built distribution (wheel)

Table of built distributions (wheels) for XspecT 0.5.1
File Interpreter ABI Platform Actions
xspect-0.5.1-py3-none-any.whl Python 3 none any Details for xspect-0.5.1-py3-none-any.whl

Total release size: 995.6 kB

Release files / xspect-0.5.1.tar.gz

Download URL xspect-0.5.1.tar.gz
Size 489.7 kB
Tags Source
SHA-256 checksum
How to use checksums
f6b97fe146631a4d274d3dc58108355255b5b1624bcc7e8ad43cbf3ad2d73f7c
BLAKE2b-256 checksum
How to use checksums
d7c22d4d9c6fd30e98d8bcd4f1c9c4073ae9af0944d0f817221db8ca05157164
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/6.1.0 CPython/3.12.9

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on May 22, 2025.

Transparency log

Release files / xspect-0.5.1-py3-none-any.whl

Download URL xspect-0.5.1-py3-none-any.whl
Size 505.8 kB
Tags Python 3
SHA-256 checksum
How to use checksums
914280e594fa1bac54a33c96bdc76b1fbba92d82a16d19c7ecf1a42507cd23e5
BLAKE2b-256 checksum
How to use checksums
0ea247e30806149ab234607431e5554b31e08c66404019473f72f20830ece3ff
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/6.1.0 CPython/3.12.9

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on May 22, 2025.

Transparency log

Security for XspecT 0.5.1

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

Full provenance

Both files in this release have been uploaded with provenance metadata.

Select from 2 files

Attestation for xspect-0.5.1.tar.gz

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on May 22, 2025.

Transparency log

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page