Skip to content

Commit 0ff3e27

Browse files
committed
add readme
1 parent e9005f9 commit 0ff3e27

2 files changed

Lines changed: 12 additions & 3 deletions

File tree

README.md

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,41 +1,52 @@
11
# CPA: Create-Python-App
22

33
## Overview
4+
45
`cpa` is a cli tool designed to streamline the setup of new Python projects. It automates the creation of Python projects with commonly used configs and boilerplate.
56

67
## Goals
8+
79
- **Speed up Project Creation**: Reduce the time spent on repetitive setup tasks
810
- **Best Practices**: Encourage best practices for code quality, formatting, and style by including configs for tools like `black`, `isort`, and `flake8`.
911
- **Automation**: Automate tasks such as generating `.gitignore` files, setting up pre-commit hooks, and configuring code linters and formatters.
1012

1113
## Features
14+
1215
- Provides pre-commit hook setup with hooks for checking merge conflicts, large files, and code styling.
1316

1417
## Installation
18+
1519
Download binary from Github
20+
1621
```bash
1722

1823
```
1924

2025
Building from source
26+
2127
```bash
2228
# cd to project
2329
cargo install --path .
2430
```
31+
2532
## Usage
33+
2634
To create a new project:
2735

2836
```bash
2937
cpa create --name <project_name>
3038
```
3139

3240
Optional params:
41+
3342
- `--preset`: Specifies a Python version for the project. Defaults to "python" which is mapped internally to "python3.10".
3443

3544
Example:
45+
3646
```bash
3747
cpa create --name my_project --preset python3.10
3848
```
3949

4050
## Contributions and Feedback
51+
4152
Users are welcome to contribute to the project by submitting pull requests or opening issues for bugs and feature requests. Feedback is also greatly appreciated to help improve the tool.

src/python.rs

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -13,8 +13,7 @@ struct PreCommitConfig {
1313
}
1414
#[derive(Template)]
1515
#[template(path = ".gitignore", escape = "none")]
16-
struct GitIgnore {
17-
}
16+
struct GitIgnore {}
1817

1918
#[derive(Template)]
2019
#[template(path = "pyproject.toml", escape = "none")]
@@ -28,7 +27,6 @@ struct PyProject {
2827
#[template(path = ".cpa/flake8.cfg", escape = "none")]
2928
struct Flake8 {}
3029

31-
3230
#[derive(Template)]
3331
#[template(path = ".cpa/prettier.json", escape = "none")]
3432
struct Prettier {}

0 commit comments

Comments
 (0)