38 lines
1.4 KiB
Python
38 lines
1.4 KiB
Python
"""Top level package for the mileage logging tool.
|
||
|
||
This package provides a set of modules used to ingest Google Semantic
|
||
Location History data, detect work related travel itineraries based on a
|
||
whitelisted set of sites, resolve driving distances between those sites
|
||
and export the resulting mileage claims into an Excel workbook ready
|
||
for submission to a HR system.
|
||
|
||
The project is organised into subpackages:
|
||
|
||
* :mod:`mileage_logger.ingest` – parse Google Takeout JSON exports
|
||
into structured Python objects.
|
||
* :mod:`mileage_logger.logic` – implement the state machine that
|
||
identifies ordered hops between recognised locations in a day’s
|
||
timeline.
|
||
* :mod:`mileage_logger.distance` – resolve distances via a route
|
||
catalogue or, optionally, an external API with caching.
|
||
* :mod:`mileage_logger.export` – write Excel workbooks or CSV files
|
||
containing the final mileage log.
|
||
* :mod:`mileage_logger.cli` – command line interface for invoking
|
||
common workflows such as importing a new export or rebuilding a
|
||
monthly workbook.
|
||
|
||
This package requires Python 3.11 or newer. See the README for
|
||
installation and usage instructions.
|
||
"""
|
||
|
||
from .ingest import semantic_reader # noqa: F401
|
||
from .logic import detect_itinerary # noqa: F401
|
||
from .distance import resolve # noqa: F401
|
||
from .export import excel_writer # noqa: F401
|
||
|
||
__all__ = [
|
||
"semantic_reader",
|
||
"detect_itinerary",
|
||
"resolve",
|
||
"excel_writer",
|
||
] |