diff --git a/README.md b/README.md index 2388fa2..c304a13 100644 --- a/README.md +++ b/README.md @@ -1,28 +1,36 @@ # 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 @@ -30,12 +38,15 @@ cpa create --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. diff --git a/src/python.rs b/src/python.rs index 706b229..5d6d767 100644 --- a/src/python.rs +++ b/src/python.rs @@ -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")] @@ -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 {}