33 lines
992 B
Markdown
33 lines
992 B
Markdown
|
---
|
||
|
|
name: create-project
|
||
|
|
description: Create a new Fission Python project from the standard template
|
||
|
|
---
|
||
|
|
|
||
|
|
Create a new Fission Python project by running the create-project script.
|
||
|
|
|
||
|
|
## Usage
|
||
|
|
|
||
|
|
Run the following command from the repository root:
|
||
|
|
|
||
|
|
```bash
|
||
|
|
./fission-python/create-project.sh <project-name> [destination-directory]
|
||
|
|
```
|
||
|
|
|
||
|
|
- `project-name`: Name for the new project (letters, numbers, hyphens, underscores only)
|
||
|
|
- `destination-directory`: Where to create the project (default: current directory)
|
||
|
|
|
||
|
|
## What it does
|
||
|
|
|
||
|
|
1. Copies the template from `fission-python/template/`
|
||
|
|
2. Substitutes project name in `.fission/deployment.json`, override files, `src/helpers.py`, and `README.md`
|
||
|
|
3. Validates the created project structure (build.sh, requirements.txt, workflows, docstrings)
|
||
|
|
4. Creates a `.env` file with default environment variables
|
||
|
|
|
||
|
|
## Example
|
||
|
|
|
||
|
|
User asks: "Create a new Fission project called my-api in ./projects/"
|
||
|
|
|
||
|
|
```bash
|
||
|
|
./fission-python/create-project.sh my-api ./projects/
|
||
|
|
```
|