withtwoemms / pokedex Goto Github PK

As a user
I want to be able to run tests and lint from the command line
So I can enjoy the convenience of CI and local dev env sharing an interface

GIVEN the need to run tests
WHEN they are run
THEN they are done so via CLI

GIVEN the need to lint code
WHEN linting
THEN it is done so via CLI

As a user
I want a service to which i can create new and modifiy existing Pokemon
So I can 'be the very best no one ever was'

GIVEN some service
WHEN a "create" request is received
THEN a new Pokemon is made available

GIVEN some service
WHEN a "read" request is received
THEN an existing Pokemon is returned

GIVEN some service
WHEN an "update" request is received
THEN an data associated with an existing Pokemon is modified

As a contributor
I want to know what the current test coverage is
So I can make more informed decisions about what needs testing

GIVEN some command
WHEN executed
THEN a coverage report is produced

GIVEN a CI run
WHEN executed
THEN a coverage report is produced

As a trainer
I want to retrieve a list of pokemon given some pokemon move
So I can better plan training for pokemon

GIVEN there is a function
WHEN a "pokemon move" is passed to said function
THEN some number of records for pokemon capable of doing said move is returned

As a user
I want to source records from some local store if present
So I don't have to hit the API

As a User
I want to be able to specify any pokemon type (when using the console script)
So I can get pokemon of my choosing

GIVEN a valid type
WHEN used with the --type option of the console script
THEN I get results pertaining to the given term

As a user
I want the app to 'fail gracefully'
So I am informed on how to proceed during failure and my STDERR is not littered with stacktraces

As a user
I want to have a more immediate response when fetching pokemon
So that my programs that integrate this code don't incur excessive latency

GIVEN request for a group of pokemon
WHEN made
THEN the process takes no more than 3 seconds

poetry run get-pokemon by should not just exit silently, it should give a help message.

As a trainer
I want to retrieve a list of pokemon given some type of pokemon
So I can be the best there ever was

GIVEN there is a function
WHEN a "pokemon" type is passed to said function
THEN some number of records for pokemon of said type is returned

As a newcomer
I want a way to know the available options for the by sub-command (e.g. by --type)
So I can only use valid options

Currently, dbm is being used to cache results from the actual API. It does not support concurrent read/writes and so presents a bottleneck to ingestion.

As a developer
I want a concurrent KV store
So I can reduce usage latency

As a developer
I want to know how to install the project and its dependencies
So I can get started autonomously

As a developer
I want some guidance on the general structure of the repo
So I can be better informed when beginning to make a change