pokego

README

PokeGO

PokeGO is a Go package that provides bindings to the Pokeapi. It caches to a local SQLite database.

Getting Started

Installing

go get github.com/mazylol/pokego

Usage

Import the package into your project.

import "github.com/mazylol/pokego"

Use the GetPokemon function to get a Pokemon of the provided name.

pokemon, err := pokego.GetPokemon("slugma")

// Print out name
fmt.Println(pokemon.Name)

You can also get a list of every Pokemon name.

pokemonList, err := pokego.GetResourceList("pokemon", 35) // 35 is how many pokemon it will get
	
// Print out the first Pokemons name
fmt.Println(pokemonList.Results[0].Name)

Features

• Resource Lists/Pagination

---

• Berries
• Contests
• Encounters
• Evolution
• Games
• Items
• Locations
• Machines
• Moves
• Pokemon

---

• Utility

Contributions <3

Contributors are very welcome. I still have a lot of ground to cover and any help is greatly appreciated. Refer to the features to see what needs done.

Documentation

Index

• func GetAilment(name string) (moves.Ailment, error)
• func GetBattleStyle(name string) (moves.BattleStyle, error)
• func GetBerry(name string) (berries.Berry, error)
• func GetBerryFirmness(name string) (berries.Firmness, error)
• func GetBerryFlavor(name string) (berries.Flavor, error)
• func GetCategory(name string) (moves.Category, error)
• func GetContestEffect(id int) (contests.Effect, error)
• func GetContestType(name string) (contests.Type, error)
• func GetDamageClass(name string) (moves.DamageClass, error)
• func GetEncounterCondition(name string) (encounters.Condition, error)
• func GetEncounterConditionValue(name string) (encounters.ConditionValue, error)
• func GetEncounterMethod(name string) (encounters.Method, error)
• func GetLearnMethod(name string) (moves.LearnMethod, error)
• func GetMove(name string) (moves.Move, error)
• func GetPokemon(name string) (pokemon.Pokemon, error)
• func GetPokemonAbility(name string) (pokemon.Ability, error)
• func GetPokemonCharacteristic(id int) (pokemon.Characteristic, error)
• func GetPokemonColor(name string) (pokemon.Color, error)
• func GetPokemonEggGroup(name string) (pokemon.EggGroup, error)
• func GetPokemonForm(name string) (pokemon.Form, error)
• func GetPokemonGender(name string) (pokemon.Gender, error)
• func GetPokemonGrowthRate(name string) (pokemon.GrowthRate, error)
• func GetPokemonHabitat(name string) (pokemon.Habitat, error)
• func GetPokemonLocationArea(name string) ([]pokemon.LocationArea, error)
• func GetPokemonNature(name string) (pokemon.Nature, error)
• func GetPokemonPokeathlonStats(name string) (pokemon.PokeathlonStat, error)
• func GetPokemonShape(name string) (pokemon.Shape, error)
• func GetPokemonSpecies(name string) (pokemon.Species, error)
• func GetPokemonStat(name string) (pokemon.Stat, error)
• func GetPokemonType(name string) (pokemon.Type, error)
• func GetResourceList(endpoint string, count int) (resource.List, error)
• func GetSuperContestEffect(id int) (contests.SuperEffect, error)
• func GetTarget(name string) (moves.Target, error)

Functions

func GetAilment

func GetAilment(name string) (moves.Ailment, error)

GetAilment returns a Move struct containing information about the Move with the given name.

func GetBattleStyle

func GetBattleStyle(name string) (moves.BattleStyle, error)

GetBattleStyle returns a Move struct containing information about the Move with the given name.

func GetBerry

func GetBerry(name string) (berries.Berry, error)

GetBerry returns a berry by name.

func GetBerryFirmness

func GetBerryFirmness(name string) (berries.Firmness, error)

GetBerryFirmness returns a berry firmness by name.

func GetBerryFlavor

func GetBerryFlavor(name string) (berries.Flavor, error)

GetBerryFlavor returns a berry flavor by name.

func GetCategory

func GetCategory(name string) (moves.Category, error)

GetCategory returns a Move struct containing information about the Move with the given name.

func GetContestEffect

func GetContestEffect(id int) (contests.Effect, error)

GetContestEffect returns a ContestEffect struct containing information about the ContestEffect with the given id.

func GetContestType

func GetContestType(name string) (contests.Type, error)

GetContestType returns a ContestType struct containing information about the ContestType with the given name.

func GetDamageClass

func GetDamageClass(name string) (moves.DamageClass, error)

GetDamageClass returns a Move struct containing information about the Move with the given name.

func GetEncounterCondition

func GetEncounterCondition(name string) (encounters.Condition, error)

GetEncounterCondition returns a EncounterCondition struct containing information about the EncounterCondition with the given name.

func GetEncounterConditionValue

func GetEncounterConditionValue(name string) (encounters.ConditionValue, error)

GetEncounterConditionValue returns a EncounterConditionValue struct containing information about the EncounterConditionValue with the given name.

func GetEncounterMethod

func GetEncounterMethod(name string) (encounters.Method, error)

GetEncounterMethod returns a EncounterMethod struct containing information about the EncounterMethod with the given name.

func GetLearnMethod

func GetLearnMethod(name string) (moves.LearnMethod, error)

GetLearnMethod returns a Move struct containing information about the Move with the given name.

func GetMove

func GetMove(name string) (moves.Move, error)

GetMove returns a Move struct containing information about the Move with the given name.

func GetPokemon

func GetPokemon(name string) (pokemon.Pokemon, error)

GetPokemon returns a Pokemon struct containing information about the Pokemon with the given name.

func GetPokemonAbility

func GetPokemonAbility(name string) (pokemon.Ability, error)

GetPokemonAbility returns an Ability struct containing information about the Ability with the given name.

func GetPokemonCharacteristic

func GetPokemonCharacteristic(id int) (pokemon.Characteristic, error)

GetPokemonCharacteristic returns a Characteristic struct containing information about the Characteristic with the given id.

func GetPokemonColor

func GetPokemonColor(name string) (pokemon.Color, error)

GetPokemonColor returns a Color struct containing information about the Color with the given name.

func GetPokemonEggGroup

func GetPokemonEggGroup(name string) (pokemon.EggGroup, error)

GetPokemonEggGroup returns an EggGroup struct containing information about the EggGroup with the given name.

func GetPokemonForm

func GetPokemonForm(name string) (pokemon.Form, error)

GetPokemonForm returns a Form struct containing information about the Form with the given name.

func GetPokemonGender

func GetPokemonGender(name string) (pokemon.Gender, error)

GetPokemonGender returns a Gender struct containing information about the EggGroup with the given name.

func GetPokemonGrowthRate

func GetPokemonGrowthRate(name string) (pokemon.GrowthRate, error)

GetPokemonGrowthRate returns a GrowthRate struct containing information about the GrowthRate with the given name.

func GetPokemonHabitat

func GetPokemonHabitat(name string) (pokemon.Habitat, error)

GetPokemonHabitat returns a Habitat struct containing information about the Habitat with the given name.

func GetPokemonLocationArea

func GetPokemonLocationArea(name string) ([]pokemon.LocationArea, error)

GetPokemonLocationArea returns a PokemonLocationArea struct containing information about the PokemonLocationArea with the given name.

func GetPokemonNature

func GetPokemonNature(name string) (pokemon.Nature, error)

GetPokemonNature returns a Nature struct containing information about the Nature with the given name.

func GetPokemonPokeathlonStats

func GetPokemonPokeathlonStats(name string) (pokemon.PokeathlonStat, error)

GetPokemonPokeathlonStats returns a PokeathlonStat struct containing information about the PokeathlonStat with the given name.

func GetPokemonShape

func GetPokemonShape(name string) (pokemon.Shape, error)

GetPokemonShape returns a Shape struct containing information about the Shape with the given name.

func GetPokemonSpecies

func GetPokemonSpecies(name string) (pokemon.Species, error)

GetPokemonSpecies returns a Species struct containing information about the Species with the given name.

func GetPokemonStat

func GetPokemonStat(name string) (pokemon.Stat, error)

GetPokemonStat returns a Stat struct containing information about the Stat with the given name.

func GetPokemonType

func GetPokemonType(name string) (pokemon.Type, error)

GetPokemonType returns a Type struct containing information about the Type with the given name.

func GetResourceList

func GetResourceList(endpoint string, count int) (resource.List, error)

GetResourceList returns a ResourceList struct containing information about the list of resources with the given name.

func GetSuperContestEffect

func GetSuperContestEffect(id int) (contests.SuperEffect, error)

GetSuperContestEffect returns a SuperContestEffect struct containing information about the SuperContestEffect with the given id.

func GetTarget

func GetTarget(name string) (moves.Target, error)

GetTarget returns a Move struct containing information about the Move with the given name.