Skip to content

sdmagic/pyNewCode

Repository files navigation

pyNewCode


Description

This python application preforms all the usual start-of-project tasks for a new project. It:

  • Creates the project's directory structure

    • Creates a project directory (if we're not using the current directory)
      • All directories will be subdirectories off the project directory
    • Creates a configuration directory (for the project's config files)
    • Creates a logs directory (for the project's log files)
    • Creates a modules directory (for the project's modules and utilities)
  • Creates a Project's base files

    • Will warn and ask if a file already exists
    • Creates the project's main file (starup point)
    • Creates the project's configuration file
    • Creates the project's modules\init.py file
    • Creates the project's YAML file
    • Creates a todo.md file for the project
      • Please follow the instructions in this file after generation

NOTE:

All writing is driven by the YAML configuration file -- If you don't want a particular file, you can just set that item to false.

Also, all filenames are driven by the YAML configuraiton file.


Requirements

Environment

  • python 3.12+
  • rich 13.3.5+
  • yaml 0.2.5+
  • All other packages are standard to python

Syntax

pyNewCode.exe [path]

	Examples:
		pyNewCode C:\dev\MyProject
		(will build the new project in C:\dev\myProject directory)

OR

python pyNewCode.py [path]

	Examples:
		python pyNewCode.py C:\dev\MyProject
		(will build the new project in C:\dev\MyProject directory)

In either case, path is optional.

If not specified, the current directory will be used.


Example Outputs

todo.md file

# Project Todos

## YAML file todos:

	- Change "author: Nobody" to your name
	- Change "project: MyNewProject" to your project name

project.yaml file

author: Nobody
directories:
  config: config
  logs: logs
  modules: modules
options:
  logVerbose: true
  logging: true
  screenclear: true
  screenpretty: true
  screenprint: true
project: MyNewProject
version: 0.0.1

Handy Newsletters

About

No description, website, or topics provided.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages