Skip to content

Prompt arguments

When running the command cchydro a prompt will start which enables you to configure your repository. The prompt values and their explanation are as follows:

author

Your full name.

email

Your email address.

author_github_handle

Your github handle, i.e. <handle> in https://github.com/<handle>

project_name

Your project name. Should be equal to the name of your repository and it should only contain alphanumeric characters and -'s.

project_slug

The project slug, will default to the project_name with all -'s replaced with _. This will be how you import your code later, e.g.

from <project_slug> import foo

project_description

A short description of your project.

project_home

"new-directory" or "current-directory".

  • new-directory: default cookiecutter behavior, create a new folder named project_name.
  • current-directory: move generated files into the directory where you ran cchydro.

Use current-directory when you already created the repository folder and want to avoid nested project directories.

dockerfile

"y" or "n". Adds a simple Dockerfile.

devcontainer

"y" or "n". Adds a devcontainer specification to the project and VSCode python extension configuration.

open_source_license

Choose a license. Options: ["1. MIT License", "2. BSD license", "3. ISC license", "4. Apache Software License 2.0", "5. GNU General Public License v3", "6. Not open source"]