Metadata-Version: 2.1
Name: ezfiles
Version: 0.0.1
Summary: Utils to save your time on python coding
Home-page: https://github.com/caojianfeng/ezfiles
Author: JeffreyCao
Author-email: jeffreycao1024@gmail.com
License: MIT Licence
Description: # ezfiles
        Utils to save your time on python coding
        
        Life is short we use ezutils !
        
        ## 1. Installing
        ```bash
        pip install ezfiles
        ```
        
        ## 2. Using
        
        ### 2.1 readlines:
        
        readlines(filename: str, strip_newline: bool = True) 
        
        #### 2.1.1 params:
        ```txt
        filename: the filename tobe read
        
        strip_newline: strip the last space/newline
        
        
        ```
        #### 2.1.2 return lines readed from file
        
        #### 2.1.3 Example:
        
        ```python
            lines = readlines(brother_path('cfg.txt'))
            print(lines)
        ```
        
        
        ### 2.2 writelines:
        
        writelines(lines: List, filename, append_newline: bool = True) 
        
        #### 2.2.1 params:
        ```txt
        lines: lines tobe written
        filename: file tobe written
        append_newline: add a newline to each line writtend
        ```
        #### 2.2.2 return None
        
        Example:
        
        ```python
            lines = ['hello', 'ezflines']
            writelines(lines, brother_path('cfg.txt'))
        ```
        
        ### 2.3 readstr:
        
        readstr(filename: str) -> str
        
        #### 2.3.1 params:
        ```txt
        filename: file tobe read
        ```
        #### 2.3.2 return None
        
        ### 2.4 readjson:
        
        readjson(filename: str) -> dict
        
        #### 2.4.1 params:
        ```txt
        filename: file tobe read
        ```
        #### 2.4.2 return dict from json parse
        
        
        ## 3. Demo
        
        ```python
        
        #!/usr/bin/env python3
        # -*- coding:utf-8 -*-
        
        import os
        from ezfiles import readlines, writelines, readstr, readjson
        
        
        def brother_path(filename): return os.path.join(
            os.path.dirname(__file__), filename)
        
        
        def read_as_lines():
            lines1 = readlines(brother_path('cfg.txt'))
            print(f"lines1:{lines1}")
            '''
            lines1:['hello', 'ezflines']
            '''
            lines2 = readlines(brother_path('cfg.txt'), False)
            print(f"lines2:{lines2}")
            '''
            lines2:['hello\n', 'ezflines\n']
            '''
        
        
        def write_as_lines():
            lines = ['hello', 'ezflines']
            writelines(lines, brother_path('cfg.txt'))
            '''
            cfg.txt:
            hello
            ezflines
        
            '''
            writelines(lines, brother_path('cfg_oneline.txt'), False)
            '''
            cfg_oneline.txt:
            helloezflines
            '''
        
        
        def read_as_string():
            string = readstr(brother_path('cfg.txt'))
            print(f"read_as_string:\n{string}")
        
        
        def read_as_json():
            json_obj = readjson(brother_path('cfg.json'))
            print(f"read_as_json: type = {type(json_obj)}")
            images = json_obj["images"]
            for image in images:
                print(f"read_as_json: image = {image}")
        
        
        if __name__ == "__main__":
            write_as_lines()
            read_as_lines()
            read_as_string()
            read_as_json()
        
        
        ```
Keywords: pip,ezfiles
Platform: any
Classifier: Programming Language :: Python :: 3
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Requires-Python: >=3.6
Description-Content-Type: text/markdown
