Metadata-Version: 2.1
Name: ggsipu-result
Version: 0.3.1
Summary: GGSIPU Results PDF parser and analyzer
Home-page: https://github.com/ashutoshvarma/ggsipu_result
Author: Ashutosh Varma
Author-email: ashutoshvarma11@live.com
License: UNKNOWN
Description: # ggsipu_result
        [![Travis (.com)](https://img.shields.io/travis/com/ashutoshvarma/ggsipu_result?style=for-the-badge)](https://travis-ci.com/github/ashutoshvarma/ggsipu_result/)
        [![GitHub license](https://img.shields.io/github/license/ashutoshvarma/ggsipu_result?style=for-the-badge)](https://github.com/ashutoshvarma/ggsipu_result/blob/master/LICENSE)
        [![PyPI](https://img.shields.io/pypi/v/ggsipu_result?color=blue&style=for-the-badge)](https://pypi.org/project/ggsipu-result/)
        ![PyPI - Wheel](https://img.shields.io/pypi/wheel/ggsipu_result?style=for-the-badge)
        ![PyPI - Downloads](https://img.shields.io/pypi/dm/ggsipu_result?style=for-the-badge)
        
        **ggsipu_result** is a A python module for extraction of results from GGSIPU results pdf. It is capable of:-
        
        - Extraction of Results, Subjects details from pdfs.
        - Extract Student's photo from pdfs.
        - Dumping the extracted data in JSON format.
        
        
        ## Examples
        Given code prints top 5 students of 2018 batch:-
        ```python
        from ggsipu_result import iter_pages, has_page_results, iter_results
        
        FILE="Resources/CSE_Result.pdf"
        
        results = []
        for page in iter_pages(FILE):
            if has_page_results(page):
                results = results + [r for r in iter_results(page) if r.batch == 2018]
        
        results.sort(key=lambda x: x.cgpa, reverse=True)
        
        for i, result in enumerate(results[:5]):
            print("{i}. {r}".format(i=i+1, r= result))
        
        
        ## PROBABLE OUTPUT
        # 1. Result(Sem 1): [41516403218]GAURAV JAIN(2018) [CGPA: 8.92]
        # 2. Result(Sem 1): [41016403218]VARDAAN GROVER(2018) [CGPA: 8.77]
        # 3. Result(Sem 1): [40316403218]UJJWAL NEGI(2018) [CGPA: 8.73]
        # 4. Result(Sem 1): [40116403218]RIGVED ALANKAR(2018) [CGPA: 8.5]
        # 5. Result(Sem 1): [01616403218]CHAITANYA GIRI(2018) [CGPA: 8.46]
        ```
        For more examples please see [`Sample_Code`](https://github.com/ashutoshvarma/ggsipu_result/tree/master/Sample_Code) folder
        
        ## Install
        ```
        pip install ggsipu-result
        ```
        
        ## Tests
        
        `ggsipu_result` includes a test suite built on the unittest framework. All tests are located in the "Tests" folder.
        Tests can be run from the command line by:
        
        
        ```bash
        python -m unittest Tests.tests
        ```
        
        ## Changelog
        ### v0.3.1 (08-07-2020)
        - fix NoneType error while searching for institution code and name in `iter_results`
        - API: remove `subject` attribute from `Marks`
        - toJSON: now handle case where \_\_dict\_\_ is not present.
        - API: add `toDict()` helper method to convert into python dict.
        ### v0.3 (08-07-2020) [Breaking Changes]
        - API: remove unused `Student` class
        - API: merge `Student` properties into `Result`.
        ### v0.2 (04-07-2020)
        - add support for extraction of student's photo from pdfs
        - API: new function `parse_result_pdf` to parse entire pdf in one go.
        ### v0.1.1 (05-06-2020)
        - fix [#1](https://github.com/ashutoshvarma/ggsipu_result/issues/1): include support for 6 digit paper codes
        ### v0.1 (initial release)
        
        ## License
        
        All files under the repo are licensed under GNU [GPLv3](https://github.com/ashutoshvarma/ggsipu_result/blob/master/LICENSE)
        
        
        
Keywords: ggsipu result,ipu result converter,cgpa calculator
Platform: UNKNOWN
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3.4
Classifier: Programming Language :: Python :: 3.5
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3 :: Only
Classifier: Development Status :: 5 - Production/Stable
Classifier: License :: OSI Approved :: GNU General Public License v3 (GPLv3)
Classifier: Topic :: Text Processing
Requires-Python: >=3.4
Description-Content-Type: text/markdown
