Metadata-Version: 2.1
Name: pycruisemapper
Version: 0.9.0
Summary: Simple Python script to fetch data from CruiseMapper
Project-URL: Homepage, https://kumig.it/kumitterer/pycruisemapper
Project-URL: Bug Tracker, https://kumig.it/kumitterer/pycruisemapper/issues
Author-email: Kumi Mitterer <pycruisemapper@kumi.email>
License: Copyright (c) 2022 Kumi Mitterer <pycruisemapper@kumi.email>
        
        Permission is hereby granted, free of charge, to any person obtaining a copy
        of this software and associated documentation files (the "Software"), to deal
        in the Software without restriction, including without limitation the rights
        to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
        copies of the Software, and to permit persons to whom the Software is
        furnished to do so, subject to the following conditions:
        
        The above copyright notice and this permission notice shall be included in all
        copies or substantial portions of the Software.
        
        THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
        IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
        FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
        AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
        LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
        OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
        SOFTWARE.
License-File: LICENSE
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 3
Requires-Python: >=3.8
Description-Content-Type: text/markdown

# pyCruiseMapper

Python package for retrieving data on (cruise) ships from cruisemapper.com

This is a very basic implementation, and it might stay like this, but I still
wanted to share it in case anyone finds it useful. I can't promise that I will
keep this package updated or that it's going to work forever as is, though.

I wanted to keep it simple, so this package has no dependencies outside the
standard library. Tested on Python 3.10.6 only, but should work on any >= 3.8.

## Basic Usage

```python
from pycruisemapper import CruiseMapper

cruisemapper = CruiseMapper()

# First, retrieve basic data on all ships
# Returns a list of Ship objects

all_ships = cruisemapper.get_ships()

# Then, select the ship(s) you are interested in from that list

meinschiff1 = list(filter(lambda x: x.imo == 9783564))[0]

# You may want to retrieve additional information of a ship's current status
# Pass the Ship object into fill_ship and it will return an object with details

meinschiff1 = cruisemapper.fill_ship(meinschiff1)

# You can now access things like the current location or temperature

location = meinschiff1.location # .latitude/.longitude
temperature = meinschiff1.current_temperature # returned in °C

# Check the class definitions in /classes/*.py to see all possible attributes
```