Metadata-Version: 2.4
Name: mkmapdiary
Version: 0.0.2
Summary: A travel journal generator
Project-URL: Documentation, https://bytehexe.github.io/mkmapdiary/
Project-URL: Issues, https://github.com/bytehexe/mkmapdiary/issues
Project-URL: Source, https://github.com/bytehexe/mkmapdiary
Author: Janna Hopp
License-Expression: PolyForm-Noncommercial-1.0.0
License-File: LICENSE.txt
Classifier: Development Status :: 4 - Beta
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: Implementation :: CPython
Classifier: Programming Language :: Python :: Implementation :: PyPy
Requires-Python: >=3.8
Requires-Dist: click
Requires-Dist: doit
Requires-Dist: gpxpy
Requires-Dist: hdbscan
Requires-Dist: humanfriendly
Requires-Dist: identify
Requires-Dist: imageio
Requires-Dist: jsonschema
Requires-Dist: libsass
Requires-Dist: lxml
Requires-Dist: mkdocs
Requires-Dist: mkdocs-glightbox
Requires-Dist: mkdocs-material
Requires-Dist: msgpack
Requires-Dist: ollama
Requires-Dist: osmium>=4.0.0
Requires-Dist: pillow
Requires-Dist: platformdirs
Requires-Dist: pydub
Requires-Dist: pyexiftool
Requires-Dist: pyrosm
Requires-Dist: pyyaml
Requires-Dist: rawpy
Requires-Dist: requests
Requires-Dist: tabulate
Requires-Dist: tzlocal
Requires-Dist: wcwidth
Provides-Extra: all
Requires-Dist: openai-whisper; extra == 'all'
Provides-Extra: transcription
Requires-Dist: openai-whisper; extra == 'transcription'
Description-Content-Type: text/markdown

# mkmapdiary

[![PyPI - Version](https://img.shields.io/pypi/v/mkmapdiary.svg)](https://pypi.org/project/mkmapdiary)
![PyPI - License](https://img.shields.io/pypi/l/mkmapdiary)
![PyPI - Status](https://img.shields.io/pypi/status/mkmapdiary)

![PyPI - Python Version](https://img.shields.io/pypi/pyversions/mkmapdiary)


-----

A travel journal generator.

## Installation

```console
pipx install mkmapdiary[all]
```

## Quick start

Set up a directory containing all your sources, e.g. `traveljournal`. Then run:

```bash
mkmapdiary traveljournal
x-www-browser traveljournal_dist/index.html # Open the page
```

Mkmapdiary will then create a directory `traveljournal_dist`, containing the output as a website.

For the full reference of commandline options run `mkmapdiary --help`.

## Running mkmapdiary on placeholder data

Mkmapdiary can generate a project with placeholder data:

```bash
mkmapdiary -T demo
mkmapdiary demo
x-www-browser demo/index.html
```

This is for debugging/demonstration purposes only! Images by https://picsum.photos/.

## Running the dev version

Within the project root, run:

```bash
pipx install hatch taskipy pre-commit
pre-commit install
hatch run mkmapdiary --help
```

## Documentation

See https://bytehexe.github.io/mkmapdiary/

## License

`mkmapdiary` is distributed under the terms of the [PolyForm Noncommercial License 1.0.0](https://polyformproject.org/licenses/noncommercial/1.0.0/) license.

> Required Notice: Copyright Janna Hopp (https://github.com/bytehexe)

## Bon voyage!

Have fun travelling and stay safe!