FreeSASA Python module
======================
[![Appveyor build status](https://ci.appveyor.com/api/projects/status/nyo51pv2ufj2yhcj/branch/master?svg=true)](https://ci.appveyor.com/project/mittinatten/freesasa-python/branch/master)
[![Travis build status](https://travis-ci.org/freesasa/freesasa-python.svg?branch=master)](https://travis-ci.org/freesasa/freesasa-python)

The module provides Python bindings for the [FreeSASA C Library](https://github.com/mittinatten/freesasa).
There are PyPi packages for Python 3.6+, on Linux, Mac OS X and Windows.
And it can be built from source for 2.7+ (Or by downloading older PyPi packages).
Documentation can be found at http://freesasa.github.io/python/.

Install the module by
~~~~sh
pip install freesasa
~~~~

Developers can clone the library, and then build the module by the following
~~~~sh
git submodule update --init
USE_CYTHON=1 python setup.py build
~~~~

Tests can be run using
~~~~sh
python setup.py test
~~~~

Adding new features
===================

This Python module provides a limited mapping to the C API of FreeSASA.
I wish to extend the module with more functionality out of the box,
to match the capabilities of the C API more closely,
and perhaps also add more complex analysis that would be cumbersome to write in C.
Feel free to submit feature request as GitHub issues.
A few simple suggestions are already listed as issues.
I only work on FreeSASA in my spare time, so PRs are always welcome.
