Title: README.md Path: README.md Author: Max Ludden Date: 2022-11-22 CSS: static/style.css ...

MaxSetup 0.6.0

Version 0.6.0 Updates

Updated MaxSetup so the when you call the function new_run() it preforms the following:

• Checks to make sure that run.txt file exists in the Current Working Directory (CWD)'s log directory.
  • If it doesn't exist, MaxSetup will:
    • Read the CWD's pyproject.toml and poetry.lock into active memory.
    • Delete the files and directories in the CWD.
    • Copy the default file structure and files from the template directory into CWD.
    • Rewrite the pyproject.toml and poetry.lock back into the CWD.
• After ensuring that run.txt exists, it will:
  • Read what the last run was from the file.
  • Increment the last run to determine the current run.
  • Write the current run to disk
  • Setup up the loguru sinks and add the current run to the log's extra dictionary.
  • Clear the console.
  • Print a white horizontal rule to the console with a gradient Run title.
  • Return the configured log and its sinks to what called it.

Changes in 0.5.0

Changed setup to return only "log" (These changes were overwritten as they caused confusion.)

Purpose

This is a module that automates the file structure and settings of a new project.

Changes from v0.3.0

Updated module configuration.

Installation

Install from Pip

pip install maxsetup

Install from Pipx

pipx install maxsetup

Install from Pipx

python add maxsetup

Usage

All you need from maxsetup is the following:

from maxsetup import new_run

log = new_run()

MaxSetup keeps track of the current run and logs all output to the console and to loguru sinks.

In addition it creates a file structure for the project that looks like this:

Max Setup File Structure
. (Current working directory)
│ 
├── .env
├── .gitignore
├── .vscode
│   ├── launch.json
│   ├── settings.json
│   └── tasks.json
├── LICENSE
├── logs
│   ├── log.log
│   ├── run.txt
│   └── verbose.log
└── static
    ├── Century Gothic Bold.ttf
    ├── Century Gothic.ttf
    ├── MesloLGS NF Bold Italic.ttf
    ├── MesloLGS NF Bold.ttf
    ├── MesloLGS NF Italic.ttf
    ├── MesloLGS NF Regular.ttf
    ├── Urbanist-Black.ttf
    ├── Urbanist-BlackItalic.ttf
    ├── Urbanist-Italic.ttf
    ├── Urbanist-Light.ttf
    ├── Urbanist-LightItalic.ttf
    ├── Urbanist-Regular.ttf
    ├── White Modesty.ttf
    └── style.css