Metadata-Version: 2.1
Name: research-assistant
Version: 1.0.0
Summary: useful academia tools
Home-page: https://github.com/JakeHattwell/research-assistant
Author: Jake Hattwell
Author-email: j.hattwell@uq.edu.au
License: MIT
Description: # Research Assistant
        
        Research Assistant is a Python 3 library featuring small utilities that make life easier.
        
        ## Installation
        
        Use the package manager [pip](https://pip.pypa.io/en/stable/) to install Research Assistant.
        
        ```bash
        pip install research-assistant
        ```
        
        ## Scripts and Usage
        To use a utility, simply call it from the command line. For example:
        
        ```bash
        paper-scraper.py
        ```
        will run the paper-scraper utility
        
        | Script      | Description | Requirements |
        | ----------- | ----------- | ------------ |
        | paper-scraper.py | Run on a folder of PDF files to rename files in a AUTHOR_DATE_TITLE format. For example: `jourABC_article_184505.pdf` â†’ `Hattwell_2020_Research Assistant.pdf`. Quality of renaming dependent on metadata of PDFs. | PyPDF2 |
        
        
        ## Contributing
        Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.
        
        Please make sure to update tests as appropriate.
        
        ## License
        [MIT](https://choosealicense.com/licenses/mit/)
        
        ## Thanks
        Thanks to Luke Husdell for feedback
Platform: UNKNOWN
Classifier: Programming Language :: Python :: 3
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Description-Content-Type: text/markdown
