Skip to main content

Tests Coverage Status Documentation PyPI

sercol

sercol provides Collection, a sequence that filters and groups while keeping its collection type and source metadata, and saves to JSON through serializable. It is the base class for varcode's VariantCollection and EffectCollection and mhctools' BindingPredictionCollection, so their filtering and grouping behave the same.

Install

python -m pip install sercol

sercol needs Python 3.11 or later; it installs serializable and pandas 3.

Quick start

from sercol import Collection

values = Collection([5, 2, 3, 2])
selected = values.filter(lambda value: value >= 3)
groups = values.groupby(lambda value: value % 2)
print(list(selected))
print({key: list(group) for key, group in groups.items()})
[5, 3]
{1: [5, 3], 0: [2, 2]}

filter() returns a new collection and groupby() a dictionary of collections, each of the original class with the same distinct, sort_key and sources. The original collection is unchanged.

Documentation

The documentation covers, in reading order:

  1. Getting started: filter, group, save and reload.
  2. Select, order and track values: duplicates, sorting, threshold lookups, multiple groups, source metadata and subclassing.
  3. API reference.

Development

python -m pip install -e . pytest pytest-cov ruff
./lint.sh   # ruff check
./test.sh   # pytest with coverage
python -m pip install -r requirements-docs.txt
./docs.sh   # mkdocs build --strict, then a rendered-link check
python scripts/check_docs_examples.py   # run docs examples, compare output

License

Apache 2.0; see LICENSE.

Metadata

Release files for sercol 1.1.0

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

Source distribution (sdist)

Source distribution for sercol 1.1.0
File Size Uploaded Provenance Actions
sercol-1.1.0.tar.gz 15.8 kB Without provenance Details for sercol-1.1.0.tar.gz

Built distribution (wheel)

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

Total release size: 27.9 kB

Release files / sercol-1.1.0.tar.gz

Download URL sercol-1.1.0.tar.gz
Size 15.8 kB
Tags Source
SHA-256 checksum
How to use checksums
eb35cf1ff825e98e6a760c77c4681c15c33331b17e895b214addd886a71e2b53
BLAKE2b-256 checksum
How to use checksums
9d67ed3ca6899a095eb983e667edbb9c207a11fa4e6714e62c968d084aae01fc
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/7.0.0 CPython/3.12.6

Release files / sercol-1.1.0-py3-none-any.whl

Download URL sercol-1.1.0-py3-none-any.whl
Size 12.1 kB
Tags Python 3
SHA-256 checksum
How to use checksums
23ece7dc290a8297dfbf073bbf8e0b49440c681db8fc10d64c39598cf0de9cfd
BLAKE2b-256 checksum
How to use checksums
a4639b6c37e7257761cdab37efbc153715f0a8121e24b20584a3bf1d591e3810
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/7.0.0 CPython/3.12.6

Security for sercol 1.1.0

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.

No provenance found

None of the files in this release were uploaded with provenance metadata.

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