Copyright	(c) 2023 Finley McIlwaine
License	MIT (see LICENSE)
Maintainer	Finley McIlwaine <finleymcilwaine@gmail.com>
Safe Haskell	Safe-Inferred
Language	Haskell2010

Data.EBird.CLI

Description

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

Synopsis

eBirdCli :: IO ()
readEBirdAPIKey :: IO (Maybe Text)
runEBirdCommand :: IO Text -> EBirdCommand -> IO ()
printResJSON :: ToJSON a => a -> IO ()
eBirdFail :: String -> IO a
data EBirdCommand
- = 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
data RecentObservationsOptions = RecentObservationsOptions {
- recentObservationsRegion :: RegionCode
- recentObservationsBack :: Maybe Integer
- recentObservationsCategories :: Maybe TaxonomyCategories
- recentObservationsHotspots :: Maybe Bool
- recentObservationsProvisionals :: Maybe Bool
- recentObservationsMaxResults :: Maybe Integer
- recentObservationsSubregions :: Maybe RegionCode
- recentObservationsSPPLocale :: Maybe SPPLocale
}
data RecentNotableObservationsOptions = RecentNotableObservationsOptions {
- recentNotableObservationsRegion :: RegionCode
- recentNotableObservationsBack :: Maybe Integer
- recentNotableObservationsDetail :: Maybe DetailLevel
- recentNotableObservationsHotspots :: Maybe Bool
- recentNotableObservationsMaxResults :: Maybe Integer
- recentNotableObservationsSubregions :: Maybe RegionCode
- recentNotableObservationsSPPLocale :: Maybe SPPLocale
}
data RecentSpeciesObservationsOptions = RecentSpeciesObservationsOptions {
- recentSpeciesObservationsRegion :: RegionCode
- recentSpeciesObservationsSpecies :: SpeciesCode
- recentSpeciesObservationsBack :: Maybe Integer
- recentSpeciesObservationsHotspots :: Maybe Bool
- recentSpeciesObservationsProvisionals :: Maybe Bool
- recentSpeciesObservationsMaxResults :: Maybe Integer
- recentSpeciesObservationsSubregions :: Maybe RegionCode
- recentSpeciesObservationsSPPLocale :: Maybe SPPLocale
}
data RecentNearbyObservationsOptions = RecentNearbyObservationsOptions {
- 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
}
data RecentNearbySpeciesObservationsOptions = RecentNearbySpeciesObservationsOptions {
- 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
}
data RecentNearestSpeciesObservationsOptions = RecentNearestSpeciesObservationsOptions {
- recentNearestSpeciesObservationsSpecies :: SpeciesCode
- recentNearestSpeciesObservationsLatitude :: Double
- recentNearestSpeciesObservationsLongitude :: Double
- recentNearestSpeciesObservationsDist :: Maybe Integer
- recentNearestSpeciesObservationsBack :: Maybe Integer
- recentNearestSpeciesObservationsHotspots :: Maybe Bool
- recentNearestSpeciesObservationsProvisionals :: Maybe Bool
- recentNearestSpeciesObservationsMaxResults :: Maybe Integer
- recentNearestSpeciesObservationsSPPLocale :: Maybe SPPLocale
}
data RecentNearbyNotableObservationsOptions = RecentNearbyNotableObservationsOptions {
- recentNearbyNotableObservationsLatitude :: Double
- recentNearbyNotableObservationsLongitude :: Double
- recentNearbyNotableObservationsDist :: Maybe Integer
- recentNearbyNotableObservationsDetail :: Maybe DetailLevel
- recentNearbyNotableObservationsBack :: Maybe Integer
- recentNearbyNotableObservationsHotspots :: Maybe Bool
- recentNearbyNotableObservationsMaxResults :: Maybe Integer
- recentNearbyNotableObservationsSPPLocale :: Maybe SPPLocale
}
data HistoricalObservationsOptions = HistoricalObservationsOptions {
- 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
}
data RecentChecklistsOptions = RecentChecklistsOptions {
- recentChecklistsRegion :: RegionCode
- recentChecklistsMaxResults :: Maybe Integer
}
data Top100Options = Top100Options {
- top100Region :: Region
- top100Date :: EBirdDate
- top100RankedBy :: Maybe RankTop100By
- top100MaxResults :: Maybe Integer
}
data ChecklistFeedOptions = ChecklistFeedOptions {
- checklistFeedRegion :: Region
- checklistFeedDate :: EBirdDate
- checklistFeedSortBy :: Maybe SortChecklistsBy
- checklistFeedMaxResults :: Maybe Integer
}
data RegionalStatisticsOptions = RegionalStatisticsOptions {
- regionalStatisticsRegion :: Region
- regionalStatisticsDate :: EBirdDate
}
newtype SpeciesListOptions = SpeciesListOptions {
- speciesListRegion :: Region
}
newtype ViewChecklistOptions = ViewChecklistOptions {
- viewChecklistSubId :: Text
}
data RegionHotspotsOptions = RegionHotspotsOptions {
- regionHotspotsRegion :: RegionCode
- regionHotspotsBack :: Maybe Integer
- regionHotspotsFmt :: Maybe CSVOrJSONFormat
}
data NearbyHotspotsOptions = NearbyHotspotsOptions {
- nearbyHotspotsLatitude :: Double
- nearbyHotspotsLongitude :: Double
- nearbyHotspotsBack :: Maybe Integer
- nearbyHotspotsDist :: Maybe Integer
- nearbyHotspotsFmt :: Maybe CSVOrJSONFormat
}
newtype HotspotInfoOptions = HotspotInfoOptions {
- hotspotInfoLocation :: Text
}
data TaxonomyOptions = TaxonomyOptions {
- taxonomyTaxonomyCategories :: Maybe TaxonomyCategories
- taxonomyFormat :: Maybe CSVOrJSONFormat
- taxonomySPPLocale :: Maybe SPPLocale
- taxonomySpecies :: Maybe SpeciesCodes
- taxonomyVersion :: Maybe Text
}
newtype TaxonomicFormsOptions = TaxonomicFormsOptions {
- taxonomicFormsSpecies :: SpeciesCode
}
newtype TaxaLocaleCodesOptions = TaxaLocaleCodesOptions {
- taxaLocaleCodesAcceptLanguage :: Maybe SPPLocale
}
data TaxonomicGroupsOptions = TaxonomicGroupsOptions {
- taxonomicGroupsSPPGrouping :: SPPGrouping
- taxonomicGroupsSPPLocale :: Maybe SPPLocale
}
data RegionInfoOptions = RegionInfoOptions {
- regionInfoRegion :: Region
- regionInfoRegionNameFormat :: Maybe RegionNameFormat
}
data SubregionListOptions = SubregionListOptions {
- subregionListParentRegionCode :: RegionCode
- subregionListRegionType :: RegionType
}
newtype AdjacentRegionsOptions = AdjacentRegionsOptions {
- adjacentRegionsRegion :: Region
}
eBirdCommand :: Parser (Maybe Text, EBirdCommand)
recentObservationsOptions :: Parser RecentObservationsOptions
recentNotableObservationsOptions :: Parser RecentNotableObservationsOptions
recentSpeciesObservationsOptions :: Parser RecentSpeciesObservationsOptions
recentNearbyObservationsOptions :: Parser RecentNearbyObservationsOptions
recentNearbySpeciesObservationsOptions :: Parser RecentNearbySpeciesObservationsOptions
recentNearestSpeciesObservationsOptions :: Parser RecentNearestSpeciesObservationsOptions
recentNearbyNotableObservationsOptions :: Parser RecentNearbyNotableObservationsOptions
historicalObservationsOptions :: Parser HistoricalObservationsOptions
observationOnlyHotspotsOpt :: Parser Bool
observationIncludeProvisionalOpt :: Parser Bool
observationMaxResultsOpt :: Parser Integer
regionCodeOpt :: String -> Parser RegionCode
taxonomyCategoriesOpt :: String -> Parser TaxonomyCategories
observationSortByOpt :: Parser SortObservationsBy
observationDetailLevelOpt :: Parser DetailLevel
extraRegionsOpt :: Parser RegionCode
recentChecklistsOptions :: Parser RecentChecklistsOptions
top100Options :: Parser Top100Options
checklistFeedOptions :: Parser ChecklistFeedOptions
regionalStatisticsOptions :: Parser RegionalStatisticsOptions
speciesListOptions :: Parser SpeciesListOptions
viewChecklistOptions :: Parser ViewChecklistOptions
checklistRegionCodeOpt :: Parser RegionCode
checklistMaxResultsOpt :: Parser Integer
regionHotspotsOptions :: Parser RegionHotspotsOptions
nearbyHotspotsOptions :: Parser NearbyHotspotsOptions
hotspotInfoOptions :: Parser HotspotInfoOptions
taxonomyOptions :: Parser TaxonomyOptions
taxonomicFormsOptions :: Parser TaxonomicFormsOptions
taxaLocaleCodesOptions :: Parser TaxaLocaleCodesOptions
taxonomicGroupsOptions :: Parser TaxonomicGroupsOptions
regionInfoOptions :: Parser RegionInfoOptions
subregionListOptions :: Parser SubregionListOptions
adjacentRegionsOptions :: Parser AdjacentRegionsOptions
sppLocaleOpt :: String -> Parser SPPLocale
region :: Parser Region
regionCode :: Parser RegionCode
regionNameFormat :: Parser RegionNameFormat
regionType :: Parser RegionType
speciesCodeOpt :: String -> Parser SpeciesCode
searchRadiusOpt :: String -> Integer -> Maybe Integer -> Parser Integer
backOpt :: String -> String -> Maybe Integer -> Parser Integer
latLngOpt :: String -> String -> Parser Double
attoReadM :: Parser a -> ReadM a

Documentation

eBirdCli :: IO () Source #

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) Source #

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 Source #

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 () Source #

Simply prints a value as prettified JSON

eBirdFail :: String -> IO a Source #

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

data EBirdCommand Source #

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

Instances details

Show EBirdCommand Source #
Instance details Defined in Data.EBird.CLI Methods showsPrec :: Int -> EBirdCommand -> ShowS # show :: EBirdCommand -> String # showList :: [EBirdCommand] -> ShowS #
Eq EBirdCommand Source #
Instance details Defined in Data.EBird.CLI Methods (==) :: EBirdCommand -> EBirdCommand -> Bool # (/=) :: EBirdCommand -> EBirdCommand -> Bool #

data RecentObservationsOptions Source #

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

Instances details

Read RecentObservationsOptions Source #
Instance details Defined in Data.EBird.CLI Methods readsPrec :: Int -> ReadS RecentObservationsOptions # readList :: ReadS [RecentObservationsOptions] # readPrec :: ReadPrec RecentObservationsOptions # readListPrec :: ReadPrec [RecentObservationsOptions] #
Show RecentObservationsOptions Source #
Instance details Defined in Data.EBird.CLI Methods showsPrec :: Int -> RecentObservationsOptions -> ShowS # show :: RecentObservationsOptions -> String # showList :: [RecentObservationsOptions] -> ShowS #
Eq RecentObservationsOptions Source #
Instance details Defined in Data.EBird.CLI Methods (==) :: RecentObservationsOptions -> RecentObservationsOptions -> Bool # (/=) :: RecentObservationsOptions -> RecentObservationsOptions -> Bool #

data RecentNotableObservationsOptions Source #

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

Instances details

Read RecentNotableObservationsOptions Source #
Instance details Defined in Data.EBird.CLI Methods readsPrec :: Int -> ReadS RecentNotableObservationsOptions # readList :: ReadS [RecentNotableObservationsOptions] # readPrec :: ReadPrec RecentNotableObservationsOptions # readListPrec :: ReadPrec [RecentNotableObservationsOptions] #
Show RecentNotableObservationsOptions Source #
Instance details Defined in Data.EBird.CLI Methods showsPrec :: Int -> RecentNotableObservationsOptions -> ShowS # show :: RecentNotableObservationsOptions -> String # showList :: [RecentNotableObservationsOptions] -> ShowS #
Eq RecentNotableObservationsOptions Source #
Instance details Defined in Data.EBird.CLI Methods (==) :: RecentNotableObservationsOptions -> RecentNotableObservationsOptions -> Bool # (/=) :: RecentNotableObservationsOptions -> RecentNotableObservationsOptions -> Bool #

data RecentSpeciesObservationsOptions Source #

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

Instances details

Read RecentSpeciesObservationsOptions Source #
Instance details Defined in Data.EBird.CLI Methods readsPrec :: Int -> ReadS RecentSpeciesObservationsOptions # readList :: ReadS [RecentSpeciesObservationsOptions] # readPrec :: ReadPrec RecentSpeciesObservationsOptions # readListPrec :: ReadPrec [RecentSpeciesObservationsOptions] #
Show RecentSpeciesObservationsOptions Source #
Instance details Defined in Data.EBird.CLI Methods showsPrec :: Int -> RecentSpeciesObservationsOptions -> ShowS # show :: RecentSpeciesObservationsOptions -> String # showList :: [RecentSpeciesObservationsOptions] -> ShowS #
Eq RecentSpeciesObservationsOptions Source #
Instance details Defined in Data.EBird.CLI Methods (==) :: RecentSpeciesObservationsOptions -> RecentSpeciesObservationsOptions -> Bool # (/=) :: RecentSpeciesObservationsOptions -> RecentSpeciesObservationsOptions -> Bool #

data RecentNearbyObservationsOptions Source #

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

Instances details

Read RecentNearbyObservationsOptions Source #
Instance details Defined in Data.EBird.CLI Methods readsPrec :: Int -> ReadS RecentNearbyObservationsOptions # readList :: ReadS [RecentNearbyObservationsOptions] # readPrec :: ReadPrec RecentNearbyObservationsOptions # readListPrec :: ReadPrec [RecentNearbyObservationsOptions] #
Show RecentNearbyObservationsOptions Source #
Instance details Defined in Data.EBird.CLI Methods showsPrec :: Int -> RecentNearbyObservationsOptions -> ShowS # show :: RecentNearbyObservationsOptions -> String # showList :: [RecentNearbyObservationsOptions] -> ShowS #
Eq RecentNearbyObservationsOptions Source #
Instance details Defined in Data.EBird.CLI Methods (==) :: RecentNearbyObservationsOptions -> RecentNearbyObservationsOptions -> Bool # (/=) :: RecentNearbyObservationsOptions -> RecentNearbyObservationsOptions -> Bool #

data RecentNearbySpeciesObservationsOptions Source #

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

Instances details

Read RecentNearbySpeciesObservationsOptions Source #
Instance details Defined in Data.EBird.CLI Methods readsPrec :: Int -> ReadS RecentNearbySpeciesObservationsOptions # readList :: ReadS [RecentNearbySpeciesObservationsOptions] # readPrec :: ReadPrec RecentNearbySpeciesObservationsOptions # readListPrec :: ReadPrec [RecentNearbySpeciesObservationsOptions] #
Show RecentNearbySpeciesObservationsOptions Source #
Instance details Defined in Data.EBird.CLI Methods showsPrec :: Int -> RecentNearbySpeciesObservationsOptions -> ShowS # show :: RecentNearbySpeciesObservationsOptions -> String # showList :: [RecentNearbySpeciesObservationsOptions] -> ShowS #
Eq RecentNearbySpeciesObservationsOptions Source #
Instance details Defined in Data.EBird.CLI Methods (==) :: RecentNearbySpeciesObservationsOptions -> RecentNearbySpeciesObservationsOptions -> Bool # (/=) :: RecentNearbySpeciesObservationsOptions -> RecentNearbySpeciesObservationsOptions -> Bool #

data RecentNearestSpeciesObservationsOptions Source #

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

Instances

Instances details

Read RecentNearestSpeciesObservationsOptions Source #
Instance details Defined in Data.EBird.CLI Methods readsPrec :: Int -> ReadS RecentNearestSpeciesObservationsOptions # readList :: ReadS [RecentNearestSpeciesObservationsOptions] # readPrec :: ReadPrec RecentNearestSpeciesObservationsOptions # readListPrec :: ReadPrec [RecentNearestSpeciesObservationsOptions] #
Show RecentNearestSpeciesObservationsOptions Source #
Instance details Defined in Data.EBird.CLI Methods showsPrec :: Int -> RecentNearestSpeciesObservationsOptions -> ShowS # show :: RecentNearestSpeciesObservationsOptions -> String # showList :: [RecentNearestSpeciesObservationsOptions] -> ShowS #
Eq RecentNearestSpeciesObservationsOptions Source #
Instance details Defined in Data.EBird.CLI Methods (==) :: RecentNearestSpeciesObservationsOptions -> RecentNearestSpeciesObservationsOptions -> Bool # (/=) :: RecentNearestSpeciesObservationsOptions -> RecentNearestSpeciesObservationsOptions -> Bool #

data RecentNearbyNotableObservationsOptions Source #

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

Instances

Instances details

Read RecentNearbyNotableObservationsOptions Source #
Instance details Defined in Data.EBird.CLI Methods readsPrec :: Int -> ReadS RecentNearbyNotableObservationsOptions # readList :: ReadS [RecentNearbyNotableObservationsOptions] # readPrec :: ReadPrec RecentNearbyNotableObservationsOptions # readListPrec :: ReadPrec [RecentNearbyNotableObservationsOptions] #
Show RecentNearbyNotableObservationsOptions Source #
Instance details Defined in Data.EBird.CLI Methods showsPrec :: Int -> RecentNearbyNotableObservationsOptions -> ShowS # show :: RecentNearbyNotableObservationsOptions -> String # showList :: [RecentNearbyNotableObservationsOptions] -> ShowS #
Eq RecentNearbyNotableObservationsOptions Source #
Instance details Defined in Data.EBird.CLI Methods (==) :: RecentNearbyNotableObservationsOptions -> RecentNearbyNotableObservationsOptions -> Bool # (/=) :: RecentNearbyNotableObservationsOptions -> RecentNearbyNotableObservationsOptions -> Bool #

data HistoricalObservationsOptions Source #

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

Instances details

Read HistoricalObservationsOptions Source #
Instance details Defined in Data.EBird.CLI Methods readsPrec :: Int -> ReadS HistoricalObservationsOptions # readList :: ReadS [HistoricalObservationsOptions] # readPrec :: ReadPrec HistoricalObservationsOptions # readListPrec :: ReadPrec [HistoricalObservationsOptions] #
Show HistoricalObservationsOptions Source #
Instance details Defined in Data.EBird.CLI Methods showsPrec :: Int -> HistoricalObservationsOptions -> ShowS # show :: HistoricalObservationsOptions -> String # showList :: [HistoricalObservationsOptions] -> ShowS #
Eq HistoricalObservationsOptions Source #
Instance details Defined in Data.EBird.CLI Methods (==) :: HistoricalObservationsOptions -> HistoricalObservationsOptions -> Bool # (/=) :: HistoricalObservationsOptions -> HistoricalObservationsOptions -> Bool #

data RecentChecklistsOptions Source #

Options for the recent-checklists command.

Constructors

RecentChecklistsOptions
Fields recentChecklistsRegion :: RegionCode recentChecklistsMaxResults :: Maybe Integer

Instances

Instances details

Read RecentChecklistsOptions Source #
Instance details Defined in Data.EBird.CLI Methods readsPrec :: Int -> ReadS RecentChecklistsOptions # readList :: ReadS [RecentChecklistsOptions] # readPrec :: ReadPrec RecentChecklistsOptions # readListPrec :: ReadPrec [RecentChecklistsOptions] #
Show RecentChecklistsOptions Source #
Instance details Defined in Data.EBird.CLI Methods showsPrec :: Int -> RecentChecklistsOptions -> ShowS # show :: RecentChecklistsOptions -> String # showList :: [RecentChecklistsOptions] -> ShowS #
Eq RecentChecklistsOptions Source #
Instance details Defined in Data.EBird.CLI Methods (==) :: RecentChecklistsOptions -> RecentChecklistsOptions -> Bool # (/=) :: RecentChecklistsOptions -> RecentChecklistsOptions -> Bool #

data Top100Options Source #

Options for the top-100 command.

Constructors

Top100Options
Fields top100Region :: Region top100Date :: EBirdDate top100RankedBy :: Maybe RankTop100By top100MaxResults :: Maybe Integer

Instances

Instances details

Read Top100Options Source #
Instance details Defined in Data.EBird.CLI Methods readsPrec :: Int -> ReadS Top100Options # readList :: ReadS [Top100Options] # readPrec :: ReadPrec Top100Options # readListPrec :: ReadPrec [Top100Options] #
Show Top100Options Source #
Instance details Defined in Data.EBird.CLI Methods showsPrec :: Int -> Top100Options -> ShowS # show :: Top100Options -> String # showList :: [Top100Options] -> ShowS #
Eq Top100Options Source #
Instance details Defined in Data.EBird.CLI Methods (==) :: Top100Options -> Top100Options -> Bool # (/=) :: Top100Options -> Top100Options -> Bool #

data ChecklistFeedOptions Source #

Options for the checklist-feed command.

Constructors

ChecklistFeedOptions
Fields checklistFeedRegion :: Region checklistFeedDate :: EBirdDate checklistFeedSortBy :: Maybe SortChecklistsBy checklistFeedMaxResults :: Maybe Integer

Instances

Instances details

Read ChecklistFeedOptions Source #
Instance details Defined in Data.EBird.CLI Methods readsPrec :: Int -> ReadS ChecklistFeedOptions # readList :: ReadS [ChecklistFeedOptions] # readPrec :: ReadPrec ChecklistFeedOptions # readListPrec :: ReadPrec [ChecklistFeedOptions] #
Show ChecklistFeedOptions Source #
Instance details Defined in Data.EBird.CLI Methods showsPrec :: Int -> ChecklistFeedOptions -> ShowS # show :: ChecklistFeedOptions -> String # showList :: [ChecklistFeedOptions] -> ShowS #
Eq ChecklistFeedOptions Source #
Instance details Defined in Data.EBird.CLI Methods (==) :: ChecklistFeedOptions -> ChecklistFeedOptions -> Bool # (/=) :: ChecklistFeedOptions -> ChecklistFeedOptions -> Bool #

data RegionalStatisticsOptions Source #

Options for the regional-statistics command.

Constructors

RegionalStatisticsOptions
Fields regionalStatisticsRegion :: Region regionalStatisticsDate :: EBirdDate

Instances

Instances details

Read RegionalStatisticsOptions Source #
Instance details Defined in Data.EBird.CLI Methods readsPrec :: Int -> ReadS RegionalStatisticsOptions # readList :: ReadS [RegionalStatisticsOptions] # readPrec :: ReadPrec RegionalStatisticsOptions # readListPrec :: ReadPrec [RegionalStatisticsOptions] #
Show RegionalStatisticsOptions Source #
Instance details Defined in Data.EBird.CLI Methods showsPrec :: Int -> RegionalStatisticsOptions -> ShowS # show :: RegionalStatisticsOptions -> String # showList :: [RegionalStatisticsOptions] -> ShowS #
Eq RegionalStatisticsOptions Source #
Instance details Defined in Data.EBird.CLI Methods (==) :: RegionalStatisticsOptions -> RegionalStatisticsOptions -> Bool # (/=) :: RegionalStatisticsOptions -> RegionalStatisticsOptions -> Bool #

newtype SpeciesListOptions Source #

Options for the species-list command.

Constructors

SpeciesListOptions
Fields speciesListRegion :: Region

Instances

Instances details

Read SpeciesListOptions Source #
Instance details Defined in Data.EBird.CLI Methods readsPrec :: Int -> ReadS SpeciesListOptions # readList :: ReadS [SpeciesListOptions] # readPrec :: ReadPrec SpeciesListOptions # readListPrec :: ReadPrec [SpeciesListOptions] #
Show SpeciesListOptions Source #
Instance details Defined in Data.EBird.CLI Methods showsPrec :: Int -> SpeciesListOptions -> ShowS # show :: SpeciesListOptions -> String # showList :: [SpeciesListOptions] -> ShowS #
Eq SpeciesListOptions Source #
Instance details Defined in Data.EBird.CLI Methods (==) :: SpeciesListOptions -> SpeciesListOptions -> Bool # (/=) :: SpeciesListOptions -> SpeciesListOptions -> Bool #

newtype ViewChecklistOptions Source #

Options for the view-checklist command.

Constructors

ViewChecklistOptions
Fields viewChecklistSubId :: Text

Instances

Instances details

Read ViewChecklistOptions Source #
Instance details Defined in Data.EBird.CLI Methods readsPrec :: Int -> ReadS ViewChecklistOptions # readList :: ReadS [ViewChecklistOptions] # readPrec :: ReadPrec ViewChecklistOptions # readListPrec :: ReadPrec [ViewChecklistOptions] #
Show ViewChecklistOptions Source #
Instance details Defined in Data.EBird.CLI Methods showsPrec :: Int -> ViewChecklistOptions -> ShowS # show :: ViewChecklistOptions -> String # showList :: [ViewChecklistOptions] -> ShowS #
Eq ViewChecklistOptions Source #
Instance details Defined in Data.EBird.CLI Methods (==) :: ViewChecklistOptions -> ViewChecklistOptions -> Bool # (/=) :: ViewChecklistOptions -> ViewChecklistOptions -> Bool #

data RegionHotspotsOptions Source #

Options for the region-hotspots command.

Constructors

RegionHotspotsOptions
Fields regionHotspotsRegion :: RegionCode regionHotspotsBack :: Maybe Integer regionHotspotsFmt :: Maybe CSVOrJSONFormat

Instances

Instances details

Read RegionHotspotsOptions Source #
Instance details Defined in Data.EBird.CLI Methods readsPrec :: Int -> ReadS RegionHotspotsOptions # readList :: ReadS [RegionHotspotsOptions] # readPrec :: ReadPrec RegionHotspotsOptions # readListPrec :: ReadPrec [RegionHotspotsOptions] #
Show RegionHotspotsOptions Source #
Instance details Defined in Data.EBird.CLI Methods showsPrec :: Int -> RegionHotspotsOptions -> ShowS # show :: RegionHotspotsOptions -> String # showList :: [RegionHotspotsOptions] -> ShowS #
Eq RegionHotspotsOptions Source #
Instance details Defined in Data.EBird.CLI Methods (==) :: RegionHotspotsOptions -> RegionHotspotsOptions -> Bool # (/=) :: RegionHotspotsOptions -> RegionHotspotsOptions -> Bool #

data NearbyHotspotsOptions Source #

Options for the nearby-hotspots command.

Constructors

NearbyHotspotsOptions
Fields nearbyHotspotsLatitude :: Double nearbyHotspotsLongitude :: Double nearbyHotspotsBack :: Maybe Integer nearbyHotspotsDist :: Maybe Integer nearbyHotspotsFmt :: Maybe CSVOrJSONFormat

Instances

Instances details

Read NearbyHotspotsOptions Source #
Instance details Defined in Data.EBird.CLI Methods readsPrec :: Int -> ReadS NearbyHotspotsOptions # readList :: ReadS [NearbyHotspotsOptions] # readPrec :: ReadPrec NearbyHotspotsOptions # readListPrec :: ReadPrec [NearbyHotspotsOptions] #
Show NearbyHotspotsOptions Source #
Instance details Defined in Data.EBird.CLI Methods showsPrec :: Int -> NearbyHotspotsOptions -> ShowS # show :: NearbyHotspotsOptions -> String # showList :: [NearbyHotspotsOptions] -> ShowS #
Eq NearbyHotspotsOptions Source #
Instance details Defined in Data.EBird.CLI Methods (==) :: NearbyHotspotsOptions -> NearbyHotspotsOptions -> Bool # (/=) :: NearbyHotspotsOptions -> NearbyHotspotsOptions -> Bool #

newtype HotspotInfoOptions Source #

Options for the hotspot-info command.

Constructors

HotspotInfoOptions
Fields hotspotInfoLocation :: Text

Instances

Instances details

Read HotspotInfoOptions Source #
Instance details Defined in Data.EBird.CLI Methods readsPrec :: Int -> ReadS HotspotInfoOptions # readList :: ReadS [HotspotInfoOptions] # readPrec :: ReadPrec HotspotInfoOptions # readListPrec :: ReadPrec [HotspotInfoOptions] #
Show HotspotInfoOptions Source #
Instance details Defined in Data.EBird.CLI Methods showsPrec :: Int -> HotspotInfoOptions -> ShowS # show :: HotspotInfoOptions -> String # showList :: [HotspotInfoOptions] -> ShowS #
Eq HotspotInfoOptions Source #
Instance details Defined in Data.EBird.CLI Methods (==) :: HotspotInfoOptions -> HotspotInfoOptions -> Bool # (/=) :: HotspotInfoOptions -> HotspotInfoOptions -> Bool #

data TaxonomyOptions Source #

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

Instances details

Read TaxonomyOptions Source #
Instance details Defined in Data.EBird.CLI Methods readsPrec :: Int -> ReadS TaxonomyOptions # readList :: ReadS [TaxonomyOptions] # readPrec :: ReadPrec TaxonomyOptions # readListPrec :: ReadPrec [TaxonomyOptions] #
Show TaxonomyOptions Source #
Instance details Defined in Data.EBird.CLI Methods showsPrec :: Int -> TaxonomyOptions -> ShowS # show :: TaxonomyOptions -> String # showList :: [TaxonomyOptions] -> ShowS #
Eq TaxonomyOptions Source #
Instance details Defined in Data.EBird.CLI Methods (==) :: TaxonomyOptions -> TaxonomyOptions -> Bool # (/=) :: TaxonomyOptions -> TaxonomyOptions -> Bool #

newtype TaxonomicFormsOptions Source #

Options for the taxonomic-forms command.

Constructors

TaxonomicFormsOptions
Fields taxonomicFormsSpecies :: SpeciesCode

Instances

Instances details

Read TaxonomicFormsOptions Source #
Instance details Defined in Data.EBird.CLI Methods readsPrec :: Int -> ReadS TaxonomicFormsOptions # readList :: ReadS [TaxonomicFormsOptions] # readPrec :: ReadPrec TaxonomicFormsOptions # readListPrec :: ReadPrec [TaxonomicFormsOptions] #
Show TaxonomicFormsOptions Source #
Instance details Defined in Data.EBird.CLI Methods showsPrec :: Int -> TaxonomicFormsOptions -> ShowS # show :: TaxonomicFormsOptions -> String # showList :: [TaxonomicFormsOptions] -> ShowS #
Eq TaxonomicFormsOptions Source #
Instance details Defined in Data.EBird.CLI Methods (==) :: TaxonomicFormsOptions -> TaxonomicFormsOptions -> Bool # (/=) :: TaxonomicFormsOptions -> TaxonomicFormsOptions -> Bool #

newtype TaxaLocaleCodesOptions Source #

Options for the taxa-locale-codes command.

Constructors

TaxaLocaleCodesOptions
Fields taxaLocaleCodesAcceptLanguage :: Maybe SPPLocale

Instances

Instances details

Read TaxaLocaleCodesOptions Source #
Instance details Defined in Data.EBird.CLI Methods readsPrec :: Int -> ReadS TaxaLocaleCodesOptions # readList :: ReadS [TaxaLocaleCodesOptions] # readPrec :: ReadPrec TaxaLocaleCodesOptions # readListPrec :: ReadPrec [TaxaLocaleCodesOptions] #
Show TaxaLocaleCodesOptions Source #
Instance details Defined in Data.EBird.CLI Methods showsPrec :: Int -> TaxaLocaleCodesOptions -> ShowS # show :: TaxaLocaleCodesOptions -> String # showList :: [TaxaLocaleCodesOptions] -> ShowS #
Eq TaxaLocaleCodesOptions Source #
Instance details Defined in Data.EBird.CLI Methods (==) :: TaxaLocaleCodesOptions -> TaxaLocaleCodesOptions -> Bool # (/=) :: TaxaLocaleCodesOptions -> TaxaLocaleCodesOptions -> Bool #

data TaxonomicGroupsOptions Source #

Options for the taxonomic-groups command.

Constructors

TaxonomicGroupsOptions
Fields taxonomicGroupsSPPGrouping :: SPPGrouping taxonomicGroupsSPPLocale :: Maybe SPPLocale

Instances

Instances details

Read TaxonomicGroupsOptions Source #
Instance details Defined in Data.EBird.CLI Methods readsPrec :: Int -> ReadS TaxonomicGroupsOptions # readList :: ReadS [TaxonomicGroupsOptions] # readPrec :: ReadPrec TaxonomicGroupsOptions # readListPrec :: ReadPrec [TaxonomicGroupsOptions] #
Show TaxonomicGroupsOptions Source #
Instance details Defined in Data.EBird.CLI Methods showsPrec :: Int -> TaxonomicGroupsOptions -> ShowS # show :: TaxonomicGroupsOptions -> String # showList :: [TaxonomicGroupsOptions] -> ShowS #
Eq TaxonomicGroupsOptions Source #
Instance details Defined in Data.EBird.CLI Methods (==) :: TaxonomicGroupsOptions -> TaxonomicGroupsOptions -> Bool # (/=) :: TaxonomicGroupsOptions -> TaxonomicGroupsOptions -> Bool #

data RegionInfoOptions Source #

Options for the region-info command.

Constructors

RegionInfoOptions
Fields regionInfoRegion :: Region regionInfoRegionNameFormat :: Maybe RegionNameFormat

Instances

Instances details

Read RegionInfoOptions Source #
Instance details Defined in Data.EBird.CLI Methods readsPrec :: Int -> ReadS RegionInfoOptions # readList :: ReadS [RegionInfoOptions] # readPrec :: ReadPrec RegionInfoOptions # readListPrec :: ReadPrec [RegionInfoOptions] #
Show RegionInfoOptions Source #
Instance details Defined in Data.EBird.CLI Methods showsPrec :: Int -> RegionInfoOptions -> ShowS # show :: RegionInfoOptions -> String # showList :: [RegionInfoOptions] -> ShowS #
Eq RegionInfoOptions Source #
Instance details Defined in Data.EBird.CLI Methods (==) :: RegionInfoOptions -> RegionInfoOptions -> Bool # (/=) :: RegionInfoOptions -> RegionInfoOptions -> Bool #

data SubregionListOptions Source #

Options for the subregions command.

Constructors

SubregionListOptions
Fields subregionListParentRegionCode :: RegionCode subregionListRegionType :: RegionType

Instances

Instances details

Read SubregionListOptions Source #
Instance details Defined in Data.EBird.CLI Methods readsPrec :: Int -> ReadS SubregionListOptions # readList :: ReadS [SubregionListOptions] # readPrec :: ReadPrec SubregionListOptions # readListPrec :: ReadPrec [SubregionListOptions] #
Show SubregionListOptions Source #
Instance details Defined in Data.EBird.CLI Methods showsPrec :: Int -> SubregionListOptions -> ShowS # show :: SubregionListOptions -> String # showList :: [SubregionListOptions] -> ShowS #
Eq SubregionListOptions Source #
Instance details Defined in Data.EBird.CLI Methods (==) :: SubregionListOptions -> SubregionListOptions -> Bool # (/=) :: SubregionListOptions -> SubregionListOptions -> Bool #

newtype AdjacentRegionsOptions Source #

Options for the subregions command.

Constructors

AdjacentRegionsOptions
Fields adjacentRegionsRegion :: Region

Instances

Instances details

Read AdjacentRegionsOptions Source #
Instance details Defined in Data.EBird.CLI Methods readsPrec :: Int -> ReadS AdjacentRegionsOptions # readList :: ReadS [AdjacentRegionsOptions] # readPrec :: ReadPrec AdjacentRegionsOptions # readListPrec :: ReadPrec [AdjacentRegionsOptions] #
Show AdjacentRegionsOptions Source #
Instance details Defined in Data.EBird.CLI Methods showsPrec :: Int -> AdjacentRegionsOptions -> ShowS # show :: AdjacentRegionsOptions -> String # showList :: [AdjacentRegionsOptions] -> ShowS #
Eq AdjacentRegionsOptions Source #
Instance details Defined in Data.EBird.CLI Methods (==) :: AdjacentRegionsOptions -> AdjacentRegionsOptions -> Bool # (/=) :: AdjacentRegionsOptions -> AdjacentRegionsOptions -> Bool #

eBirdCommand :: Parser (Maybe Text, EBirdCommand) Source #

Parse a command provided to the ebird CLI.

recentObservationsOptions :: Parser RecentObservationsOptions Source #

Parse the options for the recent-observations command.

recentNotableObservationsOptions :: Parser RecentNotableObservationsOptions Source #

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

recentSpeciesObservationsOptions :: Parser RecentSpeciesObservationsOptions Source #

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

recentNearbyObservationsOptions :: Parser RecentNearbyObservationsOptions Source #

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

recentNearbySpeciesObservationsOptions :: Parser RecentNearbySpeciesObservationsOptions Source #

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

recentNearestSpeciesObservationsOptions :: Parser RecentNearestSpeciesObservationsOptions Source #

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

recentNearbyNotableObservationsOptions :: Parser RecentNearbyNotableObservationsOptions Source #

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

historicalObservationsOptions :: Parser HistoricalObservationsOptions Source #

Parse the options for a historical-observations command.

observationOnlyHotspotsOpt :: Parser Bool Source #

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

observationIncludeProvisionalOpt :: Parser Bool Source #

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

observationMaxResultsOpt :: Parser Integer Source #

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

regionCodeOpt Source #

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 Source #

Arguments

:: String	String to include after "one or more taxonomy categories to include ..."
-> Parser TaxonomyCategories

Configurable TaxonomyCategories parser

observationSortByOpt :: Parser SortObservationsBy Source #

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

observationDetailLevelOpt :: Parser DetailLevel Source #

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

extraRegionsOpt :: Parser RegionCode Source #

Parse a RegionCode as extra regions to fetch observations from

recentChecklistsOptions :: Parser RecentChecklistsOptions Source #

Parse the options for a recent-checklists command.

top100Options :: Parser Top100Options Source #

Parse the options for a top-100 command.

checklistFeedOptions :: Parser ChecklistFeedOptions Source #

Parse the options for a top-100 command.

regionalStatisticsOptions :: Parser RegionalStatisticsOptions Source #

Parse the options for a regional-statistics command.

speciesListOptions :: Parser SpeciesListOptions Source #

Parse the options for a regional-statistics command.

viewChecklistOptions :: Parser ViewChecklistOptions Source #

Parse the options for a regional-statistics command.

checklistRegionCodeOpt :: Parser RegionCode Source #

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

checklistMaxResultsOpt :: Parser Integer Source #

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

regionHotspotsOptions :: Parser RegionHotspotsOptions Source #

Parse the options for a region-hotspots command.

nearbyHotspotsOptions :: Parser NearbyHotspotsOptions Source #

Parse the options for a nearby-hotspots command.

hotspotInfoOptions :: Parser HotspotInfoOptions Source #

Parse the options for a hotspot-info command.

taxonomyOptions :: Parser TaxonomyOptions Source #

Parse the options for a nearby-hotspots command.

taxonomicFormsOptions :: Parser TaxonomicFormsOptions Source #

Parse the options for a taxonomic-forms command.

taxaLocaleCodesOptions :: Parser TaxaLocaleCodesOptions Source #

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

taxonomicGroupsOptions :: Parser TaxonomicGroupsOptions Source #

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

regionInfoOptions :: Parser RegionInfoOptions Source #

Parse the options for the region-info command.

subregionListOptions :: Parser SubregionListOptions Source #

Parse the options for the subregions command.

adjacentRegionsOptions :: Parser AdjacentRegionsOptions Source #

Parse the options for the subregions command.

sppLocaleOpt :: String -> Parser SPPLocale Source #

Parse a SPPLocale as a generic command option.

region :: Parser Region Source #

Parse a Region as a generic command option.

regionCode :: Parser RegionCode Source #

Parse a RegionCode as a generic command option.

regionNameFormat :: Parser RegionNameFormat Source #

Parse a RegionNameFormat as a generic command option.

regionType :: Parser RegionType Source #

Parse a RegionType as a generic command option.

speciesCodeOpt :: String -> Parser SpeciesCode Source #

Configurable SpeciesCode option

searchRadiusOpt Source #

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 Source #

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 Source #

Arguments

:: String	"latitude" or "longitude"
-> String	What are we looking for
-> Parser Double

Configurable lat/lng option

attoReadM :: Parser a -> ReadM a Source #

Convert an attoparsec parser into an optparse-applicative parser.