diff --git a/.editorconfig b/.editorconfig new file mode 100644 index 0000000..4c1ddfb --- /dev/null +++ b/.editorconfig @@ -0,0 +1,15 @@ +root = true + +[*] +charset = utf-8 +end_of_line = lf +insert_final_newline = true +trim_trailing_whitespace = true +indent_style = space +indent_size = 4 + +[*.{yml,yaml,toml,md,json}] +indent_size = 2 + +[Makefile] +indent_style = tab diff --git a/.gitignore b/.gitignore index dfd1ba4..356d812 100644 --- a/.gitignore +++ b/.gitignore @@ -1,8 +1,40 @@ +# Virtual environments / uv .venv/ +venv/ +.python-version.local + +# Python __pycache__/ *.py[cod] +*$py.class +*.egg-info/ +.eggs/ +dist/ +build/ +*.egg + +# Test / type / lint caches .pytest_cache/ .mypy_cache/ .ruff_cache/ -dist/ -*.egg-info/ +.coverage +htmlcov/ +coverage.xml +.dmypy.json +.pyright/ + +# Editors / OS +.idea/ +.vscode/* +!.vscode/settings.json +!.vscode/extensions.json +*.swp +.DS_Store + +# Env / secrets +.env +.env.* +!.env.example + +# MegaLinter / CI artifacts +megalinter-reports/ diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..e091a70 --- /dev/null +++ b/LICENSE @@ -0,0 +1,21 @@ +MIT License + +Copyright (c) 2026 Create-Python-App contributors + +Permission is hereby granted, free of charge, to any person obtaining a copy +of this software and associated documentation files (the "Software"), to deal +in the Software without restriction, including without limitation the rights +to use, copy, modify, merge, publish, distribute, sublicense, and/or sell +copies of the Software, and to permit persons to whom the Software is +furnished to do so, subject to the following conditions: + +The above copyright notice and this permission notice shall be included in all +copies or substantial portions of the Software. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE +AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER +LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, +OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE +SOFTWARE. diff --git a/README.md b/README.md index f6a55c1..2a1bd54 100644 --- a/README.md +++ b/README.md @@ -4,6 +4,26 @@ Composable scaffolding CLI for production-ready Python apps. > **Status:** bootstrapping. Roadmap: [#1](https://github.com/Create-Python-App/create-python-app/issues/1). + +## Install (preview) + +Once published to PyPI: + +```bash +uvx create-awesome-python-app@latest my-app +``` + +Until the first release, use the workspace CLI stub: + +```bash +uv sync +uv run create-awesome-python-app +``` + +## License + +MIT — see [LICENSE](./LICENSE). + ## Monorepo layout (uv workspaces) This repository is a **virtual uv workspace**: the root is not published; packages live under `packages/*` and share one `uv.lock` / `.venv`.