Metadata-Version: 1.1
Name: plaster-spring-boot
Version: 0.1.3
Summary: Generates scaffolding for new models for Spring Boot projects
Home-page: https://github.com/JDrost1818/plaster
Author: Jake Drost
Author-email: JDrost1818@gmail.com
License: MIT
Description: # Plaster
        
        Project to bring similar functionality found in Rails to the Spring Boot platform. Currently only supports maven-enabled projects.
        
        For Example:
        
            > plaster g scaffold User name:string age:integer
        
        Will create the following files:
        * Model - root/model/User.java
        * Repository - root/repository/UserRepository.java
        * Service - root/service/UserService.java
        * Controller - root/controller/UsersController.java
        
        The root is calculated upon script start. For example, if being run on a project with the following in `pom.xml`:
        
            <groupId>com.example</groupId>
        
        the root will be `src/main/com/example/`
        
        ### Installation
        If you have [pip](https://pip.pypa.io/en/stable/installing/) installed, you can install Plaster with following:
        
            pip install plaster-spring-boot
        
        Otherwise, ensure Python's `setuptools` is installed to install Plaster. If on an ubuntu system, use the following:
            
            sudo apt-get install python-setuptools
            
        Otherwise, explore [setuptools](https://pypi.python.org/pypi/setuptools) to find how to install for your system.
        Then download Plaster onto your machine, navigate to the directory in which it was downloaded and run:
            
            python setup.py install
            
        
        ### Customization
        Per default, Plater will auto-discover necessary configurations and then use best-practices to decide
        where and how to generate files. However, if you would like to customize the generation of the files, Plater
        gives you the ability to alter defaults by placing `plaster.yml` in the root of the project. The following configurations
        are supported:
        
        ##### Property `dir`
        ----
        | Property     	| Description                                 	| Type   	| Default                               |
        |--------------	|---------------------------------------------	|--------	|----------                             |
        | model      	| Directory in which to generate models       	| String 	| model                                 |
        | repository 	| Directory in which to generate repositories 	| String 	| repository                            |
        | controller 	| Directory in which to generate controllers  	| String 	| controller                            |
        | service    	| Directory in which to generate services     	| String 	| service                               |
        
        ##### Property `lombok`
        ----
        | Property       	| Description                                 	| Type   	| Default                               |
        |----------------	|---------------------------------------------	|--------	|----------                             |
        | enabled           | Should we enable generation in lombok mode   	| Boolean 	| Is lombok a dependency in `pom.xml`?  |
        
        
        ### Lombok Support
        Generation of models will change if a lombok dependency is found in `pom.xml`. This will import lombok and annotate
        the model differently. For example:
        
            //NO LOMBOK
            @Entity
            public class Example {
        
                @Id
                @GeneratedValue(strategy = GenerationType.AUTO)
                private Integer id;
        
                public Integer getId() {
                    return this.id;
                }
        
                public void setId(Integer id) {
                    this.id = id;
                }
        
            }
        <!-- separate -->
        
            import lombok.AllArgsConstructor;
            import lombok.Builder;
            import lombok.Data;
            import lombok.NoArgsConstructor;
        
            @AllArgsConstructor
            @Builder
            @Data
            @NoArgsConstructor
            public class Example {
        
                @Id
                @GeneratedValue(strategy = GenerationType.AUTO)
                private Integer id;
        
            }
        
        For lombok information, visit the project's [homepage](https://projectlombok.org/).
        
        
Keywords: sample setuptools development
Platform: UNKNOWN
Classifier: Development Status :: 4 - Beta
Classifier: Intended Audience :: Developers
Classifier: Topic :: Software Development :: Code Generators
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python :: 2
