From ec878fa13f2e9500da54a078da979c24f476addd Mon Sep 17 00:00:00 2001 From: Vu TranLy Date: Sat, 28 Jan 2017 23:21:08 +0800 Subject: [PATCH] update README file --- .idea/findLink.iml | 2 +- .idea/workspace.xml | 341 +++++++++++++++++++++++++++++++++++++++++--- README.md | 32 +++-- requirements.txt | 10 +- src/__init__.py | 12 +- src/findLink.py | 2 +- src/settings.py | 4 +- 7 files changed, 358 insertions(+), 45 deletions(-) diff --git a/.idea/findLink.iml b/.idea/findLink.iml index 6711606..12af408 100644 --- a/.idea/findLink.iml +++ b/.idea/findLink.iml @@ -2,7 +2,7 @@ - + diff --git a/.idea/workspace.xml b/.idea/workspace.xml index ec81ff5..d4e054d 100644 --- a/.idea/workspace.xml +++ b/.idea/workspace.xml @@ -2,9 +2,13 @@ - + - + + + + + @@ -25,21 +29,95 @@ - - + + + + + + + + + + + + + + + + + + - - + + + + + + + + + + + + + + + + + - - + + + + + + + + + + + + + + + + + + + + + + + + + - + + + + + + + + + + + + + + + + + + + + + @@ -55,6 +133,11 @@ @@ -65,10 +148,10 @@ DEFINITION_ORDER - @@ -95,34 +178,84 @@ - - + + + + + + + + + + + + + + - - + + + + + + + + + + + + + + + - + - + @@ -339,6 +472,9 @@ + + + @@ -350,27 +486,27 @@ - + - + + + - - @@ -389,6 +525,58 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + @@ -405,6 +593,50 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + @@ -413,5 +645,68 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/README.md b/README.md index cf6a00f..f2f7064 100644 --- a/README.md +++ b/README.md @@ -1,22 +1,26 @@ -#Description: -The repo contains a python web-scraping application to minimum number of links between 2 given wiki pages +#finLink: +findLink is a python web-scraping application to minimum number of links between 2 given wiki pages + +[![Build Status](https://travis-ci.org/tranlyvu/find-link.svg?branch=master)](https://travis-ci.org/tranlyvu/find-link) + +#Using findLink: +* Downloading a [release](https://github.com/tranlyvu/find-link) -#Usage: -* Sample - * [sample](https://github.com/tranlyvu/findLink/sample.py) - * Quickstart - 1. Initializing class 'my_findLink"" + 1. Initializing class 'findLink"" 2. Calling "search" method +* Sample + * [sample](https://github.com/tranlyvu/findLink/sample.py) + #Contribution -Contributions are welcome! For bug reports or requests please submit an [issue](https://github.com/tranlyvu/findLink/issues). +* Join our [gitter] ( gitter.im/find-link) and Maillist +* [Release management](https://launchpad.net/findlink) +* For any feature recommendation please register a [Blueprint](https://blueprints.launchpad.net/findlink) +* For bug reports or requests please submit an [issue](https://github.com/tranlyvu/find-link/issues) -#Contact-info -Feel free to contact me to discuss any issues, questions, or comments. -* Email: vutransingapore@gmail.com -* Twitter: [@vutransingapore](https://twitter.com/vutransingapore) -* GitHub: [vutransingapore](https://github.com/tranlyvu) +#Frequently Asked Questions +The FAQs can be found on the project's [Wiki page](https://github.com/tranlyvu/find-link/wiki). Feel free to submit more questions to be answered and added to the page. #License -See the LICENSE file for license rights and limitations (MIT). +See the LICENSE file for license rights and limitations (Apache License 2.0). diff --git a/requirements.txt b/requirements.txt index 00a16e9..bdda6ec 100644 --- a/requirements.txt +++ b/requirements.txt @@ -1,3 +1,7 @@ -bs4==4.3.2 -urllib2==2.7 -MySQLdb==1.3.7 +# The order of packages is significant, because pip processes them in the order +# of appearance. Changing the order has an impact on the overall integration +# process, which may cause wedges in the gate later. + + +beautifulsoup4 +MySQL-python diff --git a/src/__init__.py b/src/__init__.py index 03f42b2..eb4a40a 100644 --- a/src/__init__.py +++ b/src/__init__.py @@ -1,7 +1,17 @@ +"""finLink +finlIkn is web-scraping application to find minimum number of links between two given wiki pages +Beautiful Soup works with Python 2.7 and up. +For more than you ever wanted to know about finLink, see the documentation: + +""" + +__author__ = "Tran Ly Vu (vutransingapore@gmail.com)" +__version__ = "1.0.0" +__copyright__ = "Copyright (c) 2016-2017 Tran Ly Vu" +__license__ = "Apache License 2.0" __all__=[ 'retrieveData', 'searchEngine' - ] \ No newline at end of file diff --git a/src/findLink.py b/src/findLink.py index fecaea4..a617b19 100644 --- a/src/findLink.py +++ b/src/findLink.py @@ -4,7 +4,7 @@ from searchEngine.searcher import searcher import MySQLdb -class my_findLink: +class findLink: def __init__(self,starting_url,ending_url,limit=6): """ Main class of the application diff --git a/src/settings.py b/src/settings.py index b16b432..6e86ae0 100644 --- a/src/settings.py +++ b/src/settings.py @@ -1,3 +1,3 @@ -my_user='vutran' -my_password='13061990' +my_user='' +my_password='' my_host="localhost"