Upload 25 files

.gitignore

@@ -0,0 +1 @@
+venv

README.md

@@ -0,0 +1,42 @@
+# article scraper
+
+### Setup
+1. Clone the repository.
+```sh
+# https
+git clone https://github.com/avila-bugayong-esguerra/article-scraper.git
+
+# or 
+
+# ssh
+git clone git@github.com:avila-bugayong-esguerra/article-scraper.git
+```
+
+2. Change directory into project folder.
+```sh
+cd article_scraper
+```
+
+3. Create a virtual environment.
+```sh
+python -m venv venv
+```
+
+4. Activate the virtual environment.
+```sh
+# windows
+\venv\Scripts\activate
+
+# unix
+source venv/bin/activate
+```
+
+5. Install the dependencies.
+```sh
+pip install -r article_scraper/requirements.txt
+```
+
+6. Change directory into the Scrapy project.
+```sh
+cd article_scraper
+```

article_scraper/items.py

@@ -0,0 +1,12 @@
+# Define here the models for your scraped items
+#
+# See documentation in:
+# https://docs.scrapy.org/en/latest/topics/items.html
+
+import scrapy
+
+
+class KamiScraperItem(scrapy.Item):
+    # define the fields for your item here like:
+    # name = scrapy.Field()
+    pass

article_scraper/main.py

@@ -0,0 +1,30 @@
+#!/usr/bin/env python3
+import argparse
+import os
+from pathlib import Path
+
+
+if __name__ ==  "__main__":
+    parser = argparse.ArgumentParser(description="article scraper")
+    parser.add_argument("--dataset", "-d",
+        help="the dataset to be made after articles are scraped (choices: 3000, 5000)",
+        default="3000")
+    args = parser.parse_args()
+
+    path = os.getcwd()
+
+    if args.dataset == "3000":
+        path += "/3000.html"
+        if not Path(path).is_file():
+            os.system("wget https://raw.githubusercontent.com/jamesesguerra/misc/main/3000.html")
+            os.system("sed -i '' 's/5000/3000/' spiders/kami_spider.py")
+    elif args.dataset == "5000":
+        path += "/5000.html"
+        if not Path(path).is_file():
+            os.system("wget https://raw.githubusercontent.com/jamesesguerra/misc/main/5000.html")
+            os.system("sed -i '' 's/3000/5000/' spiders/kami_spider.py")
+    else: 
+        print(f"Dataset {args.dataset} isn't a valid option.")
+
+    os.system("scrapy crawl kami -O ../csv_files/kami.csv")
+

article_scraper/middlewares.py

@@ -0,0 +1,103 @@
+# Define here the models for your spider middleware
+#
+# See documentation in:
+# https://docs.scrapy.org/en/latest/topics/spider-middleware.html
+
+from scrapy import signals
+
+# useful for handling different item types with a single interface
+from itemadapter import is_item, ItemAdapter
+
+
+class KamiScraperSpiderMiddleware:
+    # Not all methods need to be defined. If a method is not defined,
+    # scrapy acts as if the spider middleware does not modify the
+    # passed objects.
+
+    @classmethod
+    def from_crawler(cls, crawler):
+        # This method is used by Scrapy to create your spiders.
+        s = cls()
+        crawler.signals.connect(s.spider_opened, signal=signals.spider_opened)
+        return s
+
+    def process_spider_input(self, response, spider):
+        # Called for each response that goes through the spider
+        # middleware and into the spider.
+
+        # Should return None or raise an exception.
+        return None
+
+    def process_spider_output(self, response, result, spider):
+        # Called with the results returned from the Spider, after
+        # it has processed the response.
+
+        # Must return an iterable of Request, or item objects.
+        for i in result:
+            yield i
+
+    def process_spider_exception(self, response, exception, spider):
+        # Called when a spider or process_spider_input() method
+        # (from other spider middleware) raises an exception.
+
+        # Should return either None or an iterable of Request or item objects.
+        pass
+
+    def process_start_requests(self, start_requests, spider):
+        # Called with the start requests of the spider, and works
+        # similarly to the process_spider_output() method, except
+        # that it doesn’t have a response associated.
+
+        # Must return only requests (not items).
+        for r in start_requests:
+            yield r
+
+    def spider_opened(self, spider):
+        spider.logger.info('Spider opened: %s' % spider.name)
+
+
+class KamiScraperDownloaderMiddleware:
+    # Not all methods need to be defined. If a method is not defined,
+    # scrapy acts as if the downloader middleware does not modify the
+    # passed objects.
+
+    @classmethod
+    def from_crawler(cls, crawler):
+        # This method is used by Scrapy to create your spiders.
+        s = cls()
+        crawler.signals.connect(s.spider_opened, signal=signals.spider_opened)
+        return s
+
+    def process_request(self, request, spider):
+        # Called for each request that goes through the downloader
+        # middleware.
+
+        # Must either:
+        # - return None: continue processing this request
+        # - or return a Response object
+        # - or return a Request object
+        # - or raise IgnoreRequest: process_exception() methods of
+        #   installed downloader middleware will be called
+        return None
+
+    def process_response(self, request, response, spider):
+        # Called with the response returned from the downloader.
+
+        # Must either;
+        # - return a Response object
+        # - return a Request object
+        # - or raise IgnoreRequest
+        return response
+
+    def process_exception(self, request, exception, spider):
+        # Called when a download handler or a process_request()
+        # (from other downloader middleware) raises an exception.
+
+        # Must either:
+        # - return None: continue processing this exception
+        # - return a Response object: stops process_exception() chain
+        # - return a Request object: stops process_exception() chain
+        pass
+
+    def spider_opened(self, spider):
+        spider.logger.info('Spider opened: %s' % spider.name)

article_scraper/pipelines.py

@@ -0,0 +1,13 @@
+# Define your item pipelines here
+#
+# Don't forget to add your pipeline to the ITEM_PIPELINES setting
+# See: https://docs.scrapy.org/en/latest/topics/item-pipeline.html
+
+
+# useful for handling different item types with a single interface
+from itemadapter import ItemAdapter
+
+
+class KamiScraperPipeline:
+    def process_item(self, item, spider):
+        return item

article_scraper/settings.py

@@ -0,0 +1,92 @@
+# Scrapy settings for kami_scraper project
+#
+# For simplicity, this file contains only settings considered important or
+# commonly used. You can find more settings consulting the documentation:
+#
+#     https://docs.scrapy.org/en/latest/topics/settings.html
+#     https://docs.scrapy.org/en/latest/topics/downloader-middleware.html
+#     https://docs.scrapy.org/en/latest/topics/spider-middleware.html
+
+BOT_NAME = 'article_scraper'
+
+SPIDER_MODULES = ['article_scraper.spiders']
+NEWSPIDER_MODULE = 'article_scraper.spiders'
+
+
+# Crawl responsibly by identifying yourself (and your website) on the user-agent
+#USER_AGENT = 'kami_scraper (+http://www.yourdomain.com)'
+
+# Obey robots.txt rules
+ROBOTSTXT_OBEY = False
+
+# Configure maximum concurrent requests performed by Scrapy (default: 16)
+#CONCURRENT_REQUESTS = 32
+
+# Configure a delay for requests for the same website (default: 0)
+# See https://docs.scrapy.org/en/latest/topics/settings.html#download-delay
+# See also autothrottle settings and docs
+#DOWNLOAD_DELAY = 3
+# The download delay setting will honor only one of:
+#CONCURRENT_REQUESTS_PER_DOMAIN = 16
+#CONCURRENT_REQUESTS_PER_IP = 16
+
+# Disable cookies (enabled by default)
+#COOKIES_ENABLED = False
+
+# Disable Telnet Console (enabled by default)
+#TELNETCONSOLE_ENABLED = False
+
+# Override the default request headers:
+#DEFAULT_REQUEST_HEADERS = {
+#   'Accept': 'text/html,application/xhtml+xml,application/xml;q=0.9,*/*;q=0.8',
+#   'Accept-Language': 'en',
+#}
+
+# Enable or disable spider middlewares
+# See https://docs.scrapy.org/en/latest/topics/spider-middleware.html
+#SPIDER_MIDDLEWARES = {
+#    'kami_scraper.middlewares.KamiScraperSpiderMiddleware': 543,
+#}
+
+# Enable or disable downloader middlewares
+# See https://docs.scrapy.org/en/latest/topics/downloader-middleware.html
+#DOWNLOADER_MIDDLEWARES = {
+#    'kami_scraper.middlewares.KamiScraperDownloaderMiddleware': 543,
+#}
+
+# Enable or disable extensions
+# See https://docs.scrapy.org/en/latest/topics/extensions.html
+#EXTENSIONS = {
+#    'scrapy.extensions.telnet.TelnetConsole': None,
+#}
+
+# Configure item pipelines
+# See https://docs.scrapy.org/en/latest/topics/item-pipeline.html
+#ITEM_PIPELINES = {
+#    'kami_scraper.pipelines.KamiScraperPipeline': 300,
+#}
+
+# Enable and configure the AutoThrottle extension (disabled by default)
+# See https://docs.scrapy.org/en/latest/topics/autothrottle.html
+#AUTOTHROTTLE_ENABLED = True
+# The initial download delay
+#AUTOTHROTTLE_START_DELAY = 5
+# The maximum download delay to be set in case of high latencies
+#AUTOTHROTTLE_MAX_DELAY = 60
+# The average number of requests Scrapy should be sending in parallel to
+# each remote server
+#AUTOTHROTTLE_TARGET_CONCURRENCY = 1.0
+# Enable showing throttling stats for every response received:
+#AUTOTHROTTLE_DEBUG = False
+
+# Enable and configure HTTP caching (disabled by default)
+# See https://docs.scrapy.org/en/latest/topics/downloader-middleware.html#httpcache-middleware-settings
+#HTTPCACHE_ENABLED = True
+#HTTPCACHE_EXPIRATION_SECS = 0
+#HTTPCACHE_DIR = 'httpcache'
+#HTTPCACHE_IGNORE_HTTP_CODES = []
+#HTTPCACHE_STORAGE = 'scrapy.extensions.httpcache.FilesystemCacheStorage'
+
+# Set settings whose default value is deprecated to a future-proof value
+REQUEST_FINGERPRINTER_IMPLEMENTATION = '2.7'
+TWISTED_REACTOR = 'twisted.internet.asyncioreactor.AsyncioSelectorReactor'

article_scraper/spiders/__init__.py

@@ -0,0 +1,4 @@
+# This package will contain the spiders of your Scrapy project
+#
+# Please refer to the documentation for information on how to create and manage
+# your spiders.

article_scraper/spiders/kami_spider.py

@@ -0,0 +1,48 @@
+import os
+import scrapy
+from langdetect import detect
+
+from ..utils.dash_remover import clean
+from ..utils.noise_word_remover import remove
+from ..utils.highlights_remover import remove_highlights
+
+
+class KamiSpider(scrapy.Spider):
+    name = 'kami'
+    print(os.getcwd())
+    start_urls = [f'file://{os.getcwd()}/3000.html']
+    
+
+    def __init__(self, **kwargs):
+        super().__init__(**kwargs) 
+
+
+    def parse(self, response):
+        articles = response.css('div.c-article-card-horizontal__container a::attr(href)').getall()
+
+        for article in articles:
+            yield response.follow(article, callback=self.parse_articles)
+
+
+    def parse_articles(self, response):
+        # for article text
+        bold_text = remove(response.css("strong::text").getall())
+        article_text = remove(response.css("div.post__content p *::text").getall())
+
+        cleaned_article_text = remove_highlights(bold_text, article_text)
+        article_text = ' '.join(cleaned_article_text).strip()
+
+        # for summary
+        highlights = list(filter(lambda x: x.startswith("-"), response.css('strong::text').getall()))
+        cleaned_highlights = list(map(clean, highlights))
+        summary = '.'.join(cleaned_highlights).strip()
+
+
+        if detect(summary) != "en":
+            yield {
+                'title': response.css("h1.c-main-headline::text").get(),
+                'article_text': article_text,
+                'summary': summary,
+                'article_date': response.css("time::text").get(),
+                'source': response.request.url
+            }

article_scraper/utils/dash_remover.py

@@ -0,0 +1,5 @@
+def clean(sentence):
+    if sentence.startswith("-"):
+        return sentence[1::]
+    
+    return sentence

article_scraper/utils/highlights_remover.py

@@ -0,0 +1,2 @@
+def remove_highlights(highlights, article_text):
+    return list(filter(lambda x: x not in highlights, article_text))

article_scraper/utils/noise_word_remover.py

@@ -0,0 +1,21 @@
+def remove(article_text):
+    noise_words = [
+        "KAMI",
+        "PAY ATTENTION:", "PAY ATTENTION",
+        ": Follow us on", "Instagram",
+        "- get the most important news directly in your favourite app!",
+        "Source: KAMI.com.gh",
+        "Like and share our Facebook posts to support the KAMI team! Share your thoughts in the comments. We love reading them!",
+        "Like and share our",
+        "Facebook posts",
+        "to support the KAMI team! Share your thoughts in the comments. We love reading them!",
+        "Click", '"See First" under the "Following" tab to see KAMI news on your News Feed',
+        'Click "See First" under the "Following" tab to see KAMI news on your News Feed',
+        'Click "See first" under the "Following" tab to see KAMI news on your Newsfeed',
+        'Click "See First" under the "Following" tab to see KAMI news on your News Feed!',
+        'Click "See First" under the "Following" tab to see',
+        "Tingnan ang mga balitang para sa'yo ➡️ hanapin ang \"Recommended for you\" block at mag-enjoy!",
+        "Update KAMI App now: the old version will be disabled on June, 15!"
+    ]
+
+    return list(filter(lambda x: x.strip() not in noise_words, article_text))

article_scraper/utils/normalizer.py

@@ -0,0 +1,5 @@
+from unicodedata import normalize
+
+
+def normalize_txt(txt):
+    return normalize('NFKD', txt)

article_scraper/utils/placeRemover.py

@@ -0,0 +1,7 @@
+def clean(txt):
+    try:
+        idx = txt.index('—')
+        txt = txt[idx+1::].strip()
+    except:
+        pass
+    return txt

scrapy.cfg

@@ -0,0 +1,11 @@
+# Automatically created by: scrapy startproject
+#
+# For more information about the [deploy] section see:
+# https://scrapyd.readthedocs.io/en/latest/deploy.html
+
+[settings]
+default = article_scraper.settings
+
+[deploy]
+#url = http://localhost:6800/
+project = article_scraper