pyplater-cli 1.0.0

Create Python Script CLI

in development

PyPlater is a Python CLI Tool to generate, build, and create boilerplate code for python projects Including linting, formatting, unit testing, and package managing from prebuilt and your own custom templates

Get Setup

Install PyPlater

$ pip install pyplater-cli

Commands

PyPlater CLI supports two templating types:

• template: a project file structure using the cookiecutter library
• snippet: a small directory literal for commonly used modules

Pyplater Save

Save project directorys as snippets or templates

Options

• Type: template/snippet
• Directory: the directory you with to copy
• Name: the name of the new template/snippet

Example

Save a template

$ pyplater save template path/to/folder <name>

Save a snippet

$ pyplater save snippet path/to/folder <name>

PyPlater Insert

Add snippet files to existing projects or generate not template project

Options

• Type: template/snippet
• -n/--name: namee of template/snippet

Example

Insert a template

$ pyplater insert template -n <custom_name> -t <saved_template>

Insert a snippet

$ pyplater insert snippet -n <saved_snippet>

PyPlater Git

Initialize a git repository to hold your templates/snippets that you can then push an pull from

Options

• Actions: push/pull
• Options: template/snippet
• -n/--name: template/snippet name

Examples

Initialize Git Repository (Personal access token is not stored)

$ pyplater git init -u <github_username> -t <personal_access_token>

Push templates to repository

$ pyplater git push all

or

$ pyplater git push snippet -n <snippet_name>

Pull templates from repository

$ pyplater pull all

or

$ pyplater pull snippet <snippet_name>

PyPlater View

View all saved snippets/templates or view a specific snippet's/template's file structure

Options

• [Type]: (snippets, templates)
• --name: specific tamplate or snippet

Examples

$ pyplater view snippets

$ pyplater view templates --name your_project

PyPlater Edit

Open your template and snippets in vs code

Options

• Types: template/snippet
• -n/--name: name of template or snippet

Examples

$ pyplater edit snippet -n <name>

PyPlater Run

Define commands in the pyproject.toml to run your custom scripts with pyplater

$ pyplater run script
$ pyplater run test

pyproject.toml

[pyplater.scripts]
script = "python ./main/script/main.py"
test = "python -m unittest:discover tests/"

PyPlater Remove

Remove Templates and/or Snippets from your device

Options

• [Name]: name of the template/snippet
• --type: (template, snippet)

Example

$ pyplater remove your_project --type template