Metadata-Version: 2.1
Name: Artec
Version: 0.2.0
Summary: Creates a configurable python project template in a given directory.
Author-email: HushmKun <HushmKun@outlook.com>, Link- <bsm.dgdy@gmail.com>
Project-URL: Homepage, https://github.com/HushmKun/Artec
Project-URL: Bug Tracker, https://github.com/HushmKun/Artec/issues
Classifier: Intended Audience :: Developers
Classifier: Development Status :: 4 - Beta
Classifier: Environment :: Console
Classifier: Programming Language :: Python :: 3
Classifier: Topic :: Software Development :: Build Tools
Requires-Python: >=3.7
Description-Content-Type: text/markdown
License-File: LICENSE

# Artec

Artec is a simple python 3 script to create a project template in a given directory.<br>
_It's a maintained version of PyBoiler_

## Installation

Download from pip 

```bash
pip install artec
```

or Install manually
```bash
$ git clone https://github.com/HushmKun/Artec
$ cd Artec
$ pip install . 
```
## Usage
Create a JSON file to match the folder structure you desire
```
$ vim structure.json 
    
# Paste the below into your file and modify as you desire
[{'folder': 'source'}, 
{'file': 'source/file1.txt'}, # Nested file
{'folder': 'sublime'}, 
{'file': 'sublime/file2.txt'}, 
{'folder': 'docs'}, 
{'file': 'docs/file3.txt'}, 
{'file': 'docs/file4.txt'},
{'file': 'README.md'}]
```
 How to execute
```
usage: artec [OPTIONS] -o [DEST] 

Artec is a simple python 3 script to create a project template in a given directory.

options:
  -h, --help            show this help message and exit
  -o TARGET, --output-directory TARGET
                        Target output path where the structure will be created
  -s SOURCE, --source-file SOURCE
                        Source JSON file containing structure to be created
  -t TEMPLATE, --template TEMPLATE
                        Uses ready-made templates.
  -ls, --list-template  lists all ready-made templates.
  -v, --verbose         Runs Artec in verbose mode.
  -V, --version         Display current version of Artec

Examples:
        artec -h
        artec -o dest
        artec -o dest -t python
        artec -o dest -s structure.json
        artec -o dest -s structure.json -v

```
## Version

    0.2.0

## Contributing

* Big Thanks to [Link-](https://github.com/Link-) for jump starting the project.
* Thanks for [Narayandas Akhil Achary](https://github.com/0018akhil) for various fixes & features.

Any help that can contribute to the templates will be really appreciated.

Pull requests are welcome. For major changes, please open an issue first
to discuss what you would like to change.

Please make sure to update tests as appropriate.

## License

[GNU GPLv3.0](https://choosealicense.com/licenses/gpl-3.0/)
