ccds-help.json

[
	{
		"field": "project_name",
		"help": {
			"description": "A name for the project, for example 'My Project'.",
			"more_information": ""
		}
	},
	{
		"field": "repo_name",
		"help": {
			"description": "Default generated by altering the `project_name`. Used for folder and repo name for the project.",
			"more_information": ""
		}
	},
	{
		"field": "module_name",
		"help": {
			"description": "Default generated by altering the `project_name` to be a compatible Python module name.",
			"more_information": ""
		}
	},
	{
		"field": "author_name",
		"help": {
			"description": "Name of the individual or organization that created the project.",
			"more_information": ""
		}
	},
	{
		"field": "description",
		"help": {
			"description": "A short description that appears in the README.md file by default.",
			"more_information": ""
		}
	},
	{
		"field": "python_version_number",
		"help": {
			"description": "The version of Python that the project will use.",
			"more_information": "[Python version status](https://devguide.python.org/versions/)"
		}
	},
	{
		"field": "dataset_storage",
		"help": {
			"description": "A cloud storage location for where data should be stored; controls `sync_data_up` and `sync_data_down` Makefile commands. You will be asked for different additional configuration information depending on your choice.",
			"more_information": ""
		},
		"choices": [
			{
				"choice": "none",
				"help": {
					"description": "No cloud storage configured; Makefile commands to sync data removed.",
					"more_information": ""
				}
			},
			{
				"choice": "azure",
				"help": {
					"description": "Store data on Azure Blob Storage.",
					"more_information": "[Docs](https://learn.microsoft.com/en-us/azure/storage/blobs/)"
				},
				"subfields": [
					{
						"field": "container",
						"help": {
							"description": "Name of the container on blob storage.",
							"more_information": "[Docs](https://learn.microsoft.com/en-us/azure/storage/blobs/blob-containers-portal)"
						}
					}
				]
			},
			{
				"choice": "s3",
				"help": {
					"description": "Store data on Amazon S3.",
					"more_information": "[Docs](https://docs.aws.amazon.com/s3/)"
				},
				"subfields": [
					{
						"field": "bucket",
						"help": {
							"description": "The name of the bucket to store data in; can also be a longer S3 path.",
							"more_information": "[Docs](https://docs.aws.amazon.com/AmazonS3/latest/userguide/Welcome.html#BasicsBucket)"
						}
					},
					{
						"field": "aws_profile",
						"help": {
							"description": "The name of the profile to use for the aws CLI.",
							"more_information": "[Docs](https://docs.aws.amazon.com/cli/latest/userguide/cli-configure-files.html)"
						}
					}
				]
			},
			{
				"choice": "gcs",
				"help": {
					"description": "Store data to Google Cloud Storage",
					"more_information": "[Docs](https://cloud.google.com/storage/docs)"
				},
				"subfields": [
					{
						"field": "bucket",
						"help": {
							"description": "The name of the bucket to store data in.",
							"more_information": "[Docs](https://cloud.google.com/storage/docs/buckets)"
						}
					}
				]
			}
		]
	},
	{
		"field": "environment_manager",
		"help": {
			"description": "Tool for managing creating Python environments. Controls `make create_environment` Makefile command.",
			"more_information": "[About virtual environments](https://www.dataquest.io/blog/a-complete-guide-to-python-virtual-environments/)"
		},
		"choices": [
			{
				"choice": "uv",
				"help": {
					"description": "Modern, fast Python package installer and resolver written in Rust.",
					"more_information": "[Docs](https://github.com/astral-sh/uv)"
				}
			},
			{
				"choice": "virtualenv",
				"help": {
					"description": "Simple wrapper on venv with more features.",
					"more_information": "[Docs](https://virtualenv.pypa.io/en/latest/)"
				}
			},
			{
				"choice": "conda",
				"help": {
					"description": "Data science environments supporting non-Python dependencies as well.",
					"more_information": "[Docs](https://conda.io/projects/conda/en/latest/user-guide/tasks/manage-environments.html)"
				}
			},
			{
				"choice": "pipenv",
				"help": {
					"description": "Manages dependencies and virual environments.",
					"more_information": "[Docs](https://pipenv.pypa.io/en/latest/)"
				}
			},
			{
				"choice": "none",
				"help": {
					"description": "Do not add `create_environment` commands; env management left to the user.",
					"more_information": ""
				}
			}
		]
	},
	{
		"field": "dependency_file",
		"help": {
			"description": "Where to track project-specific dependencies; often paired with specific environment manager.",
			"more_information": ""
		},
		"choices": [
			{
				"choice": "none",
				"help": {
					"description": "Create no dependency file, relying solely on `pyproject.toml`",
					"more_information": "[pyproject.toml](https://packaging.python.org/en/latest/guides/writing-pyproject-toml/)"
				}
			},
			{
				"choice": "requirements.txt",
				"help": {
					"description": "Most general, least feature-rich format for use with `pip`.",
					"more_information": "[pip docs](https://pip.pypa.io/en/stable/reference/requirements-file-format/)"
				}
			},
			{
				"choice": "environment.yml",
				"help": {
					"description": "Format used by `conda`.",
					"more_information": "[Docs](https://conda.io/projects/conda/en/latest/user-guide/tasks/manage-environments.html#sharing-an-environment)"
				}
			},
			{
				"choice": "Pipfile",
				"help": {
					"description": "Format used by Pipenv",
					"more_information": "[Docs](https://pipenv.pypa.io/en/latest/pipfile.html)"
				}
			}
		]
	},
	{
		"field": "pydata_packages",
		"help": {
			"description": "Packages automatically added to your requirements file.",
			"more_information": ""
		},
		"choices": [
			{
				"choice": "none",
				"help": {
					"description": "No extra packages.",
					"more_information": ""
				}
			},
			{
				"choice": "basic",
				"help": {
					"description": "Basic common data science packages.",
					"more_information": ""
				}
			}
		]
	},
	{
		"field": "open_source_license",
		"help": {
			"description": "Whether to include a license file and which one to use.",
			"more_information": ""
		},
		"choices": [
			{
				"choice": "No license file",
				"help": {
					"description": "No license file will be included.",
					"more_information": ""
				}
			},
			{
				"choice": "MIT",
				"help": {
					"description": "MIT License",
					"more_information": "[License](https://opensource.org/license/mit)"
				}
			},
			{
				"choice": "BSD-3-Clause",
				"help": {
					"description": "3-Clause BSD License",
					"more_information": "[License](https://opensource.org/license/bsd-3-clause)"
				}
			}
		]
	},
	{
		"field": "docs",
		"help": {
			"description": "Whether to include a `docs` folder and documentation tools.",
			"more_information": ""
		},
		"choices": [
			{
				"choice": "none",
				"help": {
					"description": "No `docs` folder.",
					"more_information": ""
				}
			},
			{
				"choice": "mkdocs",
				"help": {
					"description": "Include `docs` folder and `mkdocs` tools.",
					"more_information": "[Docs](https://www.mkdocs.org/)"
				}
			}
		]
	},
	{
		"field": "include_code_scaffold",
		"help": {
			"description": "Whether to include some basic boilerplate code in the Python module.",
			"more_information": ""
		},
		"choices": [
			{
				"choice": "No",
				"help": {
					"description": "No scaffolding - just basic project structure",
					"more_information": "Creates minimal project structure with only essential files"
				}
			},
			{
				"choice": "paper",
				"help": {
					"description": "Research paper with code structure",
					"more_information": "Includes notebooks/, paper/, src/ directories with LaTeX setup and research code organization"
				}
			},
			{
				"choice": "app",
				"help": {
					"description": "Application structure (web, CLI, or GUI)",
					"more_information": "Sets up src/, api/, cli/ directories with application entrypoints and deployment configs"
				}
			},
			{
				"choice": "ml",
				"help": {
					"description": "Machine learning project structure",
					"more_information": "Creates models/, training/, evaluation/ directories with ML pipeline setup"
				}
			},
			{
				"choice": "data",
				"help": {
					"description": "Data processing/analysis structure",
					"more_information": "Includes pipelines/, analysis/, validation/ directories for data workflows"
				}
			},
			{
				"choice": "lib",
				"help": {
					"description": "Library/package structure",
					"more_information": "Basic package structure with examples and API documentation setup"
				}
			},
			{
				"choice": "course",
				"help": {
					"description": "Library/package structure",
					"more_information": "Basic package structure with examples and API documentation setup"
				}
			}
		]
	},
	{
		"field": "version_control",
		"help": {
			"description": "What kind of version control system (vcs) and repository host to use.",
			"more_information": ""
		},
		"choices": [
			{
				"choice": "none",
				"help": {
					"description": "No version control.",
					"more_information": ""
				}
			},
			{
				"choice": "git (local)",
				"help": {
					"description": "Initialize project as a local git repository.",
					"more_information": "[Git CLI](https://git-scm.com/downloads) Required"
				}
			},
			{
				"choice": "git (github private)",
				"help": {
					"description": "Initialize project and upload to GitHub as a **private** repo.",
					"more_information": "[Git CLI](https://git-scm.com/downloads) + [GitHub CLI](https://cli.github.com/) & [Auth](https://cli.github.com/manual/gh_auth_login) Required"
				}
			},
			{
				"choice": "git (github public)",
				"help": {
					"description": "Initialize project and upload to GitHub as a **public** repo.",
					"more_information": "[Git CLI](https://git-scm.com/downloads) + [GitHub CLI](https://cli.github.com/) & [Auth](https://cli.github.com/manual/gh_auth_login) Required"
				}
			}
		]
	},
	{
		"field": "dependency_file",
		"help": {
			"description": "Where to track project-specific dependencies; often paired with specific environment manager.",
			"more_information": ""
		},
		"choices": [
			{
				"choice": "none",
				"help": {
					"description": "Create no dependency file, relying solely on `pyproject.toml`",
					"more_information": "[pyproject.toml](https://packaging.python.org/en/latest/guides/writing-pyproject-toml/)"
				}
			},
			{
				"choice": "requirements.txt",
				"help": {
					"description": "Most general, least feature-rich format for use with `pip`.",
					"more_information": "[pip docs](https://pip.pypa.io/en/stable/reference/requirements-file-format/)"
				}
			},
			{
				"choice": "environment.yml",
				"help": {
					"description": "Format used by `conda`.",
					"more_information": "[Docs](https://conda.io/projects/conda/en/latest/user-guide/tasks/manage-environments.html#sharing-an-environment)"
				}
			},
			{
				"choice": "Pipfile",
				"help": {
					"description": "Format used by Pipenv",
					"more_information": "[Docs](https://pipenv.pypa.io/en/latest/pipfile.html)"
				}
			}
		]
	}
]