readability-extractor

v0.0.6

Javascript wrapper around Mozilla Readability for ArchiveBox to call as a oneshot CLI to extract article text For more information about how to use this package see README

Latest version published 1 year ago

License: MIT

NPM

GitHub

Package Health Score

46 / 100

security
No known security issues
popularity
Limited
maintenance
Inactive
community
Limited

Security

No known security issues

All security vulnerabilities belong to production dependencies of direct and indirect packages.

Security and license risk for significant versions

All Versions

Version				Vulnerabilities	License Risk
0.0.6	\|	01/2023	Popular	0 C 0 H 0 M 0 L	0 H 0 M 0 L

License

MIT

Security Policy

Is your project affected by vulnerabilities?

Scan your projects for vulnerabilities. Fix quickly with automated fixes. Get started with Snyk for free.

Get started free

Popularity

Limited

Weekly Downloads (21)

GitHub Stars: 35
Forks: 13
Contributors: 3

Direct Usage Popularity

The npm package readability-extractor receives a total of 21 downloads a week. As such, we scored readability-extractor popularity level to be Limited.

Based on project statistics from the GitHub repository for the npm package readability-extractor, we found that it has been starred 35 times.

Downloads are calculated as moving averages for a period of the last 12 months, excluding weekends and known missing data points.

Community

Limited

Readme.md: Yes
Contributing.md: No
Code of Conduct: No
Contributors: 3
Funding: Yes

This project has seen only 10 or less contributors.

We found a way for you to contribute to the project! Looks like readability-extractor is missing a Code of Conduct.

Embed Package Health Score Badge

Maintenance

Inactive

Commit Frequency

Open Issues: 0
Open PR: 1
Last Release: 1 year ago
Last Commit: 3 months ago

Further analysis of the maintenance status of readability-extractor based on released npm versions cadence, the repository activity, and other data points determined that its maintenance is Inactive.

An important project maintenance signal to consider for readability-extractor is that it hasn't seen any new versions released to npm in the past 12 months, and could be considered as a discontinued project, or that which receives low attention from its maintainers.

In the past month we didn't find any pull request activity or change in issues status has been detected for the GitHub repository.

Keep your project healthy

Check your package.json

Ensure all the packages you're using are healthy and well-maintained

Snyk Vulnerability Scanner

Get health score & security insights directly in your IDE

Package

Node.js Compatibility: not defined

Age: 1 year
Dependencies: 3 Direct
Versions: 5
Install Size: 4.92 kB
Dist-tags: 1
# of Files: 3
Maintainers: 1
TS Typings: No

readability-extractor has more than a single and default latest tag published for the npm package. This means, there may be other tags available for this package, such as next to indicate future releases, or stable to indicate stable releases.

Readme

Readability-Extractor

This is a tiny JS wrapper library around Mozilla's article-text extraction tool https://github.com/mozilla/readability.

It's designed to be used as an ArchiveBox archive method.

Install

npm install -g 'git+https://github.com/pirate/readability-extractor'

# which is equivalent to this:
curl https://raw.githubusercontent.com/pirate/readability-extractor/master/readability-extractor &gt; /usr/local/bin/readability-extractor
chmod +x /usr/local/bin/readability-extractor

Usage

# readability-extractor <input path="">   &gt; <output path="">
readability-extractor some_article.html 'https://exmaple.com/original/url/some/article.html' 'UTF-8' &gt; some_article.json

{
    "title": "Title autodetected from article html",
    "byline": "Autodetected author...",
    "excerpt": "Autodetected short description",
    "dir": "ltr",
    "length": 1337,
    "lang": null,
    "charset": "UTF-8",
    "content": "<div class="\&quot;page\&quot;" id="\&quot;readability-page-1\&quot;">abc some article body text...</div>",
    "textContent": "abc some article body text..."
}

ArchiveBox Integration

# You don't have to run these commands usually.
# Readability is on by default and ArchiveBox will find any 
# installed version in your $PATH automatically

# However, if you explicitly want to turn readability on
# and/or specify a manual path to the binary, you can do this:
archivebox config --set SAVE_READABILITY=True
archivebox config --set READABILITY_BINARY="$(which readability-extractor)"

# test archiving oneshot using only singlefile+readability
archivebox add --extract=singlefile,readability 'https://exmaple.com'
```</output>

readability-extractor dependencies

@mozilla/readability jsdom dompurify

FAQs

What is readability-extractor?

Javascript wrapper around Mozilla Readability for ArchiveBox to call as a oneshot CLI to extract article text. Visit Snyk Advisor to see a full health score report for readability-extractor, including popularity, security, maintenance & community analysis.

Is readability-extractor popular?

The npm package readability-extractor receives a total of 21 weekly downloads. As such, readability-extractor popularity was classified as limited. Visit the popularity section on Snyk Advisor to see the full health analysis.

Is readability-extractor well maintained?

We found indications that readability-extractor is an Inactive project. See the full package health analysis to learn more about the package maintenance status.

Is readability-extractor safe to use?

The npm package readability-extractor was scanned for known vulnerabilities and missing license, and no issues were found. Thus the package was deemed as safe to use. See the full health analysis review.

Last updated on 13 July-2024, at 23:50 (UTC).

Build a secure application checklist

Select a recommended open source package

Minimize your risk by selecting secure & well maintained open source packages

DONE

Scan your app for vulnerabilities

Scan your application to find vulnerabilities in your: source code, open source dependencies, containers and configuration files

SCAN NOW

Fix identified vulnerabilities

Easily fix your code by leveraging automatically generated PRs

AUTO FIX

Monitor for new issues

New vulnerabilities are discovered every day. Get notified if your application is affected

MONITOR APP