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.3.0.tar.gz (7.4 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.3.0-py3-none-any.whl (4.7 kB view details)

Uploaded Python 3

File details

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

File metadata

File hashes

Hashes for inaturalist_to_ankivalenz-0.3.0.tar.gz
Algorithm Hash digest
SHA256 9ff84ca3704a4ceb64671555effc62ce3bf96940af812aa1035afc3936dad425
MD5 59744b48960fbbe76830260db393f2ea
BLAKE2b-256 caca7513cbfa8f827d1383501fe434c02660f0947864c9101a39495a1809aa13

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for inaturalist_to_ankivalenz-0.3.0-py3-none-any.whl
Algorithm Hash digest
SHA256 cb363924f85b3237b1ef42aca85402510e46c428e3c4f1a24466a98f1c887b76
MD5 be64e8c936ce588a970bb474c2608e41
BLAKE2b-256 5a38a1318c8ca0e7c2459c623c09c0df7f82aa6f678aa11630cc1ce0ed154bb7

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