Prompts¶
Note
Not Ai prompts, but rather the prompts for the uvi command. There zero Ai function in this project
When running the command uvi a prompt will start which enables you to configure your repository. The
prompt values and their explanation are as follows:
author:
Your full name.
email:
Your email address.
author_github_handle:
Your github handle, i.e. <handle> in https://github.com/<handle>
project_name:
Your project name. Should be equal to the name of your repository
and it should only contain alphanumeric characters and -'s.
project_slug:
The project slug, will default to the project_name with all -'s
replaced with _. This will be how you import your code later, e.g.
project_description:
A short description of your project.
include_github_actions:
"y" or "n". Adds a .github directory with various actions and
workflows to setup the environment and run code formatting checks
and unittests.
publish_to_pypi:
"y" or "n". Adds functionality to the
Makefile and Github workflows to make publishing your code as
simple as creating a new release release on Github. For more info,
see
Publishing to PyPI.
deptry:
"y" or "n". Adds deptry
to the development dependencies of the project, and adds it to the make check command. deptry is a command line tool to check for issues with dependencies in a Python project, such as obsolete or missing dependencies.
mkdocs:
"y" or "n". Adds MkDocs
documentation to your project. This includes automatically parsing
your docstrings and adding them to the documentation. Documentation
will be deployed to the gh-pages branch.
codecov:
"y" or "n". Adds code coverage checks with codecov.
dockerfile:
"y" or "n". Adds a simple Dockerfile.
devcontainer:
"y" or "n". Adds a devcontainer specification to the project along with pre-installed pre-commit hooks and VSCode python extension configuration.
open_source_license:
Choose a license. Options:
["1. MIT License", "2. BSD license", "3. ISC license", "4. Apache Software License 2.0", "5. GNU General Public License v3", "6. Not open source"]