Skip to main content

Export iNaturalist observations to Ankivalenz-formatted Markdown for creating flashcards

Project description

iNaturalist to Ankivalenz

A Python CLI tool to export iNaturalist observations to Ankivalenz-formatted Markdown for creating flashcards.

Features

  • Fetch user's observations from iNaturalist API
  • Download observation images to a local directory
  • Generate Ankivalenz-compatible Markdown flashcards
  • Support for multiple observations
  • Preserve observation metadata

Installation

pip install inaturalist-to-ankivalenz

Usage

Export observations for any iNaturalist user:

inaturalist-to-ankivalenz --username <username> [--limit <number>] [--output-dir <directory>] [--common-name-lang <language>]

Options:

  • --username: iNaturalist username (required)
  • --limit: Maximum number of observations to fetch (default: 100)
  • --output-dir: Output directory for images and markdown (default: current directory)
  • --common-name-lang: Language for common names (e.g., 'en', 'da', 'sv') (default: 'en')

Output

The tool will:

  1. Create an iNaturalist/ directory to store downloaded images
  2. Generate an iNaturalist.md file with Ankivalenz-formatted flashcards

Example output format:

# iNaturalist

- ![iNaturalist/observation-1.jpg] ?:: Monarch Butterfly (Danaus plexippus)
- ![iNaturalist/observation-2.jpg] ?:: California Poppy (Eschscholzia californica)

Development

To set up the development environment:

# Clone the repository
git clone https://github.com/yourusername/inaturalist-to-ankivalenz.git
cd inaturalist-to-ankivalenz

# Create and activate virtual environment
python -m venv venv
source venv/bin/activate  # On Windows: venv\Scripts\activate

# Install in development mode
pip install -e .

# Run tests
pytest

License

MIT License

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

inaturalist_to_ankivalenz-0.1.0.tar.gz (5.7 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

inaturalist_to_ankivalenz-0.1.0-py3-none-any.whl (4.7 kB view details)

Uploaded Python 3

File details

Details for the file inaturalist_to_ankivalenz-0.1.0.tar.gz.

File metadata

File hashes

Hashes for inaturalist_to_ankivalenz-0.1.0.tar.gz
Algorithm Hash digest
SHA256 cd5f7a61a9383c36ce67ddea2a079cc722525c70cb69b1adf279c1e688ee06bd
MD5 74c827d35b6ae1e5ace72ef5619e96e3
BLAKE2b-256 35cef77bfdfdf8642911e461af0c598910fe4b0aafb57e5d5c920a04a82cc00b

See more details on using hashes here.

File details

Details for the file inaturalist_to_ankivalenz-0.1.0-py3-none-any.whl.

File metadata

File hashes

Hashes for inaturalist_to_ankivalenz-0.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 524b0a60a634155716f2531c6ca9fb0d23cec74de35fce59f36ce810e9d1bb75
MD5 2cc40a9ca34492ecee2f3af3ebd2c47c
BLAKE2b-256 9211f82058f473eed704d0e9b310b8ea871ab857039a66b8ceff4931f82e0b87

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page