Skip to main content

Official Verdantly client for accessing plant data

Project description

Verdantly Python Client

The official Python client for accessing plant variety and species data from the Verdantly API.


Installation

pip install verdantly

Or install from source:

pip install -e .

Getting Started

You'll need a valid API key from RapidAPI.

from verdantly_client import VerdantlyClient

client = VerdantlyClient(api_key="your-api-key")

Example Usage (Sync)

results = client.search_plant_varieties_by_filter({
  "category": "fruit",
  "waterRequirement": "low"
})

for plant in results["data"]:
  print(plant["name"])

Example Usage (Async)

from verdantly_client_async import VerdantlyClientAsync
import asyncio

async def main():
    client = VerdantlyClientAsync(api_key="your-api-key")
    results = await client.search_plant_varieties_by_filter({
        "category": "fruit",
        "waterRequirement": "low"
    })
    for plant in results["data"]:
        print(plant["name"])
    await client.close()

asyncio.run(main())

More examples available in starter/.


Supported Endpoints

  • get_plant_variety_categories()
  • get_types_by_category(category: str)
  • get_subtypes_by_type(type: str)
  • search_plant_varieties_by_name(query: str, page: int = 1)
  • search_plant_varieties_by_filter(filters: dict, page: int = 1)
  • search_plant_species_by_name(query: str, page: int = 1)
  • search_plant_species_by_filter(filters: dict, page: int = 1)

Project Structure

  • verdantly_client.py — sync client
  • verdantly_client_async.py — async client
  • starter/ — runnable starter project with real use case
  • tests/ — test suite for both clients

License

MIT © Verdantly

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

verdantly-0.1.0.tar.gz (5.8 kB view details)

Uploaded Source

Built Distribution

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

verdantly-0.1.0-py3-none-any.whl (4.8 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: verdantly-0.1.0.tar.gz
  • Upload date:
  • Size: 5.8 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.13.2

File hashes

Hashes for verdantly-0.1.0.tar.gz
Algorithm Hash digest
SHA256 92fea0327615a2c12774ba3c030c4dafb300afecd1ea6167e271704fd5ceb7d3
MD5 bf554a64a5f2857bb6a377794cd43708
BLAKE2b-256 20e7ac04d646456f99fe7df18d6080e483c26a61199eaa1ee08db347bb28b5bf

See more details on using hashes here.

File details

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

File metadata

  • Download URL: verdantly-0.1.0-py3-none-any.whl
  • Upload date:
  • Size: 4.8 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.13.2

File hashes

Hashes for verdantly-0.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 b59ee6f46d6ceb7a31375ba2b2ecec55f9495fca3de50b6b4a91367192595984
MD5 10b65901ca59669fd90937bcd7cac263
BLAKE2b-256 f68d8b2234f81831409516b41d6e7b679e298781534cd889e48b85f110c09e59

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