Metadata-Version: 1.0
Name: excel_transform
Version: 1.1.2
Summary: This is a tool to generate an excel file based on a provided source excel and transformation mapping
Home-page: https://github.com/adrian549092/excel_transform
Author: Adrian Martin
Author-email: adrian.m138@gmail.com
License: Copyright (c) 2021 Adrian Martin

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
Description: # excel-transform
        
        ### Installation
        Make sure you are using [python](https://www.python.org/downloads/) 3.8+.
        ```
        Î» python --version
        ```
        >Python 3.8.8
        
        Create a virtual environment in the desired directory.
        ```
        Î» mkdir ~/excel-transform
        Î» cd ~/excel-transform
        Î» python -m venv venv
        ```
        Activate the virtual environment and install dependencies.
        
        **Windows:**
        ```
        Î» venv\Scripts\activate.bat
        ```
        
        **Unix/Linux:**
        ```
        Î» source venv/bin/activate
        ```
        **Install Option 1 (Recommended):**
        
        ```
        (venv) Î» pip install excel-transform
        ```
        **Install Option 2:**
        
        Install from source via `github`
        ```
        (venv) Î» pip install git+https://<USERNAME>:<TOKEN>@github.com/adrian549092/excel-transform.git@master
        ```
        
        ### Create template mapping file
        Run this command to generate the skeleton of a mapping file
        ```
        (venv) Î» excel-transform mapping-skeleton -o some_mapping.json
        ```
        
        ### Transform Spreadsheet
        Transform a spreadsheet
        ```
        (venv) Î» excel-transform transform -o transformed.xlsx some_spreadsheet.xlsx mapping.json
        ```
        
        ### Get Help
        Use the `--help` flag anywhere along the `excel-transform` commands to get context aware help
        ```
        (venv) Î» excel-transform --help
        ```
        ```
        (venv) Î» excel-transform transform --help
        ```
        
Platform: UNKNOWN
