Metadata-Version: 2.1
Name: newsdatascraper
Version: 0.0.3
Summary: Easily query articles
Home-page: https://github.com/erikqu/NewsDataScraper
Author: Erick Torres and Erik Quintanilla
Author-email: ericktorresdeveloper@gmail.com
License: MIT
Description: # NewsDataScrapper
        Python package that helps you easily get news data
        
        [![License: MIT](https://img.shields.io/github/license/erikqu/NewsDataScraper)](https://opensource.org/licenses/MIT)
        [![pypi: newsdatascraper](https://img.shields.io/pypi/pyversions/newsdatascraper)](https://pypi.org/project/newsdatascraper/)
        
        ## Requirements
        - Python 3.5+
        - [Newspaper3k](https://newspaper.readthedocs.io/en/latest/)
        - Api Key from [NewsApi](https://newsapi.org)
        
        ## Installation
        ```bash
        pip3 install newsdatascraper
        ```
        
        ## Usage
        ```python
        from newsdatascraper import Scraper
        #To first get the articles
        new_scraper = Scraper('mock-api-key')
        articles = new_scraper.fetch_all_articles(query='two-sigma')
        #To access individual articles and their properties
        first_article = articles.articles[0]
        print(first_article.content)
        #We also provide helper functions to serialize the data
        articles.toCsv('test.csv')
        articles.toPickle('test.pickle')
        articles.toJson()
        ```
        
        ### Working on the Project
        Run formatter
        ```bash
        black .
        ```
        Run Linter
        ```bash
        pylama -o setup.cfg .
        ```
        Run tests
        ```bash
        pytest
        ```
        Run tests + code coverage
        ```bash
        sh ./scripts/generate_coverage.sh
        ```
Platform: UNKNOWN
Classifier: Programming Language :: Python :: 3.5
Classifier: Natural Language :: English
Classifier: Development Status :: 3 - Alpha
Classifier: License :: OSI Approved :: MIT License
Classifier: Intended Audience :: Developers
Description-Content-Type: text/markdown
