NOTE: these instructions presume prior knowledge of basic command line instructions and (obviously) Python already being installed.
Pygen creates a simple file structure for new Python projects at a directory of your choice! To get started, follow these steps (this assumes prior knowledge of basic command line functions):
- Clone this repo and change directory into the root 'pygen' folder. So the command line should be something like this:
/your/path/pygen
- In that same level as the root project folder, create a new .env file. When created, add the following line inside the file:
DEST_PATH=Your_Directory_Here
Your_Directory_Here will instead be the ABSOLUTE PATH of where you want to save your folder at. (No quotation marks are needed).e.g.: DEST_PATH=C:\Documents\PythonProjects - In the command line again, run the package installer with the line:This will install any necessary python libraries (in this case, only the python-dotenv library is required. This library is needed to pull the info from the .env file!
pip install -r requirements.txt
- Now, with the command line at the root directory of 'pygen', run the command: It will then save a new directory at the specified path from the DEST_PATH variable with the name of "your-folder-name"
python pygen your-folder-name
- After being run, the program will output a path (after the line saying "You can peep the file here). Navigate to the new folder to find a new project waiting for you! :D