Getting started
---------------

pyft: python bindings for fibertools-rs
---------------------------------------

.. image:: https://readthedocs.org/projects/py-ft/badge/?version=latest
    :target: https://py-ft.readthedocs.io/en/latest/?badge=latest
    :alt: Documentation Status

.. image:: https://badge.fury.io/py/pyft.svg
    :target: https://badge.fury.io/py/pyft


**pyft** provides a python API for the rust library `fibertools-rs <https://github.com/fiberseq/fibertools-rs>`_. The inspiration for this API is to make analysis in python easier and faster; therefore, only extraction of data from a fiberseq bam is supported and not writing. 


Install
=======
.. code-block:: bash

    pip install pyft
    

Vignettes
=========
The `vignettes <vignettes/index.rst>`_ are a good place to start to understand the capabilities of pyft.

Indices and tables
==================

* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`


.. toctree::
    :hidden:
    :maxdepth: 2
    :caption: pyft
    
    self
    api.rst
    vignettes/index.rst