lpais

use libais to decode ais messages, replacing ais.stream

install and test

Warning

user is encouraged to use gcc to compile libais (gcc and g++), otherwise it's likely to fail. Make sure gcc will be used as default compliler or specify it when install / build

example:

$ CC=gcc-8 CXX=g++-8 pip install lpais

install from pypi

using pip:

$ pip install lpais

dev install

There is a makefile in the project root directory:

$ make dev

Using pip, the above is equivalent to:

$ pip install -r requirements-dev.txt
$ pip install -e .

run the tests

Use the makefile in the project root directory:

$ make test

This runs the tests generating a coverage html report

build the doc

The documentation is made with sphinx, you can use the makefile in the project root directory to build html doc:

$ make doc

Documentation

Documentation on Read The Docs.

Meta

loicpw - [email protected]

Distributed under the MIT license. See LICENSE.txt for more information.

https://github.com/loicpw