Skip to content
/ Artec Public

Artec is a python application that creates a configurable project template in a given directory.

License

Notifications You must be signed in to change notification settings

HushmKun/Artec

This branch is up to date with master.

Folders and files

NameName
Last commit message
Last commit date

Latest commit

779f245 · Apr 14, 2024

History

87 Commits
Jul 8, 2023
Jul 26, 2023
Apr 14, 2024
Jul 16, 2023
Apr 14, 2024
Apr 14, 2024
Apr 14, 2024
Jul 16, 2023
Aug 6, 2023
Jun 12, 2023
Apr 14, 2024
Apr 14, 2024
Aug 6, 2023
Jun 13, 2023

Repository files navigation

Logo

Artec

A python application that creates a configurable python project template in a given directory.
It's a maintained version of PyBoiler

Installation

Download from pip

$ pip install Artec

or Install manually

$ git clone https://github.com/HushmKun/Artec
$ cd Artec
$ pip install -U . 

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
{
    "folders": [
        "{}",
        "test"
    ], 
    "files": [
        "{}/__init__.py",
        "test/__init__.py",
        "README.md",
        "LICENSE",
        "setup.py",
        "pyproject.toml"
    ]
}

How to execute

$ artec -h
usage: artec [OPTIONS] -o [DEST] 

Artec is a python application that creates a configurable python project template in a given directory.

options:
  -h, --help            show this help message and exit
  -s SOURCE, --source-file SOURCE
                        Source JSON file containing structure to be created
  -t TEMPLATE, --template TEMPLATE
                        Uses ready-made templates.
  -o TARGET, --output-directory TARGET
                        Target output path where the structure will be created
  -ls, --list-template  lists all ready-made templates.
  -v, --verbose         Runs Artec in verbose mode.
  -g, --git-init        Creates a git Repo for the project.
  -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

Templates

  • Python
  • Flask
  • Node.Js
  • Data_Science

Version

0.3.1

Contributing

Please refer to Here for contributing. Any help that can contribute to the templates will be really appreciated.

Learning

Since this project is intended as a learning project, It helps me figure out what is the best practices of X, How to use Y, etc...

If you come here to learn, Read this, I will be glad if it helped you learn something new.

License

GNU GPLv3.0