pyOpenSci / pyos-package-template

A Python package template that supports the pyOpenSci pure Python packaging tutorial
BSD 3-Clause "New" or "Revised" License
15 stars 11 forks source link

Offer more choices on template initialization, make template parts optional #38

Closed Midnighter closed 1 month ago

Midnighter commented 1 month ago

This branch works towards making parts of the template optional:

You can try out the template with:

copier copy -r feat-choices gh:Midnighter/pyos-package-template <target path>
lwasser commented 1 month ago

@Midnighter this is SO awesome. We can merge whenever you are ready!!!


📄 /GitHub/leahs-package 
➜ copier copy -r feat-choices gh:Midnighter/pyos-package-template .            
🎤 Who is the copyright holder, for example, yourself or your organization? Used in the license file and project description.
   pyos
🎤 Who is the author of the package to be? Used in the package description.
   pyos
🎤 The author's email address. Used in the package description.
   pyoe@psdf.sdf
🎤 What is the name of the project? Used as the title in the README.md and other places.
   project
🎤 What is the project slug? Used in hyperlinks.
   project
🎤 What is the Python package name? Used as the name of the package and the top-level import.
   project
🎤 Please provide a short description for the package.
    (Finish with 'Alt+Enter' or 'Esc then Enter')
> description

🎤 Do you want to use dynamic versioning of your package or static? Dynamic means that versions use your version control system (VCS), such as git tags, for creating versio
   No
🎤 Do you want to use git with a development platform, like GitHub or GitLab?
   No
🎤 Do you want to use hatch environments for running isolated commands like linting, building docs, or testing?
   No
🎤 Do you want to lint your code and generally check the formatting of your files?
   Yes
🎤 Do you want to use typing annotations and type check your code?
   No
🎤 Do you want to test your code? Generally, we strongly recommend that you do, but for a quick demo you may want to avoid this.
   Yes
🎤 Which license do you want to use? Used in the license file.
   BSD-3-Clause
🎤 What is the starting year of the project? Used in copyright statements.
   2024

Copying from template version 0.0.0.post30.dev0+d7eab3a
 identical  .
    create  mkdocs.yml
    create  CHANGELOG.md
    create  README.md
    create  tests
    create  tests/unit
    create  tests/unit/.keep
    create  tests/integration
    create  tests/integration/.keep
    create  tests/system
    create  tests/system/test_import.py
    create  tests/system/.keep
    create  docs
    create  docs/index.md
    create  .editorconfig
    create  .gitignore
    create  .pre-commit-config.yaml
    create  pyproject.toml
    create  .readthedocs.yaml
    create  LICENSE
    create  src
    create  src/project
    create  src/project/__init__.py
Midnighter commented 1 month ago

Happy to 😃 Thank you for the review.