search

pangeo-forge / pangeo-forge-runner

Run pangeo-forge recipes on Apache Beam
https://pangeo-forge-runner.readthedocs.io
Apache License 2.0
8 stars 9 forks source link

Rename this project #24

Open yuvipanda opened 1 year ago

yuvipanda commented 1 year ago

The word Runner is already used by Beam for a very specific concept, and we shouldn't overload it by using it here again. It's early enough that this project can be renamed, so we should try make that happen!

Ideally, we would keep the name of the project, the python package and the commandline executable the same. And if we can keep it within the forge theme it'd be great! This package performs actions (expand-meta, bake, eventually get logs, check-for-completeness, etc) - so 'something that does something in a forge' would be awesome.

Current suggestions are:

  1. pangeo-forge-smith
  2. pangeo-smith
  3. pangeo-forge-cli, with the commandline tool being just pangeo-forge (similar to awscli commandline tool being aws)
  4. ???
rabernat commented 1 year ago

I vote pangeo-forge-cli

cisaacstern commented 1 year ago

I vote pangeo-forge-cli

I like this too. The whole "forge"/"metalsmithing" metaphor space is already confusing as it is, what with "recipes"/"bakery" culinary analogies in the mix as well. By contrast, pangeo-forge-cli is simple and to the point.

derekocallaghan commented 1 year ago

Another vote for pangeo-forge-cli

cisaacstern commented 1 year ago

@yuvipanda with

in the pipeline, I sense we're about to actually announce the existence of this project for the first time, in documentation, and perhaps some blogs to follow-on to those docs.

With that in mind, I think we should do this renaming before finishing above docs, what do you think? To recap, I think the consensus seems to be:

yuvipanda commented 1 year ago

rename the CLI tool to pangeo-forge (possibly with pf available as an alias?)

Unconditional +1!

I'd love to see an alternative to -cli though - there's not really much preventing you from importing this as a python package and doing things. Any other suggestions?

cisaacstern commented 1 year ago

there's not really much preventing you from importing this as a python package and doing things

Not much preventing you, but do you envision this would ever be a documented /recommended way to use this project? (Aside from the fact that we do this for convenience in testing.)

Seems like to do so would be somewhat awkward, i.e. require calling .start() methods on command classes, which is not documented anywhere?

If we're not planning to encourage this style of usage, perhaps Hyrum's Law dictates that people will eventually do it, but maybe -cli is still fine, because it describes the intended usage?

yuvipanda commented 1 year ago

Let's give ourselves a deadline (Tuesday perhaps?) and if there are no other options, let's go with -cli