Skip to main content
Warning: You are using the test version of PyPI. This is a pre-production deployment of Warehouse. Changes made here affect the production instance of TestPyPI (testpypi.python.org).
Help us improve Python packaging - Donate today!

Fleetmon API wrapper for ship data

Project Description
## Fleetmonger

Python wrapper for the [fleetmon.com](fleetmon.com) ship-tracking API.

## API Calls
[Read the details of the API at Fleetmonger](https://www.fleetmon.com/faq/public_api).
* fleetmonger.myfleet
* fleetmonger.vessel
* fleetmonger.vesselparticulars
* fleetmonger.vesselurl
* fleetmonger.porturl
* fleetmonger.weather
* fleetmonger.containerschedule

Note that some API calls require the purchase of credits at Fleetmon. This package is unaffiliated with Fleetmon, use at your own risk.

# Usage

````python
from fleetmonger import Fleetmonger

fm = Fleetmonger('username', 'your key')

fleet = fm.myfleet()

for ship in fleet:
print ship.name, ship.destination
````

### Vessels

````python

my_vessel = fleet[0]
# or
my_vessel = fm.vessel(mmsi='239725000')
# or
my_vessel = fm.vessel(imo='9197545')
# or
my_vessel = fm.vessel(name='MINNOW')

# Passing incomplete information will raise an error
my_vessel = fm.vessel()
# ValueError

my_vessel.name
# <SS MINNOW>

my_vessel.navigationstatus
# 'On a three hour tour'

my_vessel.etatime
# datetime.datetime(1964, 9, 26, 12, 0, tzinfo=<UTC>)

my_vessel.coords
# (3.469557, -167.255859)

# Missing attributes return None
my_vessel.location
# None

my_vessel.flag
# 'United States'

my_vessel.flag_so
# 'US'

# Some vessels have photos
myvessel.photos
# ["//img1.fleetmon.com/thumbnails/MINNOW_1.220x146.jpg", "//img1.fleetmon.com/thumbnails/MINNOW_2.570x1140.jpg"]

````

Minimum list of `Vessel` attributes:

`coords` (lat, lon), `course`, `destination`, `draught`, `etatime`, `flag`, `heading`, `imo`, `last_port`, `latitude`, `location`, `longitude`, `mmsi`, `name`, `navigationstatus`, `photos`, `positionreceived`, `publicurl`, `speed`, `type`

### Ports

````python

my_vessel.last_port
# <fleetmonger.port.Port object>

port = my_vessel.last_port

port.name
# 'Honolulu, HI'

port.duration
# datetime.timedelta(...)

````
### Port urls and Vessel urls

Pass mmsi, imo or name to vessel methods. Pass locode or name to port methods.

````python
fm.vesselurl(name='MINNOW')

fm.porturl(locode='USLAX')

# Porturl also takes an optional country isocode parameter
fm.porturl(name='new', country='US')
# [<Newark (New York)>, <Newburgh>, <Newburyport>, <Newport (OR)>]
````

### Weather at Location

````python
fm.weather(lat=3.469557, lon=-167.255859)

# You can also pass a vessel object to the weather call
fm.weather(vessel=my_vessel)
````

## Parameters

In general, the parameters that Fleetmonger expects match those of the Fleetmon API, with the following exceptions:

```
instead of mmsinumber, use mmsi
... imonumber ... imo
... q ... name
```
Release History

Release History

This version
History Node

0.0.2.1

History Node

0.0.2

Download Files

Download Files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

File Name & Checksum SHA256 Checksum Help Version File Type Upload Date
fleetmonger-0.0.2.1.tar.gz (5.2 kB) Copy SHA256 Checksum SHA256 Source Feb 11, 2015

Supported By

WebFaction WebFaction Technical Writing Elastic Elastic Search Pingdom Pingdom Monitoring Dyn Dyn DNS Sentry Sentry Error Logging CloudAMQP CloudAMQP RabbitMQ Heroku Heroku PaaS Kabu Creative Kabu Creative UX & Design Fastly Fastly CDN DigiCert DigiCert EV Certificate Rackspace Rackspace Cloud Servers DreamHost DreamHost Log Hosting