NewProj ⚡
A lightweight Python project generator for developers
📌 Overview
NewProj is a boilerplate generator that helps you quickly set up new Python projects without wasting time on repetitive setup.
Whether you’re building a small script, a Pygame project, or something larger, NewProj gives you a clean starting point in seconds.
👉 No more copy-pasting folders and requirements.txt. Just run one command and you’re ready to code.
✨ Features
🛠 Interactive wizard – create projects with guided prompts.
⚡ Fast CLI mode – skip the prompts and generate instantly.
📂 Built-in templates:
basic → Standard Python project (src, tests, docs, README, requirements).
pygame → Starter setup for Pygame projects (assets folder, main game loop).
🧩 Extensible – add your own templates easily.
✅ Cross-platform – works on Windows, macOS, and Linux.
🚀 Installation
pip install newproj
Or clone the repo and install locally:
git clone https://github.com/your-username/newproj.git
cd newproj
pip install -e .
🖥 Usage
🔹 Interactive mode (recommended)
python -m newproj.cli
You’ll be prompted for:
Project name
Template (basic, pygame)
Confirmation before creation
🔹 Quick CLI mode
python -m newproj.cli my_api --template basic
python -m newproj.cli space_game --template pygame
📂 Example Output
my_project/
├── docs/
├── src/
├── tests/
├── main.py
├── requirements.txt
├── README.md
└── .gitignore
🔮 Roadmap
Add more built-in templates (Flask API, FastAPI, Data Science).
Improve interactive wizard with arrow-key menus.
Publish package to PyPI.
Add template versioning (e.g., pygame@2).
🤝 Contributing
Contributions are welcome!
Fork this repo
Create a new branch (feature/my-cool-template)
Submit a PR 🎉
Raw data
{
"_id": null,
"home_page": "https://github.com/Golden021/newproj",
"name": "newproj-bobv1",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.7",
"maintainer_email": null,
"keywords": "python project generator boilerplate template cli interactive pygame",
"author": "Liam G",
"author_email": "TemNet021@outlook.com",
"download_url": "https://files.pythonhosted.org/packages/83/cb/599765917b138112dfa1279f7ad37c9ec7e2b3592c873a1c72bef168b849/newproj_bobv1-1.0.0.tar.gz",
"platform": null,
"description": "NewProj \u26a1\r\n\r\nA lightweight Python project generator for developers\r\n\r\n\ud83d\udccc Overview\r\n\r\nNewProj is a boilerplate generator that helps you quickly set up new Python projects without wasting time on repetitive setup.\r\nWhether you\u2019re building a small script, a Pygame project, or something larger, NewProj gives you a clean starting point in seconds.\r\n\r\n\ud83d\udc49 No more copy-pasting folders and requirements.txt. Just run one command and you\u2019re ready to code.\r\n\r\n\u2728 Features\r\n\r\n\ud83d\udee0 Interactive wizard \u2013 create projects with guided prompts.\r\n\r\n\u26a1 Fast CLI mode \u2013 skip the prompts and generate instantly.\r\n\r\n\ud83d\udcc2 Built-in templates:\r\n\r\nbasic \u2192 Standard Python project (src, tests, docs, README, requirements).\r\n\r\npygame \u2192 Starter setup for Pygame projects (assets folder, main game loop).\r\n\r\n\ud83e\udde9 Extensible \u2013 add your own templates easily.\r\n\r\n\u2705 Cross-platform \u2013 works on Windows, macOS, and Linux.\r\n\r\n\ud83d\ude80 Installation\r\npip install newproj\r\n\r\n\r\nOr clone the repo and install locally:\r\n\r\ngit clone https://github.com/your-username/newproj.git\r\ncd newproj\r\npip install -e .\r\n\r\n\ud83d\udda5 Usage\r\n\ud83d\udd39 Interactive mode (recommended)\r\npython -m newproj.cli\r\n\r\n\r\nYou\u2019ll be prompted for:\r\n\r\nProject name\r\n\r\nTemplate (basic, pygame)\r\n\r\nConfirmation before creation\r\n\r\n\ud83d\udd39 Quick CLI mode\r\npython -m newproj.cli my_api --template basic\r\npython -m newproj.cli space_game --template pygame\r\n\r\n\ud83d\udcc2 Example Output\r\nmy_project/\r\n\u251c\u2500\u2500 docs/\r\n\u251c\u2500\u2500 src/\r\n\u251c\u2500\u2500 tests/\r\n\u251c\u2500\u2500 main.py\r\n\u251c\u2500\u2500 requirements.txt\r\n\u251c\u2500\u2500 README.md\r\n\u2514\u2500\u2500 .gitignore\r\n\r\n\ud83d\udd2e Roadmap\r\n\r\n Add more built-in templates (Flask API, FastAPI, Data Science).\r\n\r\n Improve interactive wizard with arrow-key menus.\r\n\r\n Publish package to PyPI.\r\n\r\n Add template versioning (e.g., pygame@2).\r\n\r\n\ud83e\udd1d Contributing\r\n\r\nContributions are welcome!\r\n\r\nFork this repo\r\n\r\nCreate a new branch (feature/my-cool-template)\r\n\r\nSubmit a PR \ud83c\udf89\r\n",
"bugtrack_url": null,
"license": null,
"summary": "A fast, interactive Python project generator",
"version": "1.0.0",
"project_urls": {
"Bug Reports": "https://github.com/Golden021/newproj/issues",
"Documentation": "https://github.com/Golden021/newproj#readme",
"Homepage": "https://github.com/Golden021/newproj",
"Source": "https://github.com/Golden021/newproj"
},
"split_keywords": [
"python",
"project",
"generator",
"boilerplate",
"template",
"cli",
"interactive",
"pygame"
],
"urls": [
{
"comment_text": null,
"digests": {
"blake2b_256": "586da308ff13406a52092e7af1b06d78f675c2c291faa00083197cdb76db680c",
"md5": "617dd16ced4884980ddbde5f8cccd8bf",
"sha256": "382d264dd5fd6bdffeb5a965fc44c5c2b073cb7494b795ac21282c888ff4ca8a"
},
"downloads": -1,
"filename": "newproj_bobv1-1.0.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "617dd16ced4884980ddbde5f8cccd8bf",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.7",
"size": 9163,
"upload_time": "2025-09-05T02:49:29",
"upload_time_iso_8601": "2025-09-05T02:49:29.957513Z",
"url": "https://files.pythonhosted.org/packages/58/6d/a308ff13406a52092e7af1b06d78f675c2c291faa00083197cdb76db680c/newproj_bobv1-1.0.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": null,
"digests": {
"blake2b_256": "83cb599765917b138112dfa1279f7ad37c9ec7e2b3592c873a1c72bef168b849",
"md5": "334553fa68bebcf515cb37e2b24f2cf8",
"sha256": "8647b213d628efa74e96673bf8309000db22dc314c85f5b562063b08b937f4a8"
},
"downloads": -1,
"filename": "newproj_bobv1-1.0.0.tar.gz",
"has_sig": false,
"md5_digest": "334553fa68bebcf515cb37e2b24f2cf8",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.7",
"size": 9179,
"upload_time": "2025-09-05T02:49:30",
"upload_time_iso_8601": "2025-09-05T02:49:30.855534Z",
"url": "https://files.pythonhosted.org/packages/83/cb/599765917b138112dfa1279f7ad37c9ec7e2b3592c873a1c72bef168b849/newproj_bobv1-1.0.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2025-09-05 02:49:30",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "Golden021",
"github_project": "newproj",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"lcname": "newproj-bobv1"
}
JSON
