Skip to content

Post-Copy Checklist

After running copier copy, see .copier-answers/post-copier-todos/module-{{ module_type }}-{{ module_name }}.md for next steps on implementing your rule into the project. You can copy-paste the contents of that file into a GitHub issue or a project management tool to track the implementation of the rule.

Post Copier To-Do's for the {{ module_type }}/{{ module_name }} module

This issue is for tracking the development of the module that was copied from the able-workflow-module-copier template.

Next steps

Required

No modifications should be required for the module to function. The primary functionally of the module are within the ETL processes, which are copied from the able-workflow-etl-copier template.

Optional

  • pyproject.toml
    • Add any extra dependencies that this module requires to runner in the [project.optional-dependencies] section of pyproject.toml. You may not know which extra dependencies you require until you start working on the ETL processes. If those dependencies are not available on conda-forge, then configure the [tool.pyproject2conda.dependencies] section of pyproject.toml to specify that they should be installed via pip instead of conda.
  • workflow/profiles/
    • The default configuration for this module was automatically written to workflow/profiles/default/config.yaml. However, if you have other profiles you should include this module's configuration in those profiles as well.
  • config/{{ module_type }}/{{ module_name }}/config.yaml
    • Add configuration options as needed.
  • workflow/schemas/{{ module_type }}/{{ module_name }}/config.schema.yaml
    • Update schema to match the configuration options in config/{{ module_type }}/{{ module_name }}/config.yaml.