setup-project

Setup Python Project

Initialize a new Python project with proper structure and configuration.

Context

• Current directory: !pwd
• Existing files: !ls -la

Your Task

Create a well-structured Python project with appropriate configuration based on the project type.

Arguments

• $1: Project name (required) - will be used for directory and package names
• $2: Project type (optional) - app, library, or cli (defaults to app)

Steps

1. Determine project type from arguments or ask user:

   • app: Application (web service, script, etc.)
   • library: Reusable library for distribution
   • cli: Command-line tool

2. Create project structure based on type:

   For applications (app):

   project-name/
   ├── src/
   │   └── project_name/
   │       ├── __init__.py
   │       ├── main.py
   │       └── config.py
   ├── tests/
   │   ├── __init__.py
   │   └── test_main.py
   ├── pyproject.toml
   ├── .gitignore
   └── README.md
   

   For libraries (library):

   project-name/
   ├── src/
   │   └── project_name/
   │       ├── __init__.py
   │       └── core.py
   ├── tests/
   │   ├── __init__.py
   │   └── test_core.py
   ├── docs/
   │   └── index.md
   ├── pyproject.toml
   ├── .gitignore
   └── README.md
   

   For CLI tools (cli):

   project-name/
   ├── src/
   │   └── project_name/
   │       ├── __init__.py
   │       ├── cli.py
   │       └── commands/
   │           └── __init__.py
   ├── tests/
   │   ├── __init__.py
   │   └── test_cli.py
   ├── pyproject.toml
   ├── .gitignore
   └── README.md
   

3. Create pyproject.toml with UV/PEP 621 configuration:

   [project]
   name = "project-name"
   version = "0.1.0"
   description = "Project description"
   readme = "README.md"
   requires-python = ">=3.9"
   authors = [
       {name = "Your Name", email = "[email protected]"}
   ]
   dependencies = []
   
   [project.optional-dependencies]
   dev = [
       "pytest>=7.0.0",
       "black>=23.0.0",
       "mypy>=1.0.0",
       "ruff>=0.1.0",
   ]
   
   [build-system]
   requires = ["hatchling"]
   build-backend = "hatchling.build"