minet

A webmining CLI tool & library for python.

https://github.com/medialab/minet

Science Score: 49.0%

This score indicates how likely this project is to be science-related based on various indicators:

  • CITATION.cff file
  • codemeta.json file
    Found codemeta.json file
  • .zenodo.json file
    Found .zenodo.json file
  • DOI references
    Found 5 DOI reference(s) in README
  • Academic publication links
    Links to: zenodo.org
  • Committers with academic emails
  • Institutional organization owner
  • JOSS paper metadata
  • Scientific vocabulary similarity
    Low similarity (13.3%) to scientific vocabulary

Keywords

cli python webmining

Keywords from Contributors

csv tsv
Last synced: 6 months ago · JSON representation

Repository

A webmining CLI tool & library for python.

Basic Info
  • Host: GitHub
  • Owner: medialab
  • License: gpl-3.0
  • Language: Python
  • Default Branch: master
  • Homepage:
  • Size: 15.8 MB
Statistics
  • Stars: 333
  • Watchers: 14
  • Forks: 28
  • Open Issues: 104
  • Releases: 214
Topics
cli python webmining
Created about 7 years ago · Last pushed 8 months ago
Metadata Files
Readme Changelog Contributing License Zenodo

README.md

Build Status DOI download number

Minet

minet is a webmining command line tool & library for python (>= 3.8) that can be used to collect and extract data from a large variety of web sources such as raw webpages, Facebook, YouTube, Twitter, Media Cloud etc.

It adopts a very simple approach to various webmining problems by letting you perform a wide array of tasks from the comfort of the command line. No database needed: raw CSV files should be sufficient to do most of the work.

In addition, minet also exposes its high-level programmatic interface as a python library so you remain free to use its utilities to suit your use-cases better.

minet is developed by médialab SciencesPo research engineers and is the consolidation of more than a decade of webmining practices targeted at social sciences.

As such, it has been designed to be:

  1. low-tech, as it requires minimal resources such as memory, CPUs or hard drive space and should be able to work on any low-cost PC.
  2. fault-tolerant, as it is able to recover when network is bad and retry HTTP calls when suitable. What's more, most of minet commands can be resumed if aborted and are designed to run for a long time (think days or months) without leaking memory.
  3. unix-compliant, as it can be piped easily and know how to work with the usual streams.

Shortcuts: Command line documentation, Python library documentation.

fetch

How to cite?

minet is published on Zenodo as 10.5281/zenodo.4564399.

You can cite it thusly:

Guillaume Plique, Pauline Breteau, Jules Farjas, Héloïse Théro, Jean Descamps, Amélie Pellé, Laura Miguel, César Pichon, Kelly Christensen, Julien Pontoire, & Béatrice Mazoyer. (2025, Mai 14). Minet, a webmining CLI tool & library for python. (4.1.0). Zenodo. https://doi.org/10.5281/zenodo.15411918

Whirlwind tour

```bash

Downloading large amount of urls as fast as possible

minet fetch url -i urls.csv > report.csv

Extracting raw text from the downloaded HTML files

minet extract -i report.csv -I downloaded > extracted.csv

Scraping the urls found in the downloaded HTML files

minet scrape urls -i report.csv -I downloaded > scraped_urls.csv

Parsing & normalizing the scraped urls

minet url-parse scrapedurl -i scrapedurls.csv > parsed_urls.csv

Scraping data from Twitter

minet twitter scrape tweets "from:medialab_ScPo" > tweets.csv

Printing a command's help

minet twitter scrape -h

Searching videos on YouTube

minet youtube search -k "MY-YT-API-KEY" "médialab" > videos.csv ```

Summary

What it does

Minet can single-handedly:

  • Extract URLs from a text file (or a table)
  • Parse URLs (get useful information, with Facebook- and Youtube-specific stuff)
  • Join two CSV files by matching the columns containing URLs
  • From a list of URLs, resolve their redirections
    • ...and check their HTTP status
    • ...and download the HTML
    • ...and extract hyperlinks
    • ...and extract the text content and other metadata (title...)
    • ...and scrape structured data (using a declarative language to define your heuristics)
  • Crawl (using a declarative language to define a browsing behavior, and what to harvest)
  • Mine or search:
  • Scrape (without requiring special access, often just a user account):
  • Grab & dump cookies from your browser
  • Dump Hyphe data

Documented use cases

Features (from a technical standpoint)

  • Multithreaded, memory-efficient fetching from the web.
  • Multithreaded, scalable crawling.
  • Multiprocessed raw text content extraction from HTML pages.
  • Multiprocessed scraping from HTML pages.
  • URL-related heuristics utilities such as extraction, normalization and matching.
  • Data collection from various APIs such as YouTube.

Installation

minet can be installed as a standalone CLI tool (currently only on mac >= 10.14, ubuntu & similar) by running the following command in your terminal:

shell curl -sSL https://raw.githubusercontent.com/medialab/minet/master/scripts/install.sh | bash

Don't trust us enough to pipe the result of a HTTP request into bash? We wouldn't either, so feel free to read the installation script here and run it on your end if you prefer.

On ubuntu & similar you might need to install curl and unzip before running the installation script if you don't already have it:

shell sudo apt-get install curl unzip

Else, minet can be installed directly as a python CLI tool and library using pip:

shell pip install minet

Finally if you want to install the standalone binaries by yourself (even for windows) you can find them in each release here.

Upgrading

To upgrade the standalone version, simply run the install script once again:

shell curl -sSL https://raw.githubusercontent.com/medialab/minet/master/scripts/install.sh | bash

To upgrade the python version you can use pip thusly:

shell pip install -U minet

Uninstallation

To uninstall the standalone version:

shell curl -sSL https://raw.githubusercontent.com/medialab/minet/master/scripts/uninstall.sh | bash

To uninstall the python version:

shell pip uninstall minet

Documentation

Contributing

To contribute to minet you can check out this documentation.

Owner

  • Name: médialab Sciences Po
  • Login: medialab
  • Kind: organization
  • Location: Paris, France

SciencesPo's médialab is an interdisciplinary research laboratory gathering engineers, designers & social science researchers.

GitHub Events

Total
  • Create event: 14
  • Commit comment event: 2
  • Release event: 6
  • Issues event: 34
  • Watch event: 40
  • Delete event: 2
  • Issue comment event: 34
  • Push event: 114
  • Pull request review event: 13
  • Pull request review comment event: 23
  • Pull request event: 14
  • Fork event: 5
Last Year
  • Create event: 14
  • Commit comment event: 2
  • Release event: 6
  • Issues event: 34
  • Watch event: 40
  • Delete event: 2
  • Issue comment event: 34
  • Push event: 114
  • Pull request review event: 13
  • Pull request review comment event: 23
  • Pull request event: 14
  • Fork event: 5

Committers

Last synced: 9 months ago

All Time
  • Total Commits: 3,081
  • Total Committers: 23
  • Avg Commits per committer: 133.957
  • Development Distribution Score (DDS): 0.081
Past Year
  • Commits: 108
  • Committers: 6
  • Avg Commits per committer: 18.0
  • Development Distribution Score (DDS): 0.324
Top Committers
Name Email Commits
Yomguithereal g****e@g****m 2,831
bmaz b****r@g****m 48
ameliepelle 8****e 40
paubre p****u@o****r 34
MiguelLaura 1****a 28
heloisethero t****e@g****m 27
farjasju j****s@g****m 18
César c****n@g****m 10
d3scmps 6****s 8
Kelly Christensen 6****l 7
Benjamin Ooghe-Tabanou b****e@s****r 6
julienp 1****e 4
Kelly Christensen k****n@s****r 3
Mathieu Jacomy M****y@g****m 3
Paul Girard p****l@o****m 3
ArnaudMolo hi@o****r 2
uf0 s****2@g****m 2
Kian-Meng Ang k****g@g****m 2
Damien d****n@d****o 1
David Libeau D****u 1
Hélène Herman 7****i 1
V24 5****8 1
camillechanial c****l@g****m 1
Committer Domains (Top 20 + Academic)

Issues and Pull Requests

Last synced: 6 months ago

All Time
  • Total issues: 333
  • Total pull requests: 35
  • Average time to close issues: 6 months
  • Average time to close pull requests: 7 days
  • Total issue authors: 23
  • Total pull request authors: 8
  • Average comments per issue: 0.49
  • Average comments per pull request: 0.34
  • Merged pull requests: 29
  • Bot issues: 0
  • Bot pull requests: 0
Past Year
  • Issues: 19
  • Pull requests: 17
  • Average time to close issues: 1 day
  • Average time to close pull requests: 6 days
  • Issue authors: 7
  • Pull request authors: 4
  • Average comments per issue: 0.84
  • Average comments per pull request: 0.53
  • Merged pull requests: 14
  • Bot issues: 0
  • Bot pull requests: 0
Top Authors
Issue Authors
  • Yomguithereal (289)
  • boogheta (15)
  • kat-kel (4)
  • lakonis (3)
  • Tyrannas (2)
  • bmaz (2)
  • csamson-sf (2)
  • evancheval (1)
  • florianezanella (1)
  • TeaS0710 (1)
  • vatsal-kavida (1)
  • aborruso (1)
  • 16arpi (1)
  • wacns (1)
  • billmetangmo (1)
Pull Request Authors
  • jpontoire (7)
  • uf0 (6)
  • bmaz (6)
  • 16arpi (5)
  • kat-kel (4)
  • kianmeng (3)
  • boogheta (2)
  • camillechanial (2)
Top Labels
Issue Labels
enhancement (152) bug (98) refactor (64) documentation (10) optimization (9) investigation (8) dx (8) typing (6) question (4) exploration (3) discussion (2)
Pull Request Labels
enhancement (1)

Dependencies

.github/workflows/build.yml actions
  • actions/checkout v2 composite
  • actions/setup-python v2 composite
  • pypa/gh-action-pypi-publish release/v1 composite
  • svenstaro/upload-release-action v2 composite
  • vimtor/action-zip v1 composite
.github/workflows/tests.yml actions
  • actions/checkout v2 composite
  • actions/setup-python v2 composite
requirements.txt pypi
  • PyInstaller ==4.10
  • beautifulsoup4 ==4.11.1
  • black ==22.3.0
  • browser-cookie3 ==0.16.2
  • casanova ==0.19.2
  • cchardet >=2.1.7
  • colorama ==0.4.4
  • dateparser ==1.1.1
  • ebbe ==1.9.0
  • importchecker ==2.0
  • json5 ==0.8.5
  • keyring <19.3
  • lxml ==4.8.0
  • ndjson ==0.3.1
  • persist-queue ==0.7.0
  • pytest ==3.5.1
  • pyyaml ==5.4.1
  • quenouille ==1.4.3
  • soupsieve >=2.1
  • tenacity ==7.0.0
  • termcolor ==1.1.0
  • tqdm ==4.60.0
  • trafilatura ==1.2.0
  • twine ==3.6.0
  • twitwi ==0.15.0
  • ural ==0.37.0
  • urllib3 ==1.26.9
  • wheel *
setup.py pypi
  • beautifulsoup4 >=4.7.1
  • browser-cookie3 ==0.16.2
  • casanova >=0.19.2,<0.20
  • cchardet >=2.1.7
  • colorama >=0.4.0
  • dateparser >=1.1.1
  • ebbe >=1.9.0,<2
  • json5 >=0.8.5
  • keyring <19.3
  • lxml >=4.3.0
  • ndjson >=0.3.1
  • persist-queue >=0.7.0
  • pyyaml *
  • quenouille >=1.4.3,<2
  • soupsieve >=2.1
  • tenacity >=7.0.0
  • termcolor >=1.0.0
  • tqdm >=4.60.0
  • trafilatura >=1.2.0,<1.3
  • twitwi >=0.15.0,<0.16
  • ural >=0.37.0,<0.38
  • urllib3 >=1.26.9,<2
docs/presentations/fosdem2020/package-lock.json npm
  • 313 dependencies
docs/presentations/fosdem2020/package.json npm
  • @marp-team/marp-cli ^0.17.4 development
docs/presentations/package-lock.json npm
  • array-union 1.0.2 development
  • array-uniq 1.0.3 development
  • async 2.6.3 development
  • balanced-match 1.0.0 development
  • brace-expansion 1.1.11 development
  • commander 2.20.3 development
  • concat-map 0.0.1 development
  • email-addresses 3.1.0 development
  • escape-string-regexp 1.0.5 development
  • filename-reserved-regex 1.0.0 development
  • filenamify 1.2.1 development
  • filenamify-url 1.0.0 development
  • fs-extra 8.1.0 development
  • fs.realpath 1.0.0 development
  • gh-pages 2.2.0 development
  • glob 7.1.6 development
  • globby 6.1.0 development
  • graceful-fs 4.2.3 development
  • humanize-url 1.0.1 development
  • inflight 1.0.6 development
  • inherits 2.0.4 development
  • is-plain-obj 1.1.0 development
  • jsonfile 4.0.0 development
  • lodash 4.17.15 development
  • minimatch 3.0.4 development
  • normalize-url 1.9.1 development
  • object-assign 4.1.1 development
  • once 1.4.0 development
  • path-is-absolute 1.0.1 development
  • pify 2.3.0 development
  • pinkie 2.0.4 development
  • pinkie-promise 2.0.1 development
  • prepend-http 1.0.4 development
  • query-string 4.3.4 development
  • sort-keys 1.1.2 development
  • strict-uri-encode 1.1.0 development
  • strip-outer 1.0.1 development
  • strip-url-auth 1.0.1 development
  • trim-repeated 1.0.0 development
  • universalify 0.1.2 development
  • wrappy 1.0.2 development
docs/presentations/package.json npm
  • gh-pages ^2.2.0 development