Customisation Checklist for New Projects

🧰 This checklist highlights places where you should replace or update names like template_project, template-project, or personal info like Eleanor to make the project your own.

Use grep or your editor’s search tool to find these across the project.

πŸ“ Core Package and Import Paths

  • [ ] Rename template_project/ β†’ your_project_name/ (Recommended: Don’t use spaces or dashes. Underscores are OK.)

  • [ ] Update imports in all source and test files:

    • from template_project import ...

    • template_project.tools, template_project.readers, etc.

  • [ ] Check for relative paths in notebooks: from template_project import ...

πŸ§ͺ Testing

  • [ ] In tests/, update:

    • Import statements: from template_project import ...

    • File/module names like test_template_project.py

  • [ ] In .github/actions/, update tests.yml:

    • Coverage flags in pytest: --cov=template_project

βš™οΈ Configuration and Metadata

pyproject.toml

  • [ ] name = "template-project-efw" β†’ use your PyPI-compatible name

  • [ ] Update description, maintainers, and urls

  • [ ] Edit write_to = "template_project/_version.py"

.pre-commit-config.yaml

  • [ ] Edit coverage and file match patterns (e.g., pytest --cov=..., excludes)

  • [ ] Adjust if you rename data folders or want to lint different paths

πŸ“š Documentation

docs/source/conf.py

  • [ ] Change project, author, release

  • [ ] Update copyright

docs/index.rst

  • [ ] Change title and subtitle lines

  • [ ] Swap template-project references

  • [ ] Replace intro blurb with your own project description

docs/source/template_project.rst

  • [ ] Update to match your new package name (or delete if auto-generated)

  • [ ] Update any automodule:: or :mod: references

docs/source/_static/logo.jpg

  • [ ] Replace with your own logo if desired

πŸ“ Citation and License

  • [ ] In CITATION.cff:

    • [ ] Update title, authors, orcid, affiliation

    • [ ] Insert your GitHub repo URL

    • [ ] (Later step) Add a DOI via Zenodo if desired β€” see citation_guide.md

  • [ ] Review LICENSE to confirm you’re happy with the MIT license or swap for another

πŸ“„ Other Markdown Files

README.md

  • [ ] Replace:

    • template_project/*.py

    • Template for a Python project for oceanography

  • [ ] Customize usage examples and purpose statement

  • [ ] Add badges for Zenodo or PyPI once those steps are completed

CONTRIBUTING.md

  • [ ] Update module paths in examples (e.g., template_project.tools)

  • [ ] Mention your GitHub handle or org instead of β€œEleanor”

  • [ ] Replace style file references like template_project/template_project.mplstyle

πŸ›  Optional Automation

.github/workflows/

  • [ ] In tests.yml, docs.yml, pypi.yml:

    • [ ] Update paths and module names

    • [ ] Adjust PyPI settings (project name, build backend, etc.)

βœ… Once all these are updated, your project is cleanly decoupled from the original template and ready for public release or team collaboration.