Metadata-Version: 2.1
Name: wikilink
Version: 0.3.0
Summary: A multiprocessing web-scraping application to scrape wiki pages and find minimum number of links between two given wiki pages.
Home-page: https://github.com/tranlyvu/wiki-link
Author: Tran Ly Vu
Author-email: vutransingapore@gmail.com
Maintainer: Tran Ly Vu <vutransingapore@gmail.com>
Maintainer-email: vutransingapore@gmail.com
License: Apache License 2.0
Project-URL: Source, https://github.com/tranlyvu/wiki-link
Project-URL: Tracker, https://github.com/tranlyvu/wiki-link/issues
Project-URL: Chat: Gitter, https://gitter.im/find-link/Lobby
Project-URL: CI: Travis, https://travis-ci.org/tranlyvu/wiki-link
Project-URL: Coverage: coveralls, https://coveralls.io/github/tranlyvu/wiki-link
Description: <p align="center">
        	<a href="https://github.com/tranlyvu/wiki-link"><img src="https://github.com/tranlyvu/wiki-link/blob/dev/img/logo.png"  width="400" height="400"></a>	
        </p>
        
        <p align="center">
        	<a href="https://pypi.org/project/wikilink/"><img src="https://img.shields.io/pypi/v/wikilink.svg"></a>
        	<a href="https://pepy.tech/project/wikilink"><img src="https://pepy.tech/badge/wikilink"></a>
        	<a href="https://github.com/tranlyvu/wiki-link"><img src="http://hits.dwyl.io/tranlyvu/wiki-link.svg"></a>
            <a href="https://github.com/tranlyvu/wiki-link"><img src="http://githubbadges.com/star.svg?user=tranlyvu&repo=wiki-link&style=default"></a>
            <a href="https://github.com/tranlyvu/wiki-link/fork"><img src="http://githubbadges.com/fork.svg?user=tranlyvu&repo=wiki-link&style=default"></a>
        </p>
        
        ---
        wikilink is a multiprocessing web-scraping application to scrape the wiki pages, extract urls and find the minimum number of links between 2 given wiki pages.
        
        I discussed brief the motivation and an overview of the project in [my blog](https://tranlyvu.github.io/algorithms/BFS-and-a-simple-application/).
        
        The project is currently at version [v0.3.0](https://github.com/tranlyvu/wiki-link/releases), also see [change log](https://github.com/tranlyvu/wiki-link/blob/dev/CHANGELOG.md) for more details on release history.
        
        If you like this project, feel fee to leave a few words of appreciation here [![Say Thanks!](https://img.shields.io/badge/Say%20Thanks-!-1EAEDB.svg)](https://saythanks.io/to/tranlyvu)
        
        | Build | [![Build Status][3]][4] | [![Coverage Status][5]][6] | 
        | :--- | :--- | :---  |
        | **Quality** | [![Maintainability][13]][14] | [![Requirements Status][19]][20] |
        | **Support** | [![Join the chat][17]][18] | [![blog][1]][2] |
        | **Platform** | [![python version](https://img.shields.io/pypi/pyversions/wikilink.svg)](https://pypi.org/project/wikilink/)| [![implementation](https://img.shields.io/pypi/implementation/wikilink.svg)](https://pypi.org/project/wikilink/) |
        
        [3]: https://travis-ci.org/tranlyvu/wiki-link.svg?branch=dev
        [4]: https://travis-ci.org/tranlyvu/wiki-link 
        [5]: https://coveralls.io/repos/github/tranlyvu/wiki-link/badge.svg
        [6]: https://coveralls.io/github/tranlyvu/wiki-link
        
        [13]: https://api.codeclimate.com/v1/badges/8679cde6756683bd787d/maintainability
        [14]: https://codeclimate.com/github/tranlyvu/wiki-link/maintainability
        
        [17]: https://badges.gitter.im/find-link/Lobby.svg
        [18]: https://gitter.im/find-link/Lobby?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge
        [1]: https://img.shields.io/badge/docs-on%20blog-brightgreen.svg
        [2]: https://tranlyvu.github.io/algorithms/BFS-and-a-simple-application/
        
        [19]: https://requires.io/github/tranlyvu/wiki-link/requirements.svg?branch=dev
        [20]: https://requires.io/github/tranlyvu/wiki-link/requirements/?branch=dev
        
        ---
        Table of contents
        ---
        
        1. [Usage](#Usage)
        2. [Contribution](#Contribution) 
        3. [License](#License)
        
        ---
        Usage
        ---
        
        Install with pip
        
        ```
        $ pip install wikilink
        ```
        
        ### Database support
        
        wikilink currently supports [Mysql](https://www.mysql.com/downloads/) and [PostgreSQL](https://www.postgresql.org/)
        
        ### API
        
        ```
        setup_db(db, username, password, ip="127.0.0.1", port=3306): set up database
        
        Args:
        	db(str): Database engine, currently support "mysql" and "postgresql"
        	name(str): database username
        	password(str): database password
        	ip(str): IP address of database (Default = "127.0.0.1")
        	port(str): port that databse is running on (default=3306)
        
        Returns:
        	None
        ```
        
        ```
        min_link(source, destination, limit=6, multiprocessing=False): find minimum number of link from source url to destination url within limit 
        
        Args:
        	source(str): source wiki url, i.e. "https://en.wikipedia.org/wiki/Cristiano_Ronaldo"
        	destination(str): Destination wiki url, i.e. "https://en.wikipedia.org/wiki/Cristiano_Ronaldo"
        	limit(int): max number of links from the source that will be considered (default=6)
        	multiprocessing(boolean): enable/disable multiprocessing mode (default=False)
        
        Returns:
        	(int) minimum number of sepration between source and destination urls
        	return None and print messages if exceeding limits or no path found
        
        Raises:
        	DisconnectionError: error connecting to DB
        ```
        
        ### Examples
        
        ```
        >>> from wikilink import WikiLink
        >>> app = WikiLink()
        >>> app.setup_db("mysql", "root", "12345", "127.0.0.1", "3306")
        >>> source = "https://en.wikipedia.org/wiki/Cristiano_Ronaldo"
        >>> destination = "https://en.wikipedia.org/wiki/Lionel_Messi"
        >>> app.min_link(source, destination, 6)
        1
        ```
        
        ---
        Contribution [![Open Source Helpers][7]][8]
        ---
        [7]: https://www.codetriage.com/tranlyvu/wiki-link/badges/users.svg
        [8]: https://www.codetriage.com/tranlyvu/wiki-link
        
        ### How to contribute
        
        Please follow our contribution convention at [contribution instructions](https://github.com/tranlyvu/wiki-link/blob/dev/CONTRIBUTING.md) and [code of conduct](https://github.com/tranlyvu/wiki-link/blob/dev/CODE-OF-CONDUCT.md).
        
        To set up development environment, simply run:
        
        ```
        $ pip install -r requirements.txt
        ```
        
        Please check out the [issue file](https://github.com/tranlyvu/wiki-link/blob/dev/RELEASENOTES.md) for list of issues that required helps.
        
        
        ### Appreciation
        
        Feel free to add your name into the [list of contributors](https://github.com/tranlyvu/wiki-link/blob/dev/CONTRIBUTORS.md). You will automatically be inducted into Hall of Fame as a way to show my appreciation for your contributions.
        
        #### Hall of Fame
        
        [![](https://sourcerer.io/fame/tranlyvu/tranlyvu/wiki-link/images/0)](https://sourcerer.io/fame/tranlyvu/tranlyvu/wiki-link/links/0)[![](https://sourcerer.io/fame/tranlyvu/tranlyvu/wiki-link/images/1)](https://sourcerer.io/fame/tranlyvu/tranlyvu/wiki-link/links/1)[![](https://sourcerer.io/fame/tranlyvu/tranlyvu/wiki-link/images/2)](https://sourcerer.io/fame/tranlyvu/tranlyvu/wiki-link/links/2)[![](https://sourcerer.io/fame/tranlyvu/tranlyvu/wiki-link/images/3)](https://sourcerer.io/fame/tranlyvu/tranlyvu/wiki-link/links/3)[![](https://sourcerer.io/fame/tranlyvu/tranlyvu/wiki-link/images/4)](https://sourcerer.io/fame/tranlyvu/tranlyvu/wiki-link/links/4)[![](https://sourcerer.io/fame/tranlyvu/tranlyvu/wiki-link/images/5)](https://sourcerer.io/fame/tranlyvu/tranlyvu/wiki-link/links/5)[![](https://sourcerer.io/fame/tranlyvu/tranlyvu/wiki-link/images/6)](https://sourcerer.io/fame/tranlyvu/tranlyvu/wiki-link/links/6)[![](https://sourcerer.io/fame/tranlyvu/tranlyvu/wiki-link/images/7)](https://sourcerer.io/fame/tranlyvu/tranlyvu/wiki-link/links/7)
        
        ---
        License
        ---
        
        See the [LICENSE](https://github.com/tranlyvu/wiki-link/blob/master/LICENSE) file for license rights and limitations (Apache License 2.0).
        
        
Keywords: Web Scraping,Artificial Intelligence,Breadth First Search,Graph,Data Science,Web Extracting,Information Analysis
Platform: any
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
Classifier: License :: OSI Approved :: Apache Software License 
Classifier: Operating System :: POSIX
Classifier: Operating System :: POSIX :: BSD
Classifier: Operating System :: POSIX :: Linux
Classifier: Operating System :: Unix
Classifier: Development Status :: 4 - Beta
Classifier: Natural Language :: English
Classifier: Environment :: Console
Classifier: Intended Audience :: Education
Classifier: Intended Audience :: End Users/Desktop
Classifier: Intended Audience :: Information Technology
Classifier: Intended Audience :: Science/Research
Classifier: Topic :: Scientific/Engineering :: Artificial Intelligence
Classifier: Topic :: Scientific/Engineering :: Information Analysis
Classifier: Topic :: Education
Classifier: Programming Language :: Python :: Implementation :: CPython
Classifier: Programming Language :: Python :: Implementation :: PyPy
Classifier: Framework :: Pytest
Classifier: Framework :: Flake8
Requires-Python: >=3.0, <4
Description-Content-Type: text/markdown
