Metadata-Version: 2.1
Name: pypcreate
Version: 0.2.3
Summary: Python Package creation tool
Home-page: https://github.com/zhz03/PyPCreate
Author: Zhaoliang Zheng
Author-email: zhz03@g.ucla.edu
License: GNU GENERAL PUBLIC LICENSE V3
Classifier: Topic :: Software Development :: Libraries :: Python Modules
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3.7
Description-Content-Type: text/markdown
License-File: LICENSE

# PyPCreate

Pypcreate is a easy-to-use Python package creation tool.

## Installation

```shell
pip install pypcreate

# to upgrade 
pip install --upgrade pypcreate
```

## Usage

### 1 mkdir

To create a directory with empty`__init__.py` and `README.md` :

```shell
pypcreate --mkdir directory_name
```

### 2 yamlmkdir

To create a set up directories from a yaml file:

```shell
pycreate --yamlmkdir yamlname.yaml
```

The format of yaml file should follow the following format:

```yaml
name: example

root:
  dir_1:
    dir_name: 'example1' # directory name
    files: ['__init__.py','README.md','example.py'] # specify the empty files in the directory 
    dir_1: 
      dir_name: 'sub_example1' # directory name
      files: ['hello.py'] 

  dir_2:
    dir_name: 'example2' # here is the name of directory 2 
    files: ['__init__.py'] 
```

Notes:

- You must specify root
- For the sub-folder, you need to start with `dir_1` variable
- For the directory name, the variable name should be `dir_name`
- For creating files, the variable name should be `files`

### 3 setpyp

To create all empty setup files: `setup.py`, `MANIFEST.in`, `environment.yml` :

```
pycreate --setpyp
```

### 4 pyptemp

To download all setup files to current directory: `setup.py`, `MANIFEST.in`, `environment.yml` :

```
pycreate --pyptemp
```

### 5 inittemp

To download `__init__.py` template:

```
pycreate --inittemp
```

