Skip to main content

open source implementation of summly

Project description

About

This package allows you to summarize text by reducing an article in size to several sentences retaining the idea of the text.

Besides of that the package extracts the following from the document:

  1. Canonical URL of the article

  2. Title of the article

  3. URL of the image characterizing this article

  4. Strips the document of excessive information (headers, footers, navigation, advertisement, etc.) and forms a clean HTML based on structured data of schema.org

DEMO

Installation

easy_install wanish
or
pip install wanish

Usage

from wanish import Wanish
wanish = Wanish()
wanish.perform_url(document_url)

# getting doc's source canonical url
url = wanish.url
# getting document's title
title = wanish.title
# getting url of related image if document has it
image_url = wanish.image_url
# getting two-letter code of the document's language (en, de, es...)
language_code = wanish.language
# getting a clean html page of a document with article
clean_html = wanish.clean_html
# getting a short summarized description of the article reduced to several sentences (5 by default)
description = wanish.description

Available kwarg options for Wanish() class (all are optional):

wanish = Wanish(url=document_url,
                positive_keywords=["main", "story"],
                negative_keywords=["banner", "adv", "similar", "top-ad"],
                summary_sentences_qty=5,
                headers={'user-agent': 'test-purposes/0.0.1'})
  • url: Allows to pass an url of a document in constructor. If set, then it will automatically launch self.perform_url(url) after initialization. Default is None.

  • positive_keywords: A list of positive search patterns in classes and ids, for example: [“main”, “story”] . Default is None.

  • negative_keywords: A list of negative search patterns in classes and ids, for example: [“banner”, “adv”, “similar”, “top-ad”] . Default is None.

  • summary_sentences_qty: Maximum quantity of sentences in summarized text of the document. Set to 5 by default.

  • headers: Dict of additional custom headers for GET request to obtain web page of the article. Default is None.

Special Thanks

http://www.apache.org/licenses/LICENSE-2.0

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

wanish-0.4.8.tar.gz (1.9 MB view details)

Uploaded Source

File details

Details for the file wanish-0.4.8.tar.gz.

File metadata

  • Download URL: wanish-0.4.8.tar.gz
  • Upload date:
  • Size: 1.9 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? No

File hashes

Hashes for wanish-0.4.8.tar.gz
Algorithm Hash digest
SHA256 235a53757a2f219a3fcdcd6c91d711912c4f23b7017eaad3d23aa7b7c89be17f
MD5 1f50910c2b89d8916878470605d8af19
BLAKE2b-256 91a8c556eddf663fdc5feeeb4d7243d95ab57e309122332647d82d1799d9db5c

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page