Skip to content

Commit 8e2eda1

Browse files
committed
clean
1 parent 04f1c8b commit 8e2eda1

1 file changed

Lines changed: 4 additions & 6 deletions

File tree

README.md

Lines changed: 4 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -2,13 +2,11 @@
22

33
![CPA Logo](cpa.png)
44

5-
## Overview
6-
75
`cpa` is a cli tool for ultra fast setup of new Python projects. It automates the creation of config files for style & lint checks, gitignore, a basic Dockerfile and Poetry for dependency management. An opinionated set of pre-commit hooks are included for enforcing best practices and reducing dev time.
86

97
An example output is provided in [./example](https://github.com/ysawa0/create-python-app/tree/main/example)
108

11-
## Installation
9+
# Installation
1210

1311
### MacOS, Linux
1412

@@ -35,7 +33,7 @@ Download latest binary from [Releases](https://github.com/ysawa0/create-python-a
3533
cargo install --path .
3634
```
3735

38-
## Usage
36+
# Usage
3937

4038
To create a new project:
4139

@@ -53,13 +51,13 @@ Example:
5351
cpa create --name myproject --preset python3.10
5452
```
5553

56-
## Goals
54+
# Goals
5755

5856
- **Speed up Project Creation**: Reduce the time spent on repetitive setup tasks
5957
- **Best Practices**: Encourage best practices for code quality, formatting, and style by including configs for tools like `black`, `isort`, and `flake8`.
6058
- **Automation**: Automate tasks such as generating `.gitignore` files, setting up pre-commit hooks, and configuring code linters and formatters.
6159
- Golang, Rust support planned
6260

63-
## Contributions and Feedback
61+
# Contributions and Feedback
6462

6563
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.

0 commit comments

Comments
 (0)