Skip to content

Commit

Permalink
Update README.md (#14)
Browse files Browse the repository at this point in the history
  • Loading branch information
ysawa0 authored Nov 22, 2023
1 parent 05fc1d7 commit dd9fed8
Showing 1 changed file with 10 additions and 10 deletions.
20 changes: 10 additions & 10 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,15 +2,15 @@

![CPA Logo](cpa.png)

`cpa` is a cli tool for ultra fast setup of new Python & Rust 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.
`cpa` is a cli tool for ultra fast setup of new Python & Rust projects. It automates the creation of config files like style & lint checks, gitignore, Dockerfile, dependency mangement, etc. An opinionated set of pre-commit hooks are included for enforcing best practices & reducing dev time.

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

# Installation

### MacOS, Linux
#### MacOS, Linux

Install via script below or get it from [Releases](https://github.com/ysawa0/create-python-app/releases)
Install via script below or get from [Releases](https://github.com/ysawa0/create-python-app/releases)

```bash
curl -sSL https://raw.githubusercontent.com/ysawa0/create-python-app/main/install.sh | bash
Expand All @@ -21,14 +21,13 @@ curl -sSL https://raw.githubusercontent.com/ysawa0/create-python-app/main/instal
# The installer will add ~/bin to your PATH
```

### Windows
#### Windows

Download latest binary from [Releases](https://github.com/ysawa0/create-python-app/releases) page
Download latest binary from [Releases](https://github.com/ysawa0/create-python-app/releases)

### Building from source
#### Building from source

```bash
# cd to project
cargo install --path .
```

Expand All @@ -55,14 +54,15 @@ Update current working directory with CPA preset.

```bash
cpa update --name myproject --preset python3.10
cpa create --name myproject --preset rust
cpa update --name myproject --preset rust
```

# Goals

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

# Contributions and Feedback
Expand Down

0 comments on commit dd9fed8

Please sign in to comment.