Metadata-Version: 2.5
Name: fledermap
Version: 0.1.0b3
Summary: Map-first organiser for bat recordings from handheld detectors
Author: Janna Hopp
License-Expression: MIT
License-File: LICENSE.txt
Classifier: Development Status :: 3 - Alpha
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Requires-Python: >=3.11
Requires-Dist: alembic
Requires-Dist: click
Requires-Dist: flask
Requires-Dist: geoalchemy2
Requires-Dist: numpy
Requires-Dist: pillow
Requires-Dist: platformdirs
Requires-Dist: poiidx<0.1,>=0.0.9
Requires-Dist: procrastinate<4,>=3.9
Requires-Dist: psycopg2-binary
Requires-Dist: psycopg[binary,pool]
Requires-Dist: pyproj
Requires-Dist: pyyaml
Requires-Dist: scikit-learn
Requires-Dist: scipy
Requires-Dist: shapely
Requires-Dist: sqlalchemy>=2.0.16
Requires-Dist: watchdog
Description-Content-Type: text/markdown

# fledermap

Map-first organiser for bat recordings from handheld detectors. Point it at
the folder your detector (currently Wildlife Acoustics Echo Meter Touch)
syncs its recordings into, and it builds a browsable map of where and when
you recorded, with automatic species identification, session/site
clustering, spectrograms, and audibilised (time-expanded/heterodyne)
playback — a self-hosted web app you open in your browser, no cloud
service involved.

![Fledermap's map view with a site cluster and a recording's detail drawer open, showing its spectrogram, oscillogram, and species identification](docs/assets/map-drawer.png)

Only Wildlife Acoustics EMT recordings (GUANO/`wamd` metadata plus the
detector's own filename convention) are recognized today — files from other
detectors are silently skipped rather than causing an error. If you'd like
your device supported, please
[open an issue](https://github.com/bytehexe/fledermap/issues) with a sample
recording (subject to a license that allows us to use it as a test
fixture). Species identification natively covers Europe and North America
(USA/Canada) — see the docs for the exact species list.

## Quickstart

1. [Set up Fledermap](docs/how-to/setup.md) — write a config file naming
   your detector's export folder, then `fledermap install`.
2. Sync recordings into that folder as usual — they appear on the map on
   their own, no further action needed.

## Documentation

Everything past this quickstart — how-to guides, reference material, and
the reasoning behind the design — lives at
**https://bytehexe.github.io/fledermap/**.

## Built with agentic engineering

Fledermap's code, and most of this documentation, was written by an AI
agent (Claude/Claude Code) working with a human maintainer, not typed by
hand. If that matters to you as a user or a potential contributor — either
way, that's fair — this is stated upfront so you can decide for yourself.

## Security note

Fledermap currently has **no authentication on any route**, and none is
currently planned. Anyone who can reach the host — anyone on the same
network, or further if port-forwarded — has full read/write access. Treat
it accordingly, and if you need authentication,
[open an issue](https://github.com/bytehexe/fledermap/issues) so it can be
prioritized.

## For contributors

See [`docs/contributing.md`](docs/contributing.md).
