Metadata-Version: 2.1
Name: biblehub
Version: 2.0.0b1
Summary: A module to scrape biblehub.com, also cli app
Home-page: https://github.com/joshpetit/biblehub
Author: Joshua Petitma
Author-email: joshuapetitma@yahoo.com
License: UNKNOWN
Description: # biblehub
        A python module (Formerly BibleHubScrapper) that retrieve a single verse and the information on it from biblehub.com.
        Also a simple commandline application.
        
        ## Installation
        ```pip3 install biblehub```
        
        ## Commandline
        To retrieve all the currently available information on a reference, use the '-a' tag:
        
        `biblehub find -a [Reference]`
        
        To only retrieve specific information, pass in the corresponding tag:
        ```shell script
        biblehub find -c [Reference] # Also retrieves the cross-references
        biblehub find -t [Reference] # Also retrieves the lexicon
        ```
        As with most cli tools, arguments can be stacked with one hyphen, such as:
        ```shell script
        biblehub find -cl [Reference] # Retrieves the cross-references and lexicon in addition to the passage
        ```
        To retrieve all the versions for that reference, use the `--versions` tag
        ```shell script
        biblehub find --versions Genesis 2:4
        ```
        To search biblehub use the `search` command
        ```shell script
        biblehub search Goliath
        ```
        Contains optional arguments `--ot` and `--nt` to limit the results to the old or new testaments
        ## Script Usage
        You can import the query and get_versions methods to use in scripts.
        ```python
        from biblehub import find_verse, get_versions
        
        biblehub_query = find_verse('Genesis 1:1')
        all_versions = get_versions('Genesis 1:1')
        print(biblehub_query.text) # In the beginning...
        print(all_versions[0].passage)
        ```
        By default, it will query all possible fields.
        You can choose not to query certain fields by indicating in the parameters
        for example:
        ` find_verse('Genesis 1:1', get_lexicons=False) `
        
        ## Useful fields
        ```python
        print(biblehub_query.passage) # Genesis 1:1
        print(biblehub_query.version) # NIV (default)
        print(biblehub_query.lexicons) # Text, Hebrew words, translit, strong, and English defintions
        print(biblehub_query.crfs) # Cross References
        print(biblehub_query.tos) # Treasury of Scripture
        print(biblehub_query.info) # Prints all the info queried on the verse. Also the same as the __str__
        ```
        there are also `biblehub_query.format_[field]` method that returns the specified field in an easy to read way.
        ### Searching
        ```python
        from biblehub import search as b_search
        list = b_search("Goliath", filter='nt')
        ```
        ## Contributing
        If you feel like improving the codebase, adding a feature, or checking my grammar, feel free!
        Checkout the issues I post for tasks you can help with, reference specific issues when making a PR.
        Make sure to send a pull request against the development branch.
        
Platform: UNKNOWN
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.8
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Requires-Python: >=3.6
Description-Content-Type: text/markdown
