Metadata-Version: 2.1
Name: grewritingpool
Version: 0.2.2
Summary: Helper for GRE Writing Pool
Home-page: https://github.com/patrick330602/grewritingpool
Author: Patrick Wu
Author-email: me@patrickwu.space
License: GPLv3
Description: # Helper for GRE Writing Pool
        
        [![pypi](https://flat.badgen.net/pypi/v/grewritingpool)](https://pypi.org/project/grewritingpool/)
        
        Because why not?
        
        ## Install
        
        `pip install grewritingpool`
        
        or install from source:
        `python3 setup.py install`
        
        ## Usage
        
        ### As a API
        
        **get_list(writing_type='default')**
        
        Return a json list of articles. Input can be `all`, `issue` or `argument`, default to `all`.
        
        Returned json format:
        ```
        [
            {
                'type': <writing type>,
                'first': <first part of the question>,
                'second': <first part of the question, might not exist>,
                'instruc': <instruction>
            },
            ...
        ]
        ```
        
        **get_random(writing_type='default')**
        
        Return a random json string from the json list of articles. Input can be `all`, `issue` or `argument`, default to `all`.
        
        Returned json format:
        ```
        {
            'type': <writing type>,
            'first': <first part of the question>,
            'second': <first part of the question, might not exist>,
            'instruc': <instruction>
        }
        ```
        
        ### As a executable
        
        ```bash
        grewriting [all|issue|argument]
        ```
        
        ## License
        
        GPLv3.
        
Keywords: gre,writing
Platform: UNKNOWN
Classifier: Environment :: Console
Classifier: Topic :: Education
Classifier: License :: OSI Approved :: GNU General Public License v3 (GPLv3)
Classifier: Operating System :: POSIX :: Linux
Classifier: Operating System :: Microsoft :: Windows
Classifier: Operating System :: MacOS :: MacOS X
Classifier: Programming Language :: Python :: 3 :: Only
Requires-Python: >=3.5
Description-Content-Type: text/markdown
