autoprep

A one-command project setup utility for bootstrapping new projects quickly.

Features

• One-Command Setup: Initialize new projects with a single command.
• Extensible Pipeline: Customize the setup process with a step-based pipeline.
• Templating: Use Jinja2 templates to generate boilerplate code.
• Configuration: Override default settings with global and project-specific config files.
• Optional Integrations: Add Docker, linting, and more with simple flags.

Installation

pip install arjunjain-autoprep

Usage

autoprep can be run from any directory. It is recommended to run it from the folder where you want your new project to be created.

Interactive Mode

For the best experience, run the new command without any options to launch the interactive setup wizard:

python -m autoprep new

The CLI will guide you, asking for the project name, template, and other options.

Non-Interactive Mode

You can also provide all the options as command-line arguments:

python -m autoprep new --name myapp --template webapi --deps "flask,pytest" --docker

Available Commands

• autoprep new: Initialize a new project.
• autoprep list-templates: See a detailed list of all available project templates.

Available Templates

• autoprep list-profiles: View your custom-defined project profiles.
• autoprep version: Show the version of autoprep.

Troubleshooting

If you encounter an error like autoprep: command not found after installation, please refer to the Troubleshooting Guide for a step-by-step solution.

Profiles

For even faster setup, you can define profiles in a ~/.autoprep/profiles.yml file. A profile is a pre-defined combination of a template and options.

Example profiles.yml

profiles:
  webapi:
    template: python-webapi
    options:
      docker: true
      lint: true
  cli_tool:
    template: python-cli
    options:
      lint: true

Now, you can bootstrap a complete web API project with a single command:

autoprep new --profile webapi

Configuration

For more advanced customization, autoprep can be configured through a global ~/.autoprep/config.yml file and a project-specific .autoprep.yml file. Command-line options will always override settings from the configuration files.

Example config.yml

user:
  name: Your Name
  email: your.email@example.com

project:
  lang: python
  author: Your Name
  email: your.email@example.com

profiles:
  my-profile:
    template: webapi
    deps:
      - flask
      - pytest
      - black
    steps:
      - create_structure
      - init_git
      - create_venv
      - install_deps
      - generate_files
      - add_docker
      - add_linting