Usage - oliverchen415/go_pyproj GitHub Wiki

Flags

From a terminal, cd into your workspace, e.g. Documents. Then enter

go_pyproj -name=<project_name> -type=<file_type>

Do not add an extra period before the file type. (For example, type -type=py and not -type=.py)

This will create a folder with the project name, a file of the appropriate type with the same project name, a README.md file, and a .gitignore. The tool will not create a folder if you already have a folder of the same name; it will exit out immediately. This will prevent you from affecting existing folders.

Use this tool at your own risk. I am not responsible for any issues.

You can leave either one flag blank or both flags blank. Help information can be seen if you enter

go_pyproj -help

The output looks like this on Windows:

Usage of C:\Users\<user_name>\...\go_pyproj\go_pyproj.exe:
  -name string
        your project name (default "dummyProj")
  -type string
        file type (default "py")

You can guess what happens you leave both values blank. (Hint: look at the first example below.)

The resulting file structure looks like this:

<project_name>
├── .gitignore
├── <project_name>.<file_type>
└── README.md

Examples

Using go_pyproj will result in a Python project dummyProj with this structure:

dummyProj
├── .gitignore
├── dummyProj.py
└── README.md

Using go_pyproj -name=afterHours -type=go will result in a Go project afterHours with this structure:

afterHours
├── .gitignore
├── afterHours.go
└── README.md

Using `go_pyproj -name=afterHours AFTER the first time will result in this error message:

<date time here> Directory with the same name exists

Differently capitalization will also trigger the error, e.g. "AFTERHOURS" and "AFTERhours" are invalid names if a folder named 'afterHours" exists at that location.

Be sure to look up what the language's file extension is before you use go_pyproj.

⚠️ **GitHub.com Fallback** ⚠️