Metadata-Version: 2.1
Name: 1build
Version: 1.1.0
Summary: Frictionless way of managing project-specific commands.
Home-page: https://github.com/gopinath-langote/1build
Author: Gopinath Langote
Author-email: gopinathlangote11@gmail.com
License: MIT License
Description: <h1 align="center">
          <br>
          <a href="https://github.com/gopinath-langote/1build">
            <img src="https://github.com/gopinath-langote/1build/blob/master/docs/assets/1build-logo.png?raw=true" alt="1build" width="500"></a>
          <br>
        </h1>
        
        <br>
        
        <p align="center">
          <a href="https://pypi.org/project/1build/">
            <img src="https://img.shields.io/pypi/v/1build.svg" alt="PyPi Version">
          </a>
          <a href="https://pypi.org/project/1build/">
            <img src="https://img.shields.io/pypi/pyversions/1build.svg" alt="Supported Python Versions">
          </a>
          <a href="https://travis-ci.org/gopinath-langote/1build">
              <img src="https://travis-ci.org/gopinath-langote/1build.svg?branch=master" alt="Build Status">
          </a>
          <a href="https://codecov.io/gh/gopinath-langote/1build">
              <img src="https://img.shields.io/codecov/c/gh/gopinath-langote/1build.svg" alt="Code Coverage">
          </a>
          <a href="https://requires.io/github/gopinath-langote/1build/requirements/?branch=master">
            <img src="https://requires.io/github/gopinath-langote/1build/requirements.svg?branch=master" alt="Requirements Status">
          </a>
          <a href="https://pypi.org/project/1build">
            <img src="https://img.shields.io/pypi/dm/1build.svg" alt="Downloads">
          </a>
        </p>
        
        <br>
        
        1build is an automation tool that arms you with the convenience to configure project-local command line aliases – and then 
        run the commands quickly and easily. It is particularly helpful when you deal with multiple projects and switch between 
        them all the time. It is often the fact that different projects use different build tools and have different environment 
        requirements – and then switching from one project to another is becoming increasingly cumbersome. That is where 1build comes 
        into play.
        
        With 1build you can create simple and easily memorable command aliases for commonly used project commands such as build, 
        test, run or anything else. These aliases will have a project-local scope which means that they will be accessible only 
        within the project directory. This way you can unify all your projects to build with the same simple command disregarding 
        of what build tool they use. It will remove the hassle of remembering all those commands improving the mental focus for 
        the things that actually matter.
        
        ## Install
        
        ```bash
        pip install 1build
        ```
        
        or
        
        ```bash
        pip3 install 1build
        ```
        
        ## Usage
        
        ### Configuration
        
        - create project configuration file in the project folder with name `1build.yaml`
        
        - Example of `1build.yaml` for JVM maven project:
            ```yaml
            project: Sample JVM Project Name
            commands:
              - build: mvn clean package
              - lint: mvn antrun:run@ktlint-format
              - test: mvn clean test
            ```
        
        ### Running 1build for the above sample project:
        
        - building the project
          ```console
          1build build
          ```
        
        - fix the coding guidelinges lint
          ```console
          1build lint
          ```
        
        ### Using `before` and `after` commands
        Consider that your project `X` requires `Java 11` and the other project requires `Java 8`. It is a headache to always 
        remember to switch the java version. What you want is to switch to `Java 11` automatically when you build the project 
        `X` and switch it back to `Java 8` when the build is complete. Another example – a project requires `Docker` to be up 
        and running or you need to clean up the database after running a test harness.
        
        This is where `before` & `after` commands are useful. These commands are both optional – 
        you can use one of them, both or neither.
        
        #### Examples:
        1. Switching to `Java 11` and then back to `Java 8`
            ```yaml
            project: Sample JVM Project Name
            before: ./switch_to_java_11.sh
            after: ./switch_to_java_8.sh
            commands:
              - build: mvn clean package
            ```
        
        2. Ensure that `Docker` is up and running
            ```yaml
            project: Containerized Project
            before: ./docker_run.sh
            commands:
              - build: ./gradlew clean 
            ```
        
        3. Clean up database after some commands
             ```yaml
            project: Containerized Project
            after: ./clean_database.sh
            commands:
              - build: ./gradlew clean 
            ```
        
        ### Command usage
         ```text
        usage: 1build [-h] [-l] [-v] [command]
        
        positional arguments:
          command     Command to run - from `1build.yaml` file
        
        optional arguments:
          -h, --help  Print this help message
          -l, --list  Show all available commands - from `1build.yaml` file
          -v, --version  Show version of 1build and exit
          -i, --init     Create default `1build.yaml` configuration file
        ```
        
        ## Contributing
        
        Please read [CONTRIBUTING.md](https://github.com/gopinath-langote/1build/blob/master/CONTRIBUTING.md) for details on our code of conduct, and the process for submitting pull requests to us.
        
        ## Versioning
        
        We use [Semantic Versioning](http://semver.org/) for all our releases. For the versions available, see the [tags on this repository](https://github.com/gopinath-langote/1build/tags). 
        
        ## Changelog
        All notable changes to this project in each release will be documented in [CHANGELOG.md](https://github.com/gopinath-langote/1build/blob/master/docs/CHANGELOG.md).
        
        The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/).
        
        ## License
        
        This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details
        
        ## Authors
        
        * **Gopinath Langote** - *Initial work & Maintainer* – [Github](https://github.com/gopinath-langote/) –[Twitter](https://twitter.com/GopinathLangote)
        * **Alexander Lukianchuk** - *Maintainer* – [Github](https://github.com/landpro) – [Twitter](https://twitter.com/landpro)
        
        See also the list of [contributors](https://github.com/gopinath-langote/1build/contributors) who participated in this project.
        
        
Platform: UNKNOWN
Classifier: Programming Language :: Python :: 3.5
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
Classifier: License :: OSI Approved :: MIT License
Classifier: Topic :: Software Development :: Build Tools
Classifier: Intended Audience :: Developers
Classifier: Operating System :: OS Independent
Description-Content-Type: text/markdown
