Metadata-Version: 2.1
Name: ShanCsv
Version: 0.2
Summary: A Python Package for CSV File Parsing and Rendering
Home-page: https://github.com/Ninjago77/ShanCsv
Author: Shanvanth Arunmozhi
Author-email: shanvantharunmozhi@gmail.com
License: UNKNOWN
Project-URL: Bug Reports, https://github.com/Ninjago77/ShanCsv/issues
Project-URL: Docs, https://github.com/Ninjago77/ShanCsv#readme
Description: # ShanCsv <br/>[![Python 3.8+](https://img.shields.io/badge/python-3.8%2B-blue)](https://www.python.org/downloads/) [![Pip latest](https://img.shields.io/badge/pip-latest-blue)](https://pip.pypa.io/en/stable/) [![license](https://img.shields.io/badge/license-MIT-green)](https://github.com/Ninjago77/ShanCsv/blob/main/LICENSE)
        A Python Package for CSV File Parsing and Rendering
        ## How to install
        Install the [`ShanCsv`](https://pypi.org/project/ShanCsv/) module using [`pip`](https://pip.pypa.io/en/stable/)
        ```bash
        pip install ShanCsv
        ```
        Then import the [`ShanCsv`](https://pypi.org/project/ShanCsv/) module into your program
        ```python
        import ShanCsv
        ```
        ## Basic Usage
        ### <sup>*ShanCsv*</sup>.dump(data, file)
         - Writes the data (2-dimensional list) in CSV format to the file
         - Other Arguments are transferred to [`dumps`](#shancsvdumpsdata) and [`Csv`](#shancsvcsvinputobj-inputtypestr-moreargs)
         - Example:
        ```python
         with open("test.csv","w") as file:
            ShanCsv.dump(data, file) # data is a 2-dimensional list
         ```
        ### <sup>*ShanCsv*</sup>.dumps(data)
         - Returns the data (2-dimensional list) in CSV format as str
         - Other Arguments are transferred to [`Csv`](#shancsvcsvinputobj-inputtypestr-moreargs)
         - Example:
        ```python
        text = ShanCsv.dumps(data) # data is a 2-dimensional list
         ```
        ### <sup>*ShanCsv*</sup>.load(file)
         - Reads the file in CSV format and converts it to data (2-dimensional list)
         - Other Arguments are transferred to [`loads`](#shancsvloadstext-gettype) and [`Csv`](#shancsvcsvinputobj-inputtypestr-moreargs)
         - Example:
        ```python
         with open("test.csv","r") as file:
            data = ShanCsv.load(file) # data is a 2-dimensional list
         ```
        ### <sup>*ShanCsv*</sup>.loads(text, *getType*)
         - Returns the CSV format converted to data (2-dimensional list) as list\*
         - The *getType* argument can have any of these values (list, tuple, str), by default it is list
         - Other Arguments are transferred to [`Csv`](#shancsvcsvinputobj-inputtypestr-moreargs)
         - Example:
        ```python
        data = ShanCsv.loads(text) # data is a 2-dimensional list
         ```
        ### <sup>*ShanCsv*</sup>.Csv(inputObj, *inputTypeStr*, \**MoreArgs*)
         - A Csv Object that takes an inputObj and handles almost everything needed for parsing and rendering CSV data
         - The *inputTypeStr* argument is a boolean value that specifies if the inputObj is a str, by default it is True
         - \**MoreArgs* = *itemSplitter, lineSplitter, boolValue, noneValue, floatValue, intValue, customTrueValue, customFalseValue, customNoneValue*
          - \**MoreArgs* Docs coming soon!
         - Example:
        ```python
        c = ShanCsv.Csv(text)
        data = c.getList() # data is a 2-dimensional list
        text = str(c)
         ```
        
Keywords: samplecsv,shancsv,csv,comma-sperated-values,data,storage,development
Platform: UNKNOWN
Classifier: Development Status :: 3 - Alpha
Classifier: Intended Audience :: Developers
Classifier: Topic :: Database
Classifier: Topic :: Software Development :: Libraries :: Python Modules
Classifier: Topic :: Software Development :: Libraries
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3 :: Only
Requires-Python: >=3.8, <4
Description-Content-Type: text/markdown
