Skip to content

Commit

Permalink
add readme
Browse files Browse the repository at this point in the history
  • Loading branch information
ysawa0 committed Nov 4, 2023
1 parent e9005f9 commit 0ff3e27
Show file tree
Hide file tree
Showing 2 changed files with 12 additions and 3 deletions.
11 changes: 11 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,41 +1,52 @@
# CPA: Create-Python-App

## Overview

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

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

## Features

- Provides pre-commit hook setup with hooks for checking merge conflicts, large files, and code styling.

## Installation

Download binary from Github

```bash

```

Building from source

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

## Usage

To create a new project:

```bash
cpa create --name <project_name>
```

Optional params:

- `--preset`: Specifies a Python version for the project. Defaults to "python" which is mapped internally to "python3.10".

Example:

```bash
cpa create --name my_project --preset python3.10
```

## Contributions and Feedback

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.
4 changes: 1 addition & 3 deletions src/python.rs
Original file line number Diff line number Diff line change
Expand Up @@ -13,8 +13,7 @@ struct PreCommitConfig {
}
#[derive(Template)]
#[template(path = ".gitignore", escape = "none")]
struct GitIgnore {
}
struct GitIgnore {}

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


#[derive(Template)]
#[template(path = ".cpa/prettier.json", escape = "none")]
struct Prettier {}
Expand Down

0 comments on commit 0ff3e27

Please sign in to comment.