Metadata-Version: 2.1
Name: pyplater-cli
Version: 0.0.1
Summary: Create Python Script CLI
License: MIT
Author: David Rose-Franklin
Author-email: david.rosefranklin96@gmail.com
Requires-Python: >=3.10,<4.0
Classifier: Development Status :: 3 - Alpha
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: Microsoft :: Windows
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Requires-Dist: click (>=8.0.3,<9.0.0)
Requires-Dist: cookiecutter (>=2.2.2,<3.0.0)
Requires-Dist: questionary (>=1.10.0,<2.0.0)
Requires-Dist: toml (>=0.10.2,<0.11.0)
Description-Content-Type: text/markdown

<div style="display: flex; justify-content: center; align-items: center; gap: 1rem;">
<img src="https://davidrr-f.github.io/codepen-hosted-assets/pyplater-banner.svg" alt="My logo" width="900" height="300">
</div>

**_in development_**

<div align="center">
  <a href="link-to-your-repository">
    <img src="https://img.shields.io/badge/Python-v3.8.1%2B-brightgreen" alt="Python Version">
  </a>
  <a href="link-to-your-repository">
    <img src="https://img.shields.io/pypi/v/pyplater-cli?color=%2334D058&label=pypi%20package" alt="Package Version">
  </a>
  <a href="https://github.com/DavidRR-F/pyplater/actions/workflows/ci.yml">
    <img src="https://github.com/DavidRR-F/pyplater/workflows/CI_Pipeline/badge.svg?event=push&branch=main" alt="Test Status">
  </a>
</div>
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 Create

[![PyPlater Create](https://davidrr-f.github.io/codepen-hosted-assets/pyplater/create.gif)](https://davidrr-f.github.io/codepen-hosted-assets/pyplater/create.gif)

### Options

- --name: Project Name
- --template: Project Template

### Example

```
$ pyplater create --name your_project --type starter
```

## Pyplater Save

Save project directorys as snippets or templates

[![PyPlater Save](https://davidrr-f.github.io/codepen-hosted-assets/pyplater/save.gif)](https://davidrr-f.github.io/codepen-hosted-assets/pyplater/save.gif)

### Options

- [Directory]: the directory you with to copy
- [Name]: the name of the new template/snippet
- --type: (template, snippet)

### Example

```
$ pyplater save ./your_project newTemplate --type template
```

## PyPlater Add

Add snippet files to existing projects

[![PyPlater Create](https://davidrr-f.github.io/codepen-hosted-assets/pyplater/add.gif)](https://davidrr-f.github.io/codepen-hosted-assets/pyplater/add.gif)

### Options

- --snippet: Library for the chosen content

### Example

```
$ pyplater add --snippet pytest
```

### Starter Snippets

- pytest
- unittest
- pip
- poetry
- sqlalchemy

## PyPlater View

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

[![PyPlater View](https://davidrr-f.github.io/codepen-hosted-assets/pyplater/view.gif)](https://davidrr-f.github.io/codepen-hosted-assets/pyplater/view.gif)

### Options

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

### Examples

```
$ pyplater view snippets

$ pyplater view templates --name your_project
```

## 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
```

