Template Profiles

This is a list of questions and features being asked by copier. It is a slightly modified version of profiles.md file.
We will update this list after adding new features.

Files

minimum profile

  src/
  docs/
  test/
  pyproject.toml
  README.md
  .gitignore
  MANIFEST.in
  LICENCE

Questions

Essentials (for all profiles)

• template_profile
  • minimum --> DONE
  • recommended --> all questions - excluded with the defaults
  • optional --> all questions with answers off
• package_name
• version
• licence

Package details (for recommended and ask profile)

• package_short_description
• github_organization
• full_name
• email
• copyright_holder

Features (for recommended and ask profile)

Note: ✅ indicates whether the feature is implemented.

• community

  • ✅ code of conduct 464-Optional code of conduct #530 --> if TRUE ask for email
  • ✅ contributing guidelines 465-Add contributing question #543

• documentation

  • ✅ developer documentation 467-Add dev doc question #541
  • ✅ online documentation (read the docs)
  • project_setup.md 493-Make project setup optional #553
  • markdown link checker workflow

• code quality:

  • ✅ sonarcloud 460-Add sonarcloud question #515
  • ruff and lint workflow
  • ✅ github action to build (exist) add minimal profile #451
  • ✅ pre-commit Make pre-commit optional #487
  • .editorconfig

• publishing and release

  • ✅ zenodo 469-Make zenodo optional #520
  • ✅ keywords (implemented as a question)
  • ✅ changelog.md Make changelog optional #480
  • ✅ cffconvert workflow and citation file 458-Add question for citation files #471

• Other

Questions to exclude from recommended profile

• markdown link checker
• pre-commit
• changelog.md
• project_setup.md