Metadata-Version: 2.1
Name: venture-tools
Version: 2020.10.26
Summary: a CLI tool to initialize a new project
Home-page: https://github.com/murmuur-git/venture.git
Author: murmuur
Author-email: murmuur@protonmail.com
License: UNKNOWN
Download-URL: https://github.com/murmuur-git/venture/archive/v2020.10.26-alpha.tar.gz
Description: # Venture
        
        Venture is a command line app start new projects or "Ventures". Even creating a remote github repository if specified.
        
        ## Installation
        **Method 1: pip install (NOT FUNCTIONAL)**
        
        Use the package manager [pip](https://pip.pypa.io/en/stable/) to install venture.
        
        ```bash
        pip install venture-tools
        ```
        
        **Method 2: install.sh**
        ```bash
        git clone https://github.com/murmuur-git/venture.git
        sh venture-tools/install.sh
        ```
        
        ## Usage
        
        ### Init
        **Start a new venture**
        ```bash
        venture init [destination]
        ```
        **Start a new python venture**
        ```bash
        venture init -p [destination]
        ```
        **Start a venture and make a remote repository**
        ```bash
        venture init -r [destination]
        ```
        Uses a github authentication token, so you will need to generate one in your github settings
        
        ### Config
        **Opens config.ini in vim for editing**
        ```bash
        venture config
        ```
        **Resets config.ini, use if missing/damaged**
        ```bash
        venture config --reset
        ```
        **Output contents of config.ini**
        ```bash
        venture config --output
        ```
        ## Config.ini
        ```
        [defaults]
        make_remote = False
        is_verbose = False
        init_type = b
        
        [github.com]
        user =
        access_token =
        ```
        **defaults**
        - ```make_remote```: if true will always make remote repository (default ```False```)
        - ```is_verbose```: if true will always print verbose output (default ```False```)
        - ```init_type```: chooses which type of venture to make when no parameter is given (default ```b```)
           - ```b```: blank venture (Only a README.md is made)
           - ```p```: python venture
        
        **github.com**  
        - ```user```: GitHub username
        - ```access_token```: GitHub [API access token](https://docs.github.com/en/free-pro-team@latest/github/authenticating-to-github/creating-a-personal-access-token)
        
        ## Contributing
        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
        [MIT](https://choosealicense.com/licenses/mit/)
        
Platform: UNKNOWN
Requires-Python: >=3.6
Description-Content-Type: text/markdown
