Skip to content

Latest commit

 

History

History

Folders and files

NameName
Last commit message
Last commit date

parent directory

..
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

README.md

Python Bindings for FlatGFA

This is a Python interface for the FlatGFA library, which provides an efficient representation for pangenomic variation graphs in the Graphical Fragment Assembly (GFA) format.

You can install it from PyPI:

$ pip install flatgfa

Then, read the API documentation for details about what it can do so far.

Development

The easiest way to get started is with uv:

$ uv run --package flatgfa python example.py

That should build and install the package and then run our example.py script.

Or run the tests:

$ uv run --package flatgfa pytest

During development, you'll want to rebuild the module using Maturin. One way to do it is to install the necessary command-line tools into the virtualenv, like this:

$ . .venv/bin/activate
$ cd flatgfa-py
$ uv pip install maturin
$ maturin develop --uv

Then, just type maturin develop and pytest while you work.