Skip to content

add: Section on fire in CLI scenario #924

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Oct 10, 2018

Conversation

mrshu
Copy link
Contributor

@mrshu mrshu commented Oct 6, 2018

Signed-off-by: mr.Shu mr@shu.io

* Add a section on [Python Fire](https://github.com/google/python-fire/)
  in the CLI scenario.

Signed-off-by: mr.Shu <mr@shu.io>
@mpoulin
Copy link
Contributor

mpoulin commented Oct 8, 2018

Should we add a link to the announcement on the Google blog ?

@mrshu
Copy link
Contributor Author

mrshu commented Oct 9, 2018

@mpoulin I was under the impression that the page should primarily link to "canonical documentation" or "project repository", which is also what the other sections in the docs/scenarios/cli.rst file do. If you think linking to the announcement would be beneficial, I am happy to add it!

@mpoulin
Copy link
Contributor

mpoulin commented Oct 10, 2018

The announcement mentions some specific features and benefits we might want to highlight, such as

  • requires no changes to your code
  • is fully automatic (works by inspecting the object at run time)
  • works with any type of object
  • has a built in interpreter mode

@mrshu
Copy link
Contributor Author

mrshu commented Oct 10, 2018

Thanks @mpoulin, that makes sense (although I tried my best to highlight that in fire's description).

Would something like "You can learn more about Python Fire in its announcement blogpost" be appropriate here?

I am happy to go with whatever fits python-guide the best in stylistic sense.

@mpoulin
Copy link
Contributor

mpoulin commented Oct 10, 2018

Let's see what @dbader thinks.

@dbader
Copy link
Member

dbader commented Oct 10, 2018

My 2 cents: I like what's in the current changeset because it's consistent with the rest of the CLI section. The announcement post likely becomes less and less relevant over time whereas the project homepage will always be useful.

So I'm a +1 on merging this as is 🙂

@mpoulin
Copy link
Contributor

mpoulin commented Oct 10, 2018

I guess that settles it.
Would you like me to do the merge, Dan?

@dbader
Copy link
Member

dbader commented Oct 10, 2018 via email

@mpoulin mpoulin merged commit 4e6093a into realpython:master Oct 10, 2018
@mrshu
Copy link
Contributor Author

mrshu commented Oct 10, 2018

Thank you both!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants