Fleetmon API wrapper for ship data
Project description
Fleetmonger
Python wrapper for the fleetmon.com ship-tracking API.
API Calls
Read the details of the API at Fleetmonger. * 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
from fleetmonger import Fleetmonger
fm = Fleetmonger('username', 'your key')
fleet = fm.myfleet()
for ship in fleet:
print ship.name, ship.destinationVessels
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
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.
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
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 notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
File details
Details for the file fleetmonger-0.0.3.tar.gz.
File metadata
- Download URL: fleetmonger-0.0.3.tar.gz
- Upload date:
- Size: 5.5 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 42b49e6c6943221f14c96449e8a4f459d3aa61b945663e047354aba378d59070 |
|
| MD5 | d3e58ee8834285351b8c08184139a46f |
|
| BLAKE2b-256 | eb8eb9f9ed2875fe8e3a742bedd28ed5d58cb75405577668bc6c953f687bc5fa |
File details
Details for the file fleetmonger-0.0.3-py2-none-any.whl.
File metadata
- Download URL: fleetmonger-0.0.3-py2-none-any.whl
- Upload date:
- Size: 9.0 kB
- Tags: Python 2
- Uploaded using Trusted Publishing? No
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | e9f312338dbeec1622e4ee18d432344a8e96a0af785d7a48edbceb8f090e08af |
|
| MD5 | 44d9059043f5b34f005c432083e08f2a |
|
| BLAKE2b-256 | 1afe4b11eac216a8503f1938d46a4021c9fa17d20358106d11649e08c1b0ec79 |
