Merge pull request #13 from SubhrajitPrusty/master

added cli for gnewsclient, updated README with instructions

Author: nikhilkumarsingh

.gitignore

@@ -2,3 +2,4 @@
 /dist/
 /*.egg
 /*.egg-info
+venv

CLI.md

@@ -0,0 +1,46 @@
+# gnews
+
+CLI to use gnewsclient
+
+How to use?
+-----------
+
+To use, it is recommended to make `virtualenv` and then install all required packages:
+
+* Installing virtualenv:  
+```
+$ sudo pip install virtualenv
+```  
+* Making virtualenv:  
+```
+$ virtualenv venv
+```  
+* Go to your gnewsclient dir and activate it:   
+```
+$ . venv/bin/activate
+```  
+* To install all required packages:  
+ ```
+ $ pip install --editable .
+ or
+ $ sudo pip install --editable .
+```
+
+
+## Usage: `$ gnews [OPTIONS]`
+
+```
+Options:
+  --config         shows default config
+  --query TEXT     shows news about query given
+  --edition TEXT   shows news of edition given, default=United States
+                   (English)
+  --topic TEXT     shows topic given, default=top stories
+  --location TEXT  shows news from location given
+  --language TEXT  shows news in language given, default is english
+  --sheditions     shows list of available editions
+  --shtopics       shows list of available topics
+  --shlangs        shows list of available languages
+  --help           Show this message and exit.
+
+ ```

README.md

@@ -14,6 +14,8 @@ To install gnewsclient, simply,
 $ pip install gnewsclient
 ```
 
+To install and use **gnewsclient CLI**, follow instructions here [CLI](CLI.md)
+
 ## Filters
 
 Google News feeds use 3 basic filters:

gnewsclient/gnewsclient.py

@@ -41,7 +41,7 @@ def get_config(self):
             'edition': self.edition,
             'topic': self.topic,
             'language': self.language,
-            'loaction': self.location,
+            'location': self.location,
             'query': self.query
         }
         return config

gnewsclient/scripts/__init__.py

@@ -0,0 +1,56 @@
+import click
+from gnewsclient import gnewsclient
+
+client = gnewsclient()
+
+@click.command()
+@click.option("--config",is_flag=True,help="shows default config")
+
+@click.option("--query",default=None,help="shows news about query given")
+@click.option("--edition",default="United States (English)",help="shows news of edition given, default=United States (English)")
+@click.option("--topic",default="top stories",help="shows topic given, default=top stories")
+@click.option("--location",default=None,help="shows news from location given")
+@click.option("--language",default="english",help="shows news in language given, default is english")
+
+@click.option("--sheditions",is_flag=True,help="shows list of available editions")
+@click.option("--shtopics",is_flag=True,help="shows list of available topics")
+@click.option("--shlangs",is_flag=True,help="shows list of available languages")
+
+def cli(config,query,edition,topic,location,language,shlangs,shtopics,sheditions):
+	""" CLI to get news """
+
+	client.query = query
+	client.edition = edition
+	client.topic = topic
+	client.location = location
+	client.language = language
+
+	if config:
+		conf = client.get_config()
+		click.echo("The default configuration : ")
+		for keys,value in conf.items():
+			click.echo(str(keys)+" : "+str(value))
+
+	elif shlangs:
+		langs = client.languages
+		click.echo("The languages supported : ")
+		for l in langs:
+			click.echo(l)
+
+	elif sheditions:
+		editions = client.editions
+		click.echo("The editions available : ")
+		for e in editions:
+			click.echo(e)
+
+	elif shtopics:
+		tps = client.topics
+		click.echo("The topics available : ")
+		for t in tps:
+			click.echo(t)
+	else:
+		neews = client.get_news()
+		for n in neews:
+			content = "{}\n{}".format(n['title'],n['link'])
+			click.echo(content)
+			click.echo("\n")

gnewsclient/scripts/gnews.py

@@ -31,6 +31,11 @@ def readme():
       author_email = '[email protected]',
       license = 'MIT',
       packages = ['gnewsclient'],
-      install_requires = ['requests', 'bs4', 'html5lib'], 
+      install_requires = ['requests', 'bs4', 'html5lib', 'Click'], 
       include_package_data = True,
-      zip_safe = False)
+      zip_safe = False,
+      entry_points='''
+        [console_scripts]
+        gnews=gnewsclient.scripts.gnews:cli
+      ''',
+      )