Metadata-Version: 2.4
Name: pyranges1
Version: 1.3.0
Summary: GenomicRanges for Python.
Author-email: Endre Bakken Stovner <endbak@hey.com>, Marco Mariotti <marco.mariotti@ub.edu>
License: MIT
Project-URL: Homepage, http://github.com/pyranges/pyranges_1.x
Keywords: bioinformatics,genomicranges,genomics
Classifier: Programming Language :: Python :: 3
Classifier: Development Status :: 4 - Beta
Classifier: Environment :: Other Environment
Classifier: Intended Audience :: Developers
Classifier: Intended Audience :: Science/Research
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: POSIX :: Linux
Classifier: Operating System :: MacOS :: MacOS X
Classifier: Topic :: Scientific/Engineering
Requires-Python: >=3.12.0
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: pandas<3.0.0
Requires-Dist: tabulate
Requires-Dist: natsort
Requires-Dist: ruranges>=0.1.1
Provides-Extra: add-ons
Requires-Dist: pyrle>=0.0.43; extra == "add-ons"
Requires-Dist: bamread; extra == "add-ons"
Requires-Dist: pyfaidx; extra == "add-ons"
Requires-Dist: pyBigWig; extra == "add-ons"
Requires-Dist: joblib; extra == "add-ons"
Provides-Extra: dev
Requires-Dist: tox; extra == "dev"
Requires-Dist: ruff==0.14.1; extra == "dev"
Requires-Dist: pyright; extra == "dev"
Requires-Dist: pandas-stubs; extra == "dev"
Requires-Dist: types-tabulate; extra == "dev"
Requires-Dist: pytest-watcher; extra == "dev"
Requires-Dist: pytest-xdist; extra == "dev"
Provides-Extra: docs
Requires-Dist: sphinx; extra == "docs"
Requires-Dist: sphinx_rtd_theme; extra == "docs"
Requires-Dist: sphinx-autoapi; extra == "docs"
Requires-Dist: sphinxcontrib-napoleon; extra == "docs"
Provides-Extra: cli
Requires-Dist: fire; extra == "cli"
Provides-Extra: all
Requires-Dist: pyranges1[add-ons]; extra == "all"
Requires-Dist: pyranges1[dev]; extra == "all"
Requires-Dist: pyranges1[docs]; extra == "all"
Requires-Dist: pyranges1[cli]; extra == "all"
Dynamic: license-file

# pyranges

## Introduction

Pyranges is a Python library with a Rust backend for efficient and intuitive manipulation of genomics data,
particularly genomic intervals (like genes, genomic features, or reads).
The library is optimized for fast querying and manipulation of genomic annotations.
It enables intuitive and highly efficient pipelines for genomic analysis.

*"Finally ... This was what Python badly needed for years."* - Heng Li

## Version 1.x
This is version 1.x of pyranges. It is a complete rewrite of the original pyranges library, 
soon to replace the "default" original one (version 0). If you are a v0 user, check the migration guide 
in the documentation.

## Documentation

The pyranges documentation, including installation instructions, API, tutorial, and how-to-pages, is 
available at https://pyranges1.readthedocs.io/

## Recent Changelog

```
# 1.3.1 (15.02.26)
- require ruranges>=0.1.1
- remove fallback compatibility hack for old ruranges versions lacking `ruranges.numpy`
- add dtype support tests for unsigned/integer interval inputs (e.g. uint32 issue case)

# 1.2.0 (29.01.26)
- module name changed from pyranges to pyranges1, to allow co-existing with pyranges (v0) in same env

# 1.1.9 (26.01.26)
- pandas dependency bound to v2. This is in response to pandas 3.0.0 being released, breaking our doctests.

# 1.1.8 (30.12.25)
- to_gtf and to_gff3: fix bug where 'phase' (gtf) and 'frame' (gff3) are erroneously added to attributes field

# v1.1.7 (16.12.25)
- window_ranges: fix sort order issue in  when using by (#98 and #105)
- window_ranges: added argument add_window_id, updated documentation
```

## Install

Pyranges 1.x requires python ≥3.12. Minimal installation: 

```bash
pip install pyranges1
```

This installs and requires `ruranges>=0.1.1` automatically.

Installation including all optional dependencies:

```bash
pip install pyranges1[all]
```

Details at https://pyranges1.readthedocs.io/en/latest/installation.html


## Features

  - fast
  - memory-efficient
  - featureful
  - pythonic/pandastic

## Paper/Cite

For v1:

Stovner EB, Ticó M, Muñoz del Campo E, Pallarès-Albanell J, Chawla K, Sætrom P, Mariotti M (2025) Pyranges v1: a Python framework for ultrafast sequence interval operations.
*bioRxiv* 2025.12.11.693639; doi: https://doi.org/10.64898/2025.12.11.693639


For v0:

Stovner EB, Sætrom P (2020) PyRanges: efficient comparison of genomic intervals in Python. 
*Bioinformatics 36(3):918-919*  http://dx.doi.org/10.1093/bioinformatics/btz615

## Supporting pyranges

  - most importantly, cite pyranges if you use it. It is the main metric funding sources care about.
  - use pyranges in Stack Overflow/biostars questions and answers
  - star the repo (possibly important for github visibility and as a proxy for project popularity)

## Asking for help

If you encounter bugs, or the documentation is not enough a cannot accomplish a specific task of interest, 
or if you'd like new features implemented, open an Issue at github: https://github.com/pyranges/pyranges/issues

## Contributing to pyranges

Pyranges accepts code contributions in form of pull request. 
For details, visit [https://pyranges1.readthedocs.io/developer_guide.html](https://pyranges1.readthedocs.io/en/latest/developer_guide.html)

## Cheatsheet
![cheatsheet](https://raw.githubusercontent.com/pyranges/pyrangeyes/for_pyranges1_1/images/pyranges_cheatsheet.png)
(The cheatsheet above was created with pyrangeyes, a companion graphical library:  https://pyrangeyes.readthedocs.io/)


