Metadata-Version: 2.1
Name: pyscihub
Version: 0.1.0
Summary: Command-line and Python API to download PDFs directly from Sci-Hub
Home-page: https://github.com/markkvdb/pyscihub
Author: Mark van der Broek
Author-email: markvanderbroek@gmail.com
License: MIT license
Description: ========
        pyscihub
        ========
        
        
        .. image:: https://img.shields.io/pypi/v/pyscihub.svg
                :target: https://pypi.python.org/pypi/pyscihub
        
        .. image:: https://img.shields.io/travis/markkvdb/pyscihub.svg
                :target: https://travis-ci.com/markkvdb/pyscihub
        
        .. image:: https://readthedocs.org/projects/pyscihub/badge/?version=latest
                :target: https://pyscihub.readthedocs.io/en/latest/?badge=latest
                :alt: Documentation Status
        
        
        
        
        Command-line and Python API to download PDFs directly from Sci-Hub
        
        
        * Free software: MIT license
        * Documentation: https://pyscihub.readthedocs.io.
        
        
        Installation
        ------------------
        
        Installing the Sci-Hub CLI is as easy as cloning this repo and installing it using pip, i.e.,
        
        .. code-block:: bash
        
            git clone https://github.com/markkvdb/pyscihub.git
            cd pyscihub
            pip install -e .
        
        If you don't want to change the standard output folder, then make sure that you create a `output` folder in the `pyscihub` folder.
        
        Usage
        ------------------
        
        Tool can be used with a single query, e.g.,
        
        .. code-block:: bash
        
            pyscihub single "Your paper"
        
        or with a user-provided file containing one query per line as
        
        .. code-block:: bash
        
            pyscihub file <LOCATION FILE>
        
        If everything goes well, a file `output/pdf_paths.csv` is created containing the location of the PDFs of all requested queries. If Sci-Hub cannot find the corresponding PDF then the field is empty.
        
        
        =======
        History
        =======
        
        0.1.0 (2020-10-06)
        ------------------
        
        * First release on PyPI.
        
Keywords: pyscihub
Platform: UNKNOWN
Classifier: Development Status :: 3 - Alpha
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: MIT License
Classifier: Natural Language :: English
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.8
Requires-Python: >=3.8
Description-Content-Type: text/x-rst
