Data.EBird.CLI

Functions used to implement a command-line utility for interacting with the eBird API.

Documentation

eBirdCli :: IO ()

Entry point for the ebird CLI. Parses the command arguments, selects an API key, and executes the command.

The API key may be provided as a command-line option. If the key option is not provided, it is read from the file ~/.ebird/key.txt. If that file is unavailable for reading, and no key option is provided, the application exits (if the command requires a key).

readEBirdAPIKey :: IO (Maybe Text)

Read an eBird API key from ~/.ebird/key.txt. If the file exists and is available for reading, the result is Just the contents of the file, stripped of leading/trailing whitespace. Otherwise, the result is Nothing.

runEBirdCommand

Arguments

:: IO Text

Get an API key (this may fail if not found or provided)

-> EBirdCommand

Command to execute

-> IO ()

Run an EBirdCommand with a given API key.

printResJSON :: ToJSON a => a -> IO ()

Simply prints a value as prettified JSON

eBirdFail :: String -> IO a

Print a string to stderr, prepended with a context string, and exit with failure status.

data EBirdCommand

Each EBirdCommand corresponds to an endpoint of the eBird API

Constructors

RecentObservationsCommand RecentObservationsOptions

RecentNotableObservationsCommand RecentNotableObservationsOptions

RecentSpeciesObservationsCommand RecentSpeciesObservationsOptions

RecentNearbyObservationsCommand RecentNearbyObservationsOptions

RecentNearbySpeciesObservationsCommand RecentNearbySpeciesObservationsOptions

RecentNearestSpeciesObservationsCommand RecentNearestSpeciesObservationsOptions

RecentNearbyNotableObservationsCommand RecentNearbyNotableObservationsOptions

HistoricalObservationsCommand HistoricalObservationsOptions

RecentChecklistsCommand RecentChecklistsOptions

Top100Command Top100Options

ChecklistFeedCommand ChecklistFeedOptions

RegionalStatisticsCommand RegionalStatisticsOptions

SpeciesListCommand SpeciesListOptions

ViewChecklistCommand ViewChecklistOptions

RegionHotspotsCommand RegionHotspotsOptions

NearbyHotspotsCommand NearbyHotspotsOptions

HotspotInfoCommand HotspotInfoOptions

TaxonomyCommand TaxonomyOptions

TaxonomicFormsCommand TaxonomicFormsOptions

TaxaLocaleCodesCommand TaxaLocaleCodesOptions

TaxonomyVersionsCommand

TaxonomicGroupsCommand TaxonomicGroupsOptions

RegionInfoCommand RegionInfoOptions

SubregionListCommand SubregionListOptions

AdjacentRegionsCommand AdjacentRegionsOptions

Instances

Show EBirdCommand

Defined in Data.EBird.CLI

Methods

showsPrec :: Int -> EBirdCommand -> ShowS

show :: EBirdCommand -> String

showList :: [EBirdCommand] -> ShowS

Eq EBirdCommand

Defined in Data.EBird.CLI

Methods

(==) :: EBirdCommand -> EBirdCommand -> Bool

(/=) :: EBirdCommand -> EBirdCommand -> Bool

data RecentObservationsOptions

Options for the recent-observations command.

Constructors

RecentObservationsOptions

Fields

• recentObservationsRegion :: RegionCode
• recentObservationsBack :: Maybe Integer
• recentObservationsCategories :: Maybe TaxonomyCategories
• recentObservationsHotspots :: Maybe Bool
• recentObservationsProvisionals :: Maybe Bool
• recentObservationsMaxResults :: Maybe Integer
• recentObservationsSubregions :: Maybe RegionCode
• recentObservationsSPPLocale :: Maybe SPPLocale

Instances

Read RecentObservationsOptions

Defined in Data.EBird.CLI

Methods

readsPrec :: Int -> ReadS RecentObservationsOptions

readList :: ReadS [RecentObservationsOptions]

readPrec :: ReadPrec RecentObservationsOptions

readListPrec :: ReadPrec [RecentObservationsOptions]

Show RecentObservationsOptions

Defined in Data.EBird.CLI

Methods

showsPrec :: Int -> RecentObservationsOptions -> ShowS

show :: RecentObservationsOptions -> String

showList :: [RecentObservationsOptions] -> ShowS

Eq RecentObservationsOptions

Defined in Data.EBird.CLI

Methods

(==) :: RecentObservationsOptions -> RecentObservationsOptions -> Bool

(/=) :: RecentObservationsOptions -> RecentObservationsOptions -> Bool

data RecentNotableObservationsOptions

Options for the recent-notable-observations command.

Constructors

RecentNotableObservationsOptions

Fields

• recentNotableObservationsRegion :: RegionCode
• recentNotableObservationsBack :: Maybe Integer
• recentNotableObservationsDetail :: Maybe DetailLevel
• recentNotableObservationsHotspots :: Maybe Bool
• recentNotableObservationsMaxResults :: Maybe Integer
• recentNotableObservationsSubregions :: Maybe RegionCode
• recentNotableObservationsSPPLocale :: Maybe SPPLocale

Instances

Read RecentNotableObservationsOptions

Defined in Data.EBird.CLI

Methods

readsPrec :: Int -> ReadS RecentNotableObservationsOptions

readList :: ReadS [RecentNotableObservationsOptions]

readPrec :: ReadPrec RecentNotableObservationsOptions

readListPrec :: ReadPrec [RecentNotableObservationsOptions]

Show RecentNotableObservationsOptions

Defined in Data.EBird.CLI

Methods

showsPrec :: Int -> RecentNotableObservationsOptions -> ShowS

show :: RecentNotableObservationsOptions -> String

showList :: [RecentNotableObservationsOptions] -> ShowS

Eq RecentNotableObservationsOptions

Defined in Data.EBird.CLI

Methods

(==) :: RecentNotableObservationsOptions -> RecentNotableObservationsOptions -> Bool

(/=) :: RecentNotableObservationsOptions -> RecentNotableObservationsOptions -> Bool

data RecentSpeciesObservationsOptions

Options for the recent-species-observations command.

Constructors

RecentSpeciesObservationsOptions

Fields

• recentSpeciesObservationsRegion :: RegionCode
• recentSpeciesObservationsSpecies :: SpeciesCode
• recentSpeciesObservationsBack :: Maybe Integer
• recentSpeciesObservationsHotspots :: Maybe Bool
• recentSpeciesObservationsProvisionals :: Maybe Bool
• recentSpeciesObservationsMaxResults :: Maybe Integer
• recentSpeciesObservationsSubregions :: Maybe RegionCode
• recentSpeciesObservationsSPPLocale :: Maybe SPPLocale

Instances

Read RecentSpeciesObservationsOptions

Defined in Data.EBird.CLI

Methods

readsPrec :: Int -> ReadS RecentSpeciesObservationsOptions

readList :: ReadS [RecentSpeciesObservationsOptions]

readPrec :: ReadPrec RecentSpeciesObservationsOptions

readListPrec :: ReadPrec [RecentSpeciesObservationsOptions]

Show RecentSpeciesObservationsOptions

Defined in Data.EBird.CLI

Methods

showsPrec :: Int -> RecentSpeciesObservationsOptions -> ShowS

show :: RecentSpeciesObservationsOptions -> String

showList :: [RecentSpeciesObservationsOptions] -> ShowS

Eq RecentSpeciesObservationsOptions

Defined in Data.EBird.CLI

Methods

(==) :: RecentSpeciesObservationsOptions -> RecentSpeciesObservationsOptions -> Bool

(/=) :: RecentSpeciesObservationsOptions -> RecentSpeciesObservationsOptions -> Bool

data RecentNearbyObservationsOptions

Options for the recent-nearby-observations command.

Constructors

RecentNearbyObservationsOptions

Fields

• recentNearbyObservationsLatitude :: Double
• recentNearbyObservationsLongitude :: Double
• recentNearbyObservationsDist :: Maybe Integer
• recentNearbyObservationsBack :: Maybe Integer
• recentNearbyObservationsCategories :: Maybe TaxonomyCategories
• recentNearbyObservationsHotspots :: Maybe Bool
• recentNearbyObservationsProvisionals :: Maybe Bool
• recentNearbyObservationsMaxResults :: Maybe Integer
• recentNearbyObservationsSortBy :: Maybe SortObservationsBy
• recentNearbyObservationsSPPLocale :: Maybe SPPLocale

Instances

Read RecentNearbyObservationsOptions

Defined in Data.EBird.CLI

Methods

readsPrec :: Int -> ReadS RecentNearbyObservationsOptions

readList :: ReadS [RecentNearbyObservationsOptions]

readPrec :: ReadPrec RecentNearbyObservationsOptions

readListPrec :: ReadPrec [RecentNearbyObservationsOptions]

Show RecentNearbyObservationsOptions

Defined in Data.EBird.CLI

Methods

showsPrec :: Int -> RecentNearbyObservationsOptions -> ShowS

show :: RecentNearbyObservationsOptions -> String

showList :: [RecentNearbyObservationsOptions] -> ShowS

Eq RecentNearbyObservationsOptions

Defined in Data.EBird.CLI

Methods

(==) :: RecentNearbyObservationsOptions -> RecentNearbyObservationsOptions -> Bool

(/=) :: RecentNearbyObservationsOptions -> RecentNearbyObservationsOptions -> Bool

data RecentNearbySpeciesObservationsOptions

Options for the recent-nearby-species-observations command.

Constructors

RecentNearbySpeciesObservationsOptions

Fields

• recentNearbySpeciesObservationsSpecies :: SpeciesCode
• recentNearbySpeciesObservationsLatitude :: Double
• recentNearbySpeciesObservationsLongitude :: Double
• recentNearbySpeciesObservationsDist :: Maybe Integer
• recentNearbySpeciesObservationsBack :: Maybe Integer
• recentNearbySpeciesObservationsCategories :: Maybe TaxonomyCategories
• recentNearbySpeciesObservationsHotspots :: Maybe Bool
• recentNearbySpeciesObservationsProvisionals :: Maybe Bool
• recentNearbySpeciesObservationsMaxResults :: Maybe Integer
• recentNearbySpeciesObservationsSortBy :: Maybe SortObservationsBy
• recentNearbySpeciesObservationsSPPLocale :: Maybe SPPLocale

Instances

Read RecentNearbySpeciesObservationsOptions

Defined in Data.EBird.CLI

Methods

readsPrec :: Int -> ReadS RecentNearbySpeciesObservationsOptions

readList :: ReadS [RecentNearbySpeciesObservationsOptions]

readPrec :: ReadPrec RecentNearbySpeciesObservationsOptions

readListPrec :: ReadPrec [RecentNearbySpeciesObservationsOptions]

Show RecentNearbySpeciesObservationsOptions

Defined in Data.EBird.CLI

Methods

showsPrec :: Int -> RecentNearbySpeciesObservationsOptions -> ShowS

show :: RecentNearbySpeciesObservationsOptions -> String

showList :: [RecentNearbySpeciesObservationsOptions] -> ShowS

Eq RecentNearbySpeciesObservationsOptions

Defined in Data.EBird.CLI

Methods

(==) :: RecentNearbySpeciesObservationsOptions -> RecentNearbySpeciesObservationsOptions -> Bool

(/=) :: RecentNearbySpeciesObservationsOptions -> RecentNearbySpeciesObservationsOptions -> Bool

data RecentNearestSpeciesObservationsOptions

Options for the recent-nearest-species-observations command.

Constructors

RecentNearestSpeciesObservationsOptions

Fields

• recentNearestSpeciesObservationsSpecies :: SpeciesCode
• recentNearestSpeciesObservationsLatitude :: Double
• recentNearestSpeciesObservationsLongitude :: Double
• recentNearestSpeciesObservationsDist :: Maybe Integer
• recentNearestSpeciesObservationsBack :: Maybe Integer
• recentNearestSpeciesObservationsHotspots :: Maybe Bool
• recentNearestSpeciesObservationsProvisionals :: Maybe Bool
• recentNearestSpeciesObservationsMaxResults :: Maybe Integer
• recentNearestSpeciesObservationsSPPLocale :: Maybe SPPLocale

Instances

Read RecentNearestSpeciesObservationsOptions

Defined in Data.EBird.CLI

Methods

readsPrec :: Int -> ReadS RecentNearestSpeciesObservationsOptions

readList :: ReadS [RecentNearestSpeciesObservationsOptions]

readPrec :: ReadPrec RecentNearestSpeciesObservationsOptions

readListPrec :: ReadPrec [RecentNearestSpeciesObservationsOptions]

Show RecentNearestSpeciesObservationsOptions

Defined in Data.EBird.CLI

Methods

showsPrec :: Int -> RecentNearestSpeciesObservationsOptions -> ShowS

show :: RecentNearestSpeciesObservationsOptions -> String

showList :: [RecentNearestSpeciesObservationsOptions] -> ShowS

Eq RecentNearestSpeciesObservationsOptions

Defined in Data.EBird.CLI

Methods

(==) :: RecentNearestSpeciesObservationsOptions -> RecentNearestSpeciesObservationsOptions -> Bool

(/=) :: RecentNearestSpeciesObservationsOptions -> RecentNearestSpeciesObservationsOptions -> Bool

data RecentNearbyNotableObservationsOptions

Options for the recent-nearby-notable-observations command.

Constructors

RecentNearbyNotableObservationsOptions

Fields

• recentNearbyNotableObservationsLatitude :: Double
• recentNearbyNotableObservationsLongitude :: Double
• recentNearbyNotableObservationsDist :: Maybe Integer
• recentNearbyNotableObservationsDetail :: Maybe DetailLevel
• recentNearbyNotableObservationsBack :: Maybe Integer
• recentNearbyNotableObservationsHotspots :: Maybe Bool
• recentNearbyNotableObservationsMaxResults :: Maybe Integer
• recentNearbyNotableObservationsSPPLocale :: Maybe SPPLocale

Instances

Read RecentNearbyNotableObservationsOptions

Defined in Data.EBird.CLI

Methods

readsPrec :: Int -> ReadS RecentNearbyNotableObservationsOptions

readList :: ReadS [RecentNearbyNotableObservationsOptions]

readPrec :: ReadPrec RecentNearbyNotableObservationsOptions

readListPrec :: ReadPrec [RecentNearbyNotableObservationsOptions]

Show RecentNearbyNotableObservationsOptions

Defined in Data.EBird.CLI

Methods

showsPrec :: Int -> RecentNearbyNotableObservationsOptions -> ShowS

show :: RecentNearbyNotableObservationsOptions -> String

showList :: [RecentNearbyNotableObservationsOptions] -> ShowS

Eq RecentNearbyNotableObservationsOptions

Defined in Data.EBird.CLI

Methods

(==) :: RecentNearbyNotableObservationsOptions -> RecentNearbyNotableObservationsOptions -> Bool

(/=) :: RecentNearbyNotableObservationsOptions -> RecentNearbyNotableObservationsOptions -> Bool

data HistoricalObservationsOptions

Options for the historical-observations command.

Constructors

HistoricalObservationsOptions

Fields

• historicalObservationsRegion :: RegionCode
• historicalObservationsDate :: EBirdDate
• historicalObservationsCategories :: Maybe TaxonomyCategories
• historicalObservationsDetail :: Maybe DetailLevel
• historicalObservationsHotspots :: Maybe Bool
• historicalObservationsProvisionals :: Maybe Bool
• historicalObservationsMaxResults :: Maybe Integer
• historicalObservationsRank :: Maybe SelectObservation
• historicalObservationsSubregions :: Maybe RegionCode
• historicalObservationsSPPLocale :: Maybe SPPLocale

Instances

Read HistoricalObservationsOptions

Defined in Data.EBird.CLI

Methods

readsPrec :: Int -> ReadS HistoricalObservationsOptions

readList :: ReadS [HistoricalObservationsOptions]

readPrec :: ReadPrec HistoricalObservationsOptions

readListPrec :: ReadPrec [HistoricalObservationsOptions]

Show HistoricalObservationsOptions

Defined in Data.EBird.CLI

Methods

showsPrec :: Int -> HistoricalObservationsOptions -> ShowS

show :: HistoricalObservationsOptions -> String

showList :: [HistoricalObservationsOptions] -> ShowS

Eq HistoricalObservationsOptions

Defined in Data.EBird.CLI

Methods

(==) :: HistoricalObservationsOptions -> HistoricalObservationsOptions -> Bool

(/=) :: HistoricalObservationsOptions -> HistoricalObservationsOptions -> Bool

data RecentChecklistsOptions

Options for the recent-checklists command.

Constructors

RecentChecklistsOptions

Fields

• recentChecklistsRegion :: RegionCode
• recentChecklistsMaxResults :: Maybe Integer

Instances

Read RecentChecklistsOptions

Defined in Data.EBird.CLI

Methods

readsPrec :: Int -> ReadS RecentChecklistsOptions

readList :: ReadS [RecentChecklistsOptions]

readPrec :: ReadPrec RecentChecklistsOptions

readListPrec :: ReadPrec [RecentChecklistsOptions]

Show RecentChecklistsOptions

Defined in Data.EBird.CLI

Methods

showsPrec :: Int -> RecentChecklistsOptions -> ShowS

show :: RecentChecklistsOptions -> String

showList :: [RecentChecklistsOptions] -> ShowS

Eq RecentChecklistsOptions

Defined in Data.EBird.CLI

Methods

(==) :: RecentChecklistsOptions -> RecentChecklistsOptions -> Bool

(/=) :: RecentChecklistsOptions -> RecentChecklistsOptions -> Bool

data Top100Options

Options for the top-100 command.

Constructors

Top100Options

Fields

• top100Region :: Region
• top100Date :: EBirdDate
• top100RankedBy :: Maybe RankTop100By
• top100MaxResults :: Maybe Integer

Instances

Read Top100Options

Defined in Data.EBird.CLI

Methods

readsPrec :: Int -> ReadS Top100Options

readList :: ReadS [Top100Options]

readPrec :: ReadPrec Top100Options

readListPrec :: ReadPrec [Top100Options]

Show Top100Options

Defined in Data.EBird.CLI

Methods

showsPrec :: Int -> Top100Options -> ShowS

show :: Top100Options -> String

showList :: [Top100Options] -> ShowS

Eq Top100Options

Defined in Data.EBird.CLI

Methods

(==) :: Top100Options -> Top100Options -> Bool

(/=) :: Top100Options -> Top100Options -> Bool

data ChecklistFeedOptions

Options for the checklist-feed command.

Constructors

ChecklistFeedOptions

Fields

• checklistFeedRegion :: Region
• checklistFeedDate :: EBirdDate
• checklistFeedSortBy :: Maybe SortChecklistsBy
• checklistFeedMaxResults :: Maybe Integer

Instances

Read ChecklistFeedOptions

Defined in Data.EBird.CLI

Methods

readsPrec :: Int -> ReadS ChecklistFeedOptions

readList :: ReadS [ChecklistFeedOptions]

readPrec :: ReadPrec ChecklistFeedOptions

readListPrec :: ReadPrec [ChecklistFeedOptions]

Show ChecklistFeedOptions

Defined in Data.EBird.CLI

Methods

showsPrec :: Int -> ChecklistFeedOptions -> ShowS

show :: ChecklistFeedOptions -> String

showList :: [ChecklistFeedOptions] -> ShowS

Eq ChecklistFeedOptions

Defined in Data.EBird.CLI

Methods

(==) :: ChecklistFeedOptions -> ChecklistFeedOptions -> Bool

(/=) :: ChecklistFeedOptions -> ChecklistFeedOptions -> Bool

data RegionalStatisticsOptions

Options for the regional-statistics command.

Constructors

RegionalStatisticsOptions

Fields

• regionalStatisticsRegion :: Region
• regionalStatisticsDate :: EBirdDate

Instances

Read RegionalStatisticsOptions

Defined in Data.EBird.CLI

Methods

readsPrec :: Int -> ReadS RegionalStatisticsOptions

readList :: ReadS [RegionalStatisticsOptions]

readPrec :: ReadPrec RegionalStatisticsOptions

readListPrec :: ReadPrec [RegionalStatisticsOptions]

Show RegionalStatisticsOptions

Defined in Data.EBird.CLI

Methods

showsPrec :: Int -> RegionalStatisticsOptions -> ShowS

show :: RegionalStatisticsOptions -> String

showList :: [RegionalStatisticsOptions] -> ShowS

Eq RegionalStatisticsOptions

Defined in Data.EBird.CLI

Methods

(==) :: RegionalStatisticsOptions -> RegionalStatisticsOptions -> Bool

(/=) :: RegionalStatisticsOptions -> RegionalStatisticsOptions -> Bool

newtype SpeciesListOptions

Options for the species-list command.

Constructors

SpeciesListOptions

Fields

• speciesListRegion :: Region

Instances

Read SpeciesListOptions

Defined in Data.EBird.CLI

Methods

readsPrec :: Int -> ReadS SpeciesListOptions

readList :: ReadS [SpeciesListOptions]

readPrec :: ReadPrec SpeciesListOptions

readListPrec :: ReadPrec [SpeciesListOptions]

Show SpeciesListOptions

Defined in Data.EBird.CLI

Methods

showsPrec :: Int -> SpeciesListOptions -> ShowS

show :: SpeciesListOptions -> String

showList :: [SpeciesListOptions] -> ShowS

Eq SpeciesListOptions

Defined in Data.EBird.CLI

Methods

(==) :: SpeciesListOptions -> SpeciesListOptions -> Bool

(/=) :: SpeciesListOptions -> SpeciesListOptions -> Bool

newtype ViewChecklistOptions

Options for the view-checklist command.

Constructors

ViewChecklistOptions

Fields

• viewChecklistSubId :: Text

Instances

Read ViewChecklistOptions

Defined in Data.EBird.CLI

Methods

readsPrec :: Int -> ReadS ViewChecklistOptions

readList :: ReadS [ViewChecklistOptions]

readPrec :: ReadPrec ViewChecklistOptions

readListPrec :: ReadPrec [ViewChecklistOptions]

Show ViewChecklistOptions

Defined in Data.EBird.CLI

Methods

showsPrec :: Int -> ViewChecklistOptions -> ShowS

show :: ViewChecklistOptions -> String

showList :: [ViewChecklistOptions] -> ShowS

Eq ViewChecklistOptions

Defined in Data.EBird.CLI

Methods

(==) :: ViewChecklistOptions -> ViewChecklistOptions -> Bool

(/=) :: ViewChecklistOptions -> ViewChecklistOptions -> Bool

data RegionHotspotsOptions

Options for the region-hotspots command.

Constructors

RegionHotspotsOptions

Fields

• regionHotspotsRegion :: RegionCode
• regionHotspotsBack :: Maybe Integer
• regionHotspotsFmt :: Maybe CSVOrJSONFormat

Instances

Read RegionHotspotsOptions

Defined in Data.EBird.CLI

Methods

readsPrec :: Int -> ReadS RegionHotspotsOptions

readList :: ReadS [RegionHotspotsOptions]

readPrec :: ReadPrec RegionHotspotsOptions

readListPrec :: ReadPrec [RegionHotspotsOptions]

Show RegionHotspotsOptions

Defined in Data.EBird.CLI

Methods

showsPrec :: Int -> RegionHotspotsOptions -> ShowS

show :: RegionHotspotsOptions -> String

showList :: [RegionHotspotsOptions] -> ShowS

Eq RegionHotspotsOptions

Defined in Data.EBird.CLI

Methods

(==) :: RegionHotspotsOptions -> RegionHotspotsOptions -> Bool

(/=) :: RegionHotspotsOptions -> RegionHotspotsOptions -> Bool

data NearbyHotspotsOptions

Options for the nearby-hotspots command.

Constructors

NearbyHotspotsOptions

Fields

• nearbyHotspotsLatitude :: Double
• nearbyHotspotsLongitude :: Double
• nearbyHotspotsBack :: Maybe Integer
• nearbyHotspotsDist :: Maybe Integer
• nearbyHotspotsFmt :: Maybe CSVOrJSONFormat

Instances

Read NearbyHotspotsOptions

Defined in Data.EBird.CLI

Methods

readsPrec :: Int -> ReadS NearbyHotspotsOptions

readList :: ReadS [NearbyHotspotsOptions]

readPrec :: ReadPrec NearbyHotspotsOptions

readListPrec :: ReadPrec [NearbyHotspotsOptions]

Show NearbyHotspotsOptions

Defined in Data.EBird.CLI

Methods

showsPrec :: Int -> NearbyHotspotsOptions -> ShowS

show :: NearbyHotspotsOptions -> String

showList :: [NearbyHotspotsOptions] -> ShowS

Eq NearbyHotspotsOptions

Defined in Data.EBird.CLI

Methods

(==) :: NearbyHotspotsOptions -> NearbyHotspotsOptions -> Bool

(/=) :: NearbyHotspotsOptions -> NearbyHotspotsOptions -> Bool

newtype HotspotInfoOptions

Options for the hotspot-info command.

Constructors

HotspotInfoOptions

Fields

• hotspotInfoLocation :: Text

Instances

Read HotspotInfoOptions

Defined in Data.EBird.CLI

Methods

readsPrec :: Int -> ReadS HotspotInfoOptions

readList :: ReadS [HotspotInfoOptions]

readPrec :: ReadPrec HotspotInfoOptions

readListPrec :: ReadPrec [HotspotInfoOptions]

Show HotspotInfoOptions

Defined in Data.EBird.CLI

Methods

showsPrec :: Int -> HotspotInfoOptions -> ShowS

show :: HotspotInfoOptions -> String

showList :: [HotspotInfoOptions] -> ShowS

Eq HotspotInfoOptions

Defined in Data.EBird.CLI

Methods

(==) :: HotspotInfoOptions -> HotspotInfoOptions -> Bool

(/=) :: HotspotInfoOptions -> HotspotInfoOptions -> Bool

data TaxonomyOptions

Options for the nearby-hotspots command.

Constructors

TaxonomyOptions

Fields

• taxonomyTaxonomyCategories :: Maybe TaxonomyCategories
• taxonomyFormat :: Maybe CSVOrJSONFormat
• taxonomySPPLocale :: Maybe SPPLocale
• taxonomySpecies :: Maybe SpeciesCodes
• taxonomyVersion :: Maybe Text

Instances

Read TaxonomyOptions

Defined in Data.EBird.CLI

Methods

readsPrec :: Int -> ReadS TaxonomyOptions

readList :: ReadS [TaxonomyOptions]

readPrec :: ReadPrec TaxonomyOptions

readListPrec :: ReadPrec [TaxonomyOptions]

Show TaxonomyOptions

Defined in Data.EBird.CLI

Methods

showsPrec :: Int -> TaxonomyOptions -> ShowS

show :: TaxonomyOptions -> String

showList :: [TaxonomyOptions] -> ShowS

Eq TaxonomyOptions

Defined in Data.EBird.CLI

Methods

(==) :: TaxonomyOptions -> TaxonomyOptions -> Bool

(/=) :: TaxonomyOptions -> TaxonomyOptions -> Bool

newtype TaxonomicFormsOptions

Options for the taxonomic-forms command.

Constructors

TaxonomicFormsOptions

Fields

• taxonomicFormsSpecies :: SpeciesCode

Instances

Read TaxonomicFormsOptions

Defined in Data.EBird.CLI

Methods

readsPrec :: Int -> ReadS TaxonomicFormsOptions

readList :: ReadS [TaxonomicFormsOptions]

readPrec :: ReadPrec TaxonomicFormsOptions

readListPrec :: ReadPrec [TaxonomicFormsOptions]

Show TaxonomicFormsOptions

Defined in Data.EBird.CLI

Methods

showsPrec :: Int -> TaxonomicFormsOptions -> ShowS

show :: TaxonomicFormsOptions -> String

showList :: [TaxonomicFormsOptions] -> ShowS

Eq TaxonomicFormsOptions

Defined in Data.EBird.CLI

Methods

(==) :: TaxonomicFormsOptions -> TaxonomicFormsOptions -> Bool

(/=) :: TaxonomicFormsOptions -> TaxonomicFormsOptions -> Bool

newtype TaxaLocaleCodesOptions

Options for the taxa-locale-codes command.

Constructors

TaxaLocaleCodesOptions

Fields

• taxaLocaleCodesAcceptLanguage :: Maybe SPPLocale

Instances

Read TaxaLocaleCodesOptions

Defined in Data.EBird.CLI

Methods

readsPrec :: Int -> ReadS TaxaLocaleCodesOptions

readList :: ReadS [TaxaLocaleCodesOptions]

readPrec :: ReadPrec TaxaLocaleCodesOptions

readListPrec :: ReadPrec [TaxaLocaleCodesOptions]

Show TaxaLocaleCodesOptions

Defined in Data.EBird.CLI

Methods

showsPrec :: Int -> TaxaLocaleCodesOptions -> ShowS

show :: TaxaLocaleCodesOptions -> String

showList :: [TaxaLocaleCodesOptions] -> ShowS

Eq TaxaLocaleCodesOptions

Defined in Data.EBird.CLI

Methods

(==) :: TaxaLocaleCodesOptions -> TaxaLocaleCodesOptions -> Bool

(/=) :: TaxaLocaleCodesOptions -> TaxaLocaleCodesOptions -> Bool

data TaxonomicGroupsOptions

Options for the taxonomic-groups command.

Constructors

TaxonomicGroupsOptions

Fields

• taxonomicGroupsSPPGrouping :: SPPGrouping
• taxonomicGroupsSPPLocale :: Maybe SPPLocale

Instances

Read TaxonomicGroupsOptions

Defined in Data.EBird.CLI

Methods

readsPrec :: Int -> ReadS TaxonomicGroupsOptions

readList :: ReadS [TaxonomicGroupsOptions]

readPrec :: ReadPrec TaxonomicGroupsOptions

readListPrec :: ReadPrec [TaxonomicGroupsOptions]

Show TaxonomicGroupsOptions

Defined in Data.EBird.CLI

Methods

showsPrec :: Int -> TaxonomicGroupsOptions -> ShowS

show :: TaxonomicGroupsOptions -> String

showList :: [TaxonomicGroupsOptions] -> ShowS

Eq TaxonomicGroupsOptions

Defined in Data.EBird.CLI

Methods

(==) :: TaxonomicGroupsOptions -> TaxonomicGroupsOptions -> Bool

(/=) :: TaxonomicGroupsOptions -> TaxonomicGroupsOptions -> Bool

data RegionInfoOptions

Options for the region-info command.

Constructors

RegionInfoOptions

Fields

• regionInfoRegion :: Region
• regionInfoRegionNameFormat :: Maybe RegionNameFormat

Instances

Read RegionInfoOptions

Defined in Data.EBird.CLI

Methods

readsPrec :: Int -> ReadS RegionInfoOptions

readList :: ReadS [RegionInfoOptions]

readPrec :: ReadPrec RegionInfoOptions

readListPrec :: ReadPrec [RegionInfoOptions]

Show RegionInfoOptions

Defined in Data.EBird.CLI

Methods

showsPrec :: Int -> RegionInfoOptions -> ShowS

show :: RegionInfoOptions -> String

showList :: [RegionInfoOptions] -> ShowS

Eq RegionInfoOptions

Defined in Data.EBird.CLI

Methods

(==) :: RegionInfoOptions -> RegionInfoOptions -> Bool

(/=) :: RegionInfoOptions -> RegionInfoOptions -> Bool

data SubregionListOptions

Options for the subregions command.

Constructors

SubregionListOptions

Fields

• subregionListParentRegionCode :: RegionCode
• subregionListRegionType :: RegionType

Instances

Read SubregionListOptions

Defined in Data.EBird.CLI

Methods

readsPrec :: Int -> ReadS SubregionListOptions

readList :: ReadS [SubregionListOptions]

readPrec :: ReadPrec SubregionListOptions

readListPrec :: ReadPrec [SubregionListOptions]

Show SubregionListOptions

Defined in Data.EBird.CLI

Methods

showsPrec :: Int -> SubregionListOptions -> ShowS

show :: SubregionListOptions -> String

showList :: [SubregionListOptions] -> ShowS

Eq SubregionListOptions

Defined in Data.EBird.CLI

Methods

(==) :: SubregionListOptions -> SubregionListOptions -> Bool

(/=) :: SubregionListOptions -> SubregionListOptions -> Bool

newtype AdjacentRegionsOptions

Options for the subregions command.

Constructors

AdjacentRegionsOptions

Fields

• adjacentRegionsRegion :: Region

Instances

Read AdjacentRegionsOptions

Defined in Data.EBird.CLI

Methods

readsPrec :: Int -> ReadS AdjacentRegionsOptions

readList :: ReadS [AdjacentRegionsOptions]

readPrec :: ReadPrec AdjacentRegionsOptions

readListPrec :: ReadPrec [AdjacentRegionsOptions]

Show AdjacentRegionsOptions

Defined in Data.EBird.CLI

Methods

showsPrec :: Int -> AdjacentRegionsOptions -> ShowS

show :: AdjacentRegionsOptions -> String

showList :: [AdjacentRegionsOptions] -> ShowS

Eq AdjacentRegionsOptions

Defined in Data.EBird.CLI

Methods

(==) :: AdjacentRegionsOptions -> AdjacentRegionsOptions -> Bool

(/=) :: AdjacentRegionsOptions -> AdjacentRegionsOptions -> Bool

eBirdCommand :: Parser (Maybe Text, EBirdCommand)

Parse a command provided to the ebird CLI.

recentObservationsOptions :: Parser RecentObservationsOptions

Parse the options for the recent-observations command.

recentNotableObservationsOptions :: Parser RecentNotableObservationsOptions

Parse the options for a recent-notable-observations command.

recentSpeciesObservationsOptions :: Parser RecentSpeciesObservationsOptions

Parse the options for a recent-species-observations command.

recentNearbyObservationsOptions :: Parser RecentNearbyObservationsOptions

Parse the options for a recent-nearby-observations command.

recentNearbySpeciesObservationsOptions :: Parser RecentNearbySpeciesObservationsOptions

Parse the options for a recent-nearby-species-observations command.

recentNearestSpeciesObservationsOptions :: Parser RecentNearestSpeciesObservationsOptions

Parse the options for a recent-nearest-species-observations command.

recentNearbyNotableObservationsOptions :: Parser RecentNearbyNotableObservationsOptions

Parse the options for a recent-nearest-species-observations command.

historicalObservationsOptions :: Parser HistoricalObservationsOptions

Parse the options for a historical-observations command.

observationOnlyHotspotsOpt :: Parser Bool

Parse a Bool, intended to be used as an option determining whether to include observations from hotspots in the response.

observationIncludeProvisionalOpt :: Parser Bool

Parse a Bool, intended to be used as an option determining whether to include unreviewed observations in the response.

observationMaxResultsOpt :: Parser Integer

Parse a Integer option indicating the number of results to include in the response.

regionCodeOpt

Arguments

:: String

What are we fetching? (e.g. "observations")

-> Parser RegionCode

Parse a RegionCode as a generic command option, intended for use with the observation commands.

taxonomyCategoriesOpt

Arguments

:: String

String to include after "one or more taxonomy categories to include ..."

-> Parser TaxonomyCategories

Configurable TaxonomyCategories parser

observationSortByOpt :: Parser SortObservationsBy

Parse a SortObservationsBy as an option determining how returned observations will be sorted.

observationDetailLevelOpt :: Parser DetailLevel

Parse a DetailLevel as an option determining the detail level of observations in the result.

extraRegionsOpt :: Parser RegionCode

Parse a RegionCode as extra regions to fetch observations from

recentChecklistsOptions :: Parser RecentChecklistsOptions

Parse the options for a recent-checklists command.

top100Options :: Parser Top100Options

Parse the options for a top-100 command.

checklistFeedOptions :: Parser ChecklistFeedOptions

Parse the options for a top-100 command.

regionalStatisticsOptions :: Parser RegionalStatisticsOptions

Parse the options for a regional-statistics command.

speciesListOptions :: Parser SpeciesListOptions

Parse the options for a regional-statistics command.

viewChecklistOptions :: Parser ViewChecklistOptions

Parse the options for a regional-statistics command.

checklistRegionCodeOpt :: Parser RegionCode

Parse a RegionCode as a generic command option, intended for use with the checklists commands.

checklistMaxResultsOpt :: Parser Integer

Parse a Integer as a generic command option, intended for use with the checklists commands for determining max results to include.

regionHotspotsOptions :: Parser RegionHotspotsOptions

Parse the options for a region-hotspots command.

nearbyHotspotsOptions :: Parser NearbyHotspotsOptions

Parse the options for a nearby-hotspots command.

hotspotInfoOptions :: Parser HotspotInfoOptions

Parse the options for a hotspot-info command.

taxonomyOptions :: Parser TaxonomyOptions

Parse the options for a nearby-hotspots command.

taxonomicFormsOptions :: Parser TaxonomicFormsOptions

Parse the options for a taxonomic-forms command.

taxaLocaleCodesOptions :: Parser TaxaLocaleCodesOptions

Parse the options for a taxa-locale-codes command.

taxonomicGroupsOptions :: Parser TaxonomicGroupsOptions

Parse the options for a taxa-locale-codes command.

regionInfoOptions :: Parser RegionInfoOptions

Parse the options for the region-info command.

subregionListOptions :: Parser SubregionListOptions

Parse the options for the subregions command.

adjacentRegionsOptions :: Parser AdjacentRegionsOptions

Parse the options for the subregions command.

sppLocaleOpt :: String -> Parser SPPLocale

Parse a SPPLocale as a generic command option.

region :: Parser Region

Parse a Region as a generic command option.

regionCode :: Parser RegionCode

Parse a RegionCode as a generic command option.

regionNameFormat :: Parser RegionNameFormat

Parse a RegionNameFormat as a generic command option.

regionType :: Parser RegionType

Parse a RegionType as a generic command option.

speciesCodeOpt :: String -> Parser SpeciesCode

Configurable SpeciesCode option

searchRadiusOpt

Arguments

:: String

What are we searching for (e.g. "observations")

-> Integer

Maximum allowed value by the API

-> Maybe Integer

Default value of the API (Nothing for "no limit")

-> Parser Integer

Configurable "search radius" option

backOpt

Arguments

:: String

What are we fetching (e.g. "hotspots")

-> String

Verb we are filtering on (e.g. "submitted", or "visited")

-> Maybe Integer

Default value (Nothing for "no limit")

-> Parser Integer

Configurable "back" option

latLngOpt

Arguments

:: String

"latitude" or "longitude"

-> String

What are we looking for

-> Parser Double

Configurable lat/lng option

attoReadM :: Parser a -> ReadM a

Convert an attoparsec parser into an optparse-applicative parser.