Metadata-Version: 2.1
Name: openfst_python
Version: 1.7.2
Summary: Stand-alone OpenFST bindings for Python
Home-page: https://github.com/jpuigcerver/openfst-python
Author: Joan Puigcerver
Author-email: joapuipe@gmail.com
License: MIT
Description: # OpenFst-Python
        
        [![Build Status](https://travis-ci.com/jpuigcerver/openfst-python.svg?branch=master)](https://travis-ci.com/jpuigcerver/openfst-python)
        [![Python Version](https://img.shields.io/badge/python-2.7%2C%203.5%2C%203.6%2C%203.7-blue.svg)](https://www.python.org/)
        [![Code Style](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/ambv/black)
        
        OpenFst-Python exposes the official Python API to
        [OpenFst](http://www.openfst.org/twiki/bin/view/FST/WebHome)
        (officially called pywrapfst), but includes all the required OpenFst libraries
        in the Python package, so you don't need to install it separately.
        
        The version number of OpenFst-Python is the same as the OpenFst version
        used. **The current version uses OpenFst 1.7.2.**
        
        ## Build Requirements
        
        The build process will download and build OpenFst from the official
        webpage, so you need an Internet connection and all OpenFst dependencies.
        Essentially, you will need:
        
        - A C++ compiler supporting C++11 (tested with GCC 4.9).
        - [PatchELF](https://nixos.org/patchelf.html).
        - [Zlib development](https://zlib.net/).
        - [Python Requests](http://docs.python-requests.org).
        
        ## Installation
        
        Most likely, you want to avoid the build process. Then, simply install the
        package from PyPI:
        
        ```bash
        pip install openfst-python
        ```
        
        Alternatively, if you are installing from sources, you can simply do:
        
        ```bash
        python setup.py install
        ```
        
        Notice that this downloads the appropriate version of OpenFst directly from
        the Internet. If you don't have an Internet connection but are already in
        possession of the appropriate tar.gz file, you can use the following command:
        
        ```bash
        python setup.py build --download-dir=DIRECTORY_CONTAINING_OPENFST_TAR_GZ
        python setup.py install
        ```
        
        ## Documentation
        
        The Python API is the official one provided by OpenFst. Please, refer to its
        [documentation](http://www.openfst.org/twiki/bin/view/FST/PythonExtension).
        
        A toy example:
        
        ```python
        import openfst_python as fst
        
        f = fst.Fst()
        s0 = f.add_state()
        s1 = f.add_state()
        s2 = f.add_state()
        f.add_arc(s0, fst.Arc(1, 2, fst.Weight(f.weight_type(), 3.0), s1))
        f.add_arc(s0, fst.Arc(1, 3, fst.Weight.One(f.weight_type()), s2))
        f.add_arc(s1, fst.Arc(2, 1, fst.Weight(f.weight_type(), 1.0), s2))
        f.set_start(s0)
        f.set_final(s2, fst.Weight(f.weight_type(), 1.5))
        ```
        
        ## License
        
        The OpenFst library is licensed under the Apache License, Version 2.0.
        OpenFst-Python is just a wrapper of its official Python API, so
        I am using the same license for most of the source code.
        `ac_python_devel.m4` was not written by me and it is licensed under the
        GPL license.
        
Platform: UNKNOWN
Classifier: Development Status :: 4 - Beta
Classifier: Intended Audience :: Developers
Classifier: Intended Audience :: Education
Classifier: Intended Audience :: Science/Research
Classifier: Programming Language :: Python :: 2
Classifier: Programming Language :: Python :: 2.7
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.5
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
Classifier: Topic :: Scientific/Engineering
Classifier: Topic :: Software Development
Classifier: Topic :: Software Development :: Libraries
Classifier: Topic :: Software Development :: Libraries :: Python Modules
Description-Content-Type: text/markdown
