Metadata-Version: 2.1
Name: freebible
Version: 0.1a8
Summary: A bible processing toolkit with free bible data for Python
Home-page: https://github.com/neocl/freebible
Author: Le Tuan Anh
Author-email: tuananh.ke@gmail.com
License: MIT License
Project-URL: Bug Tracker, https://github.com/neocl/freebible/issues
Project-URL: Source Code, https://github.com/neocl/freebible/
Description: # freebible library
        
        Free holy bibles data and toolkit for Python developers
        
        ## Project Home Page
        
        https://github.com/neocl/freebible
        
        ## Installation
        
        freebible package is available on PyPI, so it can be installed via pip by using
        
        ```bash
        pip install freebible
        # or even better
        python3 -m pip install freebible
        ```
        
        Please note that freebible requires **Python 3**. It does not work on ~~Python 2~~ anymore. 
        
        ## Sample code
        
        ### Easy access
        
        ```python
        >>> from freebible import bibles
        
        # Quote everything
        >>> bibles.print("Gen")
        [1] 創世記
        [1] Genesis
        >>> bibles.print("Gen", 1, 1)
        [Ge 1:1] 元始に神天地を創造たまへり 
        [Gen 1:1] In the beginning God created the heavens and the earth.
        
        # Quote from a specific bible
        >>> bibles.kougo.quote("John")  # this returns a book object
        Book(ID='104', title='ヨハネ傳福音書', filename='John', title_eng='John', short_name='John')
        >>> bibles.kougo.quote("John", 1)  # this returns a chapter object
        Chapter(ID='1')
        >>> bibles.kougo.quote("John", 1, 1)  # this returns a verse object
        John 1:1 太初に言あり、言は神と偕にあり、言は神なりき。 
        
        >>> bibles.web.quote("John")
        Book(ID='43', title='John', filename='', title_eng='John', short_name='John')
        >>> bibles.web.quote("John", 1)
        Chapter(ID='1')
        >>> bibles.web.quote("John", 1, 1)
        John 1:1 In the beginning was the Word, and the Word was with God, and the Word was God.
        ```
        
        ### Accessing Kougo
        
        ```python
        >>> from freebible import read_kougo
        >>> kougo = read_kougo()
        >>> print(len(kougo))
        66
        >>> print(kougo['John'])
        [104] ヨハネ傳福音書
        >>> print(len(kougo['John']))
        21
        >>> print(kougo['John'][1])
        Chapter(ID='1')
        >>> print(kougo['John'][1][1])
        [John 1:1] 太初に言あり、言は神と偕にあり、言は神なりき。
        ```
        
        ### Accessing World English Bible (WEB)
        
        ```python
        >>> from freebible import read_web
        >>> web = read_web()
        >>> print(len(web))
        66
        >>> print(web['John'])
        [43] John
        >>> print(len(web['John']))
        21
        >>> print(web['John'][1])
        Chapter(ID='1')
        >>> print(len(web['John'][1]))
        51
        >>> print(web['John'][1][1])
        [John 1:1] In the beginning was the Word, and the Word was with God, and the Word was God.
        ```
        
        ## Developer setup
        
        If you want to contribute to the source code, you can setup the development environment like this
        ```bash
        # Create a virtual environment to install packages
        python3 -venv ~/.envfreebible
        # Activate the virtual environment
        . ~/.envfreebible/bin/activate
        
        # Check out the source code to your machine
        git clone https://github.com/freebible freebible-project
        cd freebible-project
        # Install required packages
        python3 -m pip install -r requirements.txt
        
        # Run the demo to make sure that this source code work
        python3 demo.py
        ```
        
        ## Bible sources:
        
        Japanese Colloquial 口語訳: http://jco.ibibles.net/
        
        World English Bible: https://github.com/scrollmapper/bible_databases
        
Keywords: free holy bible nlp
Platform: any
Classifier: Programming Language :: Python
Classifier: Development Status :: 2 - Pre-Alpha
Classifier: Natural Language :: English
Classifier: Natural Language :: Japanese
Classifier: Natural Language :: Indonesian
Classifier: Environment :: Plugins
Classifier: Intended Audience :: Science/Research
Classifier: Intended Audience :: Developers
Classifier: Intended Audience :: Religion
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Classifier: Topic :: Religion
Classifier: Topic :: Text Processing
Classifier: Topic :: Software Development :: Libraries :: Python Modules
Description-Content-Type: text/markdown
