Skip to content

Fix setup.py + add instructions that would have been helpful for me #1

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
creimers wants to merge 2 commits into
base: master
Choose a base branch
from
Open

Fix setup.py + add instructions that would have been helpful for me #1

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
2707e92
fix readme path in setup.py
creimers Feb 28, 2019
a4230d0
added install and additional usage instructions
creimers Feb 28, 2019
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
39 changes: 38 additions & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,15 @@ tests/sample.ais.

Contributions welcome.

## Library usage
## Quickstart

### Installation

You can install the latest version of this library by running

`pip install https://github.com/wpietri/simpleais/archive/master.zip`.

### Library usage

Here's an example, a simplified version of the `aist` tool, which prints
one line per complete AIS message:
Expand All @@ -52,6 +60,35 @@ fields can all be referred to by name. For example, `sentence['mmsi']` or
`sentence['shipname']`. The `location()` method will return a tuple of the
form `(longitude, latitude)`. Missing or invalid fields will return `None`.

Here's another example of how to use the library:

```
import simpleais

result = simpleais.parse("!AIVDM,1,1,,B,177KQJ5000G?tO`K>RA1wUbN0TKH,0*5C")

print(result.as_json())

"{'accuracy': False,
'course': 51.0,
'heading': 181,
'ignored-145': 0,
'lat': 47.5828,
'lon': -122.3458,
'maneuver': 'enum-0',
'mmsi': '477553000',
'radio': 149208,
'raim': False,
'repeat': 0,
'second': 15,
'speed': 0.0,
'status': {'enum_id': 5, 'enum_value': 'Moored'},
'text': ['!AIVDM,1,1,,B,177KQJ5000G?tO`K>RA1wUbN0TKH,0*5C'],
'turn': 0.0,
'type': 1}"

```


## Command-line usage

Expand Down
2 changes: 1 addition & 1 deletion setup.py
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
from setuptools import setup, find_packages

with open('README.rst') as r:
with open('README.md') as r:
readme = r.read()

setup(name='simpleais',
Expand Down