Skip to content

Explore the usage of the template via pipx #5

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
jorgepiloto opened this issue Mar 8, 2022 · 1 comment
Closed

Explore the usage of the template via pipx #5

jorgepiloto opened this issue Mar 8, 2022 · 1 comment
Labels
enhancement New features or code improvements

Comments

@jorgepiloto
Copy link
Member

💡 Feature request

At the moment, users are forced to install cookiecutter to be able to bake their projects. This ships with the following disadvantages as pointed out by @asbfall:

  • Users need to know the url of this repository in order to run cookiecutter gh:pyansys/pyansys-template. If at some point this repo URL is changed, users should be aware of it. Otherwise, previous command will fail.
  • Users require from installing cookiecutter in a venv. Although not mandatory, this is a good practice. Users might not be familiar with this workflow. This is the reason behind pipx.

🎯 Goal

The main goal of this feature request is to substitute the current workflow:

cookiecutter gh:pyansys/pyansys-template

by:

pipx run pyansys-template

One additional advantage are, for example, is the ability to pass arguments and options. Imagine having multiple templates and users being able to select which one of those to be baked (or even the build-system):

pipx run pyansys-template --template pylib --build-system poetry
pipx run pyansys-template --template gRCP
@jorgepiloto jorgepiloto added the enhancement New features or code improvements label Mar 8, 2022
@jorgepiloto
Copy link
Member Author

After merging #8, this project ships now as a Python package with an entry point named ansys-templates. This can be installed with pipx. Let us close this issue and focus in #10.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New features or code improvements
Projects
None yet
Development

No branches or pull requests

1 participant