You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
This is sort of an origin Super-Issue as the work isn't yet well defined and this is a weekend project 🍻
It is incredibly unlikely to be exhaustive, and it also is almost certainly going to have a poor definition of the work that needs to be done. I will be following test-driven development for as long as I can stay focused on it, and so I'm sure there may be a lot of emergent functionality or design throughout that process. After those designs begin emerging is likely when I will create and refine more issues detailing the work that needs to be done on individual components of the design.
The current relevant v0.0.1 milestones are as follows:
Calling feedme --help from the command line should provide usage/help information
Calling feedme without no path to a file should provide usage/help information
Calling feedme with path to JSON file should read in restaurants from that file and print a random restaurant as a choice
Coding 💩
Use the click lib to expose a CLI
Load the contents of a JSON file into memory
Process the names of restaurants out of an in-memory JSON file (dictionary)
Output the name of one restaurant to stdout by random selection
mypy types through the code
Documentation 📝
Right now I don't have any draft of the CLI interface whatsoever, I should draft this.
Add setup/install/dev docs to the README
Generate code and usage docs with Sphinx
Add useful document comments throughout the code, for Sphinx and interactive help()
Testing ✅
I'll need to use click.testing and CliRunner in specific to emulate running the CLI program.
That will let me test things like exit code and output text.
In order to test the restaurant selection process provides appropriate out
I'll need to Mock random in order to provide a non-random value for testing.
I'll need to provide false data for testing the file import, I'm not sure if I should Mock the file IO or if I should create a dictionary it would map to, or if I should create some ConfigFileReader which I can mock the side-effects of.
The text was updated successfully, but these errors were encountered:
Actually I'm not really sure I want to use semver as the versioning scheme for this, I've been thinking about it recently and because it's a "product" being "released," it may make more sense to use calendar versioning.
This is sort of an origin Super-Issue as the work isn't yet well defined and this is a weekend project 🍻
It is incredibly unlikely to be exhaustive, and it also is almost certainly going to have a poor definition of the work that needs to be done. I will be following test-driven development for as long as I can stay focused on it, and so I'm sure there may be a lot of emergent functionality or design throughout that process. After those designs begin emerging is likely when I will create and refine more issues detailing the work that needs to be done on individual components of the design.
The current relevant v0.0.1 milestones are as follows:
feedme --help
from the command line should provide usage/help informationfeedme
without no path to a file should provide usage/help informationfeedme
with path to JSON file should read in restaurants from that file and print a random restaurant as a choiceCoding 💩
Use the click lib to expose a CLI
Load the contents of a JSON file into memory
Process the names of restaurants out of an in-memory JSON file (dictionary)
Output the name of one restaurant to stdout by random selection
mypy types through the code
Documentation 📝
Right now I don't have any draft of the CLI interface whatsoever, I should draft this.
Add setup/install/dev docs to the README
Generate code and usage docs with Sphinx
Add useful document comments throughout the code, for Sphinx and interactive
help()
Testing ✅
I'll need to use click.testing and CliRunner in specific to emulate running the CLI program.
That will let me test things like exit code and output text.
In order to test the restaurant selection process provides appropriate out
I'll need to Mock random in order to provide a non-random value for testing.
I'll need to provide false data for testing the file import, I'm not sure if I should Mock the file IO or if I should create a dictionary it would map to, or if I should create some ConfigFileReader which I can mock the side-effects of.
The text was updated successfully, but these errors were encountered: