More user-friendly, high-level API

[redfrexx]

Summary

Implement a more high-level API which is easier to use for python programmers by

1. Suggest available parameters for specific mobility types (e.g. car, train) via tab completion

from co2calculator import Trip, BusCarFuel

# CO2 emissions for a trip by car
trip_by_car = Trip(distance=300).by_car(fuel_type=BusCarFuel.DIESEL)

# Same trip with different vehicles
trip = Trip(start='Heidelberg', end='Freiburg')
trip_train = trip.by_train()
trip_plane = trip.by_plane()
trip_bus = trip.by_bus()

# Result could be an object which contains the following information
# Emissions 
trip_train.co2e
# Distance
trip_train.distance
# Meta information (e.g. emission factor and source)
trip_train.emission_factor
trip_train.emission_factor.source

2. List valid parameter combinations based on user specified parameters

This could look like this, but it would then require adding a calculate() method to the example above to enable multiple functions to be called for a specific transport mode.

from co2calculator import Trip, BusCarFuel, Size

# Calculate co2 emission using 'calculate()'
Trip(distance=300).by_car(fuel_type=BusCarFuel.DIESEL).calculate()

# Get valid parameter options based on user chosen parameters
trip = Trip(start='Heidelberg', end='Freiburg')
# print options as dictionary
trip.by_car(fuel_type=BusCarFuel.DIESEL).get_options()
# Returns {'size': [Size.SMALL, Size.LARGE]}

3. Analog for emissions from energy consumption

from co2calculator import Energy, HeatingFuel, Unit

# Calculate co2 emissions 
energy_heating = Energy().from_heating(fuel_type=HeatingFuel.OIL, consumption=100, unit=Unit.LITER).calculate()
energy_electricity = Energy().from_electricity(consumption=100).calculate()

# Print result
energy_heating.co2e
energy_heating.consumption
energy_heating.emission_factor
energy_heating.emission_factor.source

What do you think?

Reference Issues

No response

Unresolved questions

No response

[redfrexx]

related to issue #137