add readme

Author: ysawa0

Cargo.toml

@@ -7,5 +7,3 @@ edition = "2018"
 askama = "0.12.1"
 clap = { version = "4.4.6", features = ["derive"] }
 regex = "1.10.2"
-serde = { version = "1", features = ["derive"] }
-serde_yaml = "0.8"

README.md

@@ -1 +1,41 @@
 # 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.

flake8.cfg

@@ -1,25 +1,25 @@
 [flake8]
-ignore = E203,E231,E501,I100,I201,I202,D102,D100,C901,D104,D101,D105,D107,D400,D103,D205,W503,E402,E266,F841
-# E203 whitespace before ':'. Conflicts with how Black formats slicing.
-# E231 missing whitespace after ',', ';', or ':'. Conflicts with Black.
-# E501 line too long (82 > 79 characters). Ignored because max-line-length is set.
-# I100 Import statements are in the wrong order.
-# I201 Missing newline between import groups.
-# I202 Additional newline in a group of imports.
-# D102 Missing docstring in public method.
-# D100 Missing docstring in public module.
-# C901 function is too complex. Ignored because max-complexity is set.
-# D104 Missing docstring in public package.
-# D101 Missing docstring in public class.
-# D105 Missing docstring in magic method.
-# D107 Missing docstring in __init__.
-# D400 First line should end with a period.
-# D103 Missing docstring in public function.
-# D205 1 blank line required between summary line and description.
-# W503 line break before binary operator. This is no longer PEP 8 compliant.
-# E402 module level import not at top of file.
-# E266 too many leading '#' for block comment.
-# F841 local variable is assigned to but never used.
+ignore =
+# C901,  # function is too complex. Ignored because max-complexity is set.
+  D100,  # Missing docstring in public module.
+  D101,  # Missing docstring in public class.
+  D102,  # Missing docstring in public method.
+  D103,  # Missing docstring in public function.
+  D104,  # Missing docstring in public package.
+  D105,  # Missing docstring in magic method.
+  D107,  # Missing docstring in __init__.
+  D205,  # 1 blank line required between summary line and description.
+  D400,  # First line should end with a period.
+  E203,  # whitespace before ':'. Conflicts with how Black formats slicing.
+  E231,  # missing whitespace after ',', ';', or ':'. Conflicts with Black.
+  E266,  # too many leading '#' for block comment.
+  E402,  # module level import not at top of file.
+  E501,  # line too long (82 > 79 characters). Ignored because max-line-length is set.
+  F841,  # local variable is assigned to but never used.
+  I100,  # Import statements are in the wrong order.
+  I201,  # Missing newline between import groups.
+  I202,  # Additional newline in a group of imports.
+  W503   # line break before binary operator. This is no longer PEP 8 compliant.
 
 exclude =
     .cache,