CLI Update - v3.0.1

v3.0.1

Highlights

This release is a major cleanup and expansion of Project Creator. It adds full documentation, improves the CLI and Git flow, introduces bundled templates, and reorganizes the project into a more complete release-ready structure.

Added

• Added a full documentation site in docs/index.html
• Added detailed written documentation in docs/Documentation.md
• Added CONTRIBUTING.md for contributors and template authors
• Added bundled starter templates:
  • basic-web
  • npm-package
  • python-pypi
• Added template metadata and README files for the templates directory
• Added support for loading templates from the GitHub repository contents API
• Added an external source mode for pulling templates from another repo
• Added support for generated .env.example and blueprint.json files in the CLI workflow

Improved

• Reworked the main README into a proper project overview and usage guide
• Expanded the CLI documentation to cover install, run, modes, generated structure, and Git behavior
• Improved the manual setup flow with clearer generated output
• Updated Git workflow to initialize the branch as main
• Improved Git push behavior for generated projects
• Cleaned up the CLI code structure and removed a lot of old inline commentary
• Updated package metadata and release information
• Added a more polished documentation landing page with modern styling

Changed

• Project Creator now presents itself as a Python CLI scaffolding tool with numbered project folders
• Manual setup now includes:
  • web
  • venv
  • api
  • firm
  • docs
  • tests
• The generated starter structure now includes:
  • .env.example
  • blueprint.json
  • .gitignore
• The tool now documents and supports cloud template downloads from:
  • https://api.github.com/repos/DevX-Dragon/project-creator/contents/templates

Removed / Deprecated

• The old GUI version has been marked as discontinued
• The old GUI files were moved into a discontinued archive folder instead of remaining part of the active app

Notes

• This release is a big step up from the previous version and focuses on making Project Creator easier to understand, easier to extend, and more useful out of the box
• The CLI behavior is still centered on scaffolding, Git setup, and template generation, but the project now has much better documentation and template support

Files Updated

• README.md
• docs/Documentation.md
• docs/index.html
• CONTRIBUTING.md
• CLI/prj_creator/main.py
• CLI/pyproject.toml
• templates/README.md
• templates/basic-web/*
• templates/npm-package/*
• templates/python-pypi/*
• GUI Version (Discontinued)/*

Full Changelog: v2.1.3...v3.0.1

CLI RELEASE!!

Release Logs

Overview

Introducing project-creator CLI version!. Now you can create your project in literal seconds using a high speed CLI version.

Features

• Intelligent Numbering: Automatically detects existing projects in your directory and prefixes the new one with the next logical number (e.g., 01.project, 02.project).
• Modular Boilerplates
• made the default branch main

Flags	Function
--web	Generates a linked HTML/JS/CSS Boilerplate
--firmware	Generates an .ino Arduino ready sketch with basic setup / loop function
-hardware	Creates a dedicated hardware directory
--venv	Automatically initialzies a Python Virtual Environment
--req	Creates a requirement.txt file for dependency management

• Licensing: Built-in support for generating MIT or GPL v3 license files.
• GIT Integration: Optional remote URL setup to initialize your repository and set the orgin during creation. Also does an inital commit and push.

Installation

1. Prerequisite

Ensure you have Python 3.x installed on your system.

2. Global Installation (via PIP)

The easiest way to get the tool is directly from PyPi:

pip install prj-creator

3. Ensure PATH is set (Windows Users)

If the command isn't recognized after installation, ensure your Python Scripts folder is in your System Environment Variables:
C:\Users\<YourUser>\AppData\Local\Programs\Python\Python313\Scripts\

How to Run?

Once installed, you can launch the wizard from any directory by simply running this in the terminal:

prj-creator

What happens next?

1. Enter Project Name: (e.g., my-cool-app)

2. Select Modules: Type the flags you need (e.g., --web --venv)

3. Choose License: Pick MIT, GPL, or None.

4. Git URL: Paste your repo link if you want it pre-configured.

The result: A perfectly structured folder ready for development!

Instalation

Release Log - Project Creator - 110426-2030

This update focusses on adding user requested features for better use and optimization.

Features & Improvemnts

• Proper Tabbed UI: Moved to dual-tab layout to keep the UI clean.
• Advanced Tab: Added a dedicated tab for project specific customization. Allowing for more customization without having issues in the main tab.
• New "Web" Template: Added a "Website' module that automatically generates linked html , css and js starter kit in the web/ directory.
• Modifiable .gitignore: You can now view and edit the .gitignore rules directly within the app before initialization, ensuring your repository stays clean from the first commit.
• Environment Automation: New toggles to automatically create a Python Virtual Environment (venv) and a standard requirements.txt file.
• KiCad Project Files: The PCB module now generates actual .kicad_pro and .kicad_sch files with project-specific title blocks, making it ready to open in KiCad immediately.

Bug Fixes

• Fixed an issue where git push would fail due to missing upstream tracking; the tool now uses git push -u on the initial commit.

• Corrected asymmetrical padding issues that caused visual offsets in the repository and module sections.

• Standardized the folder numbering logic to ensure project sorting remains consistent across multiple builds.

Whats Next?

• .exe Issue: Unfortuantely I am having issues with releasing a proper .exe version of this project as the Microsoft Anti-Virus continuies to flag it. Trying my best to find a proper solution
• CLI Version Currently working on releasing this.