Metadata-Version: 2.1
Name: gfagraphs
Version: 0.3.7
Summary: Library to parse, edit and handle in memory GFA graphs
Home-page: https://github.com/Tharos-ux/gfagraphs
Author: ('Siegfried Dubois',)
Author-email: Siegfried Dubois <siegfried.dubois@inria.fr>
Project-URL: Homepage, https://github.com/Tharos-ux/gfagraphs
Project-URL: Bug Tracker, https://github.com/Tharos-ux/gfagraphs/issues
Classifier: Programming Language :: Python :: 3
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Requires-Python: >=3.10
Description-Content-Type: text/markdown
License-File: LICENSE

[![](https://img.shields.io/badge/Python-3.10-blue.svg)]()
[![](https://img.shields.io/badge/Python-3.11-blue.svg)]()
[![](https://img.shields.io/badge/Python-3.12-blue.svg)]()
[![Documentation Status](https://readthedocs.org/projects/gfagraphs/badge/?version=latest)](https://gfagraphs.readthedocs.io/en/latest/?badge=latest)

# GFAGraphs - A Python GFA library

> [!WARNING]\
> A paper is in preparation about this work. If you consider to use this tool, please contact the author for attribution.

This Python library aims to be an abstraction layer for GFA file format.

> [!WARNING]\
> The old version of `gfagraphs` has been deprecated (since v0.3.0), in favour of `pgGraphs`. Using `gfagraphs` or `pgGraphs` to import resolves now in using the same library. In a near future, `pgGraphs` namespace will be deprecated.

## Package `pgGraphs`/`gfagraphs`

![](https://media.discordapp.net/attachments/874430800802754623/1179353568105467964/library.png)

The package is organized in 4 modules:
+ `gfagraphs.abstractions` contains abstractions over GFA formats
+ `gfagraphs.gfaparser` contains an abstract class for parsing and saving GFA file format
+ `gfagraphs.graph` contains the main `Graph` class that represents a GFA graph in memory, and edit functions
+ `gfagraphs.networkx` conains an abstract class for visualization and modelization of GFA in a NetworkX object

> [!NOTE]\
> Want to contribute? Feel free to open a PR on an issue about a missing, buggy or incomplete feature!

