{"id":13416228,"url":"https://github.com/jjangsangy/ExplainToMe","last_synced_at":"2025-03-14T23:31:26.519Z","repository":{"id":28541934,"uuid":"32059020","full_name":"jjangsangy/ExplainToMe","owner":"jjangsangy","description":"Automatic Web Article Summarizer","archived":false,"fork":false,"pushed_at":"2021-09-08T00:17:18.000Z","size":5847,"stargazers_count":411,"open_issues_count":6,"forks_count":61,"subscribers_count":21,"default_branch":"master","last_synced_at":"2024-07-31T21:55:39.775Z","etag":null,"topics":["docker","heroku","nlp","python","textrank"],"latest_commit_sha":null,"homepage":"","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/jjangsangy.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2015-03-12T05:34:06.000Z","updated_at":"2024-07-18T18:38:52.000Z","dependencies_parsed_at":"2022-08-23T01:50:45.477Z","dependency_job_id":null,"html_url":"https://github.com/jjangsangy/ExplainToMe","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jjangsangy%2FExplainToMe","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jjangsangy%2FExplainToMe/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jjangsangy%2FExplainToMe/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jjangsangy%2FExplainToMe/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/jjangsangy","download_url":"https://codeload.github.com/jjangsangy/ExplainToMe/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":243663500,"owners_count":20327299,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["docker","heroku","nlp","python","textrank"],"created_at":"2024-07-30T21:00:55.734Z","updated_at":"2025-03-14T23:31:22.812Z","avatar_url":"https://github.com/jjangsangy.png","language":"Python","readme":"# ExplainToMe\n\n[![travis](https://travis-ci.org/jjangsangy/ExplainToMe.svg?branch=master)](https://travis-ci.org/jjangsangy/ExplainToMe)\n[![licence](https://img.shields.io/pypi/l/coverage.svg)](https://github.com/jjangsangy/ExplainToMe/blob/master/LICENSE)\n[![Quay](https://quay.io/repository/jjangsangy/explaintome/status)](https://quay.io/repository/jjangsangy/explaintome)\n\n## Automatic Web Article Summarizer\n\n![Front](https://github.com/jjangsangy/ExplainToMe/raw/master/static/front.jpg)\n\n[![Deploy](https://www.herokucdn.com/deploy/button.svg)](https://heroku.com/deploy)\n\n# What is it?\n\n`ExplainToMe` is a automatic text summarizer, that utilizes\n[TextRank](http://web.eecs.umich.edu/~mihalcea/papers/mihalcea.emnlp04.pdf),\na graph based algorithm to scans through the contents of a website to\nextract a concise machine generated summary. The methodology is similar\nto the way search engines return the most relevant web pages from a\nusers search query.\n\n# Support\n\nHere’s a list of Python platforms that are officially supported.\n\n* Python 2.7\n* Python 3.4\n* Python 3.5\n* pypy 2.5.0 -\u003e 2.7.9\n\n\u003e We are working on Python 3.6\n\n# Quickstart\n\n# Install\n\n## Clone Repository\n\n```bash\n$ git clone https://github.com/jjangsangy/ExplainToMe.git\n```\n\n## Create a virtualenv\n\n```bash\n$ virtualenv -p python venv\n```\n\n## Source Virtualenv\n\n```bash\n$ source venv/bin/activate\n```\n\n## Install Python Dependencies\n\n```bash\n$ pip install --upgrade pip setuptools wheel\n$ pip install -r requirements.txt\n```\n\n## Run Server\n\n```bash\n$ python manage.py runserver\nRunning on http://127.0.0.1:5000/ (Press CTRL+C to quit)\n```\n\nNow go to your browser and point it towards `http://127.0.0.1:5000`\n\n# Docker\n\nRunning ExplainToMe via the [official Docker image](https://hub.docker.com/r/jjangsangy/explaintome/)\nis an easy way to start a server if you don't want to install python.\n\nWe assume here you have already installed Docker for your system.\n\nIf you are getting started on OS X, the [Docker toolbox](https://docs.docker.com/engine/installation/mac/)\nis the first thing to checkout.\n\n```bash\n$ docker run -it -p 5000:5000 jjangsangy/ExplainToMe:latest\n```\n\nOnce the server is running, navigate to either localhost:5000 (on Linux) or\nhostname:5000 (on Mac OS X), where hostname is the IP addresses\nof your virtual machine, obtained using\n\n```bash\n$ docker-machine ip my-vm-name\n```\n\nNow access your docker machine ip at port `docker-machine-ip:5000`\n\n# Kitematic\n\nYou might also want to try [Kitematic](https://kitematic.com/) on OS X which provides a GUI for running Docker images.\nRunning ExplainToMe through Kitematic is easy, just search for the\n`jjangsangy/ExplainToMe` image, start it, and you should see it running\n\n![kitematic](https://github.com/jjangsangy/ExplainToMe/raw/master/static/kitematic.jpg)\n\n\n# Things to look forward to:\n\n-   Summaries of documents in other languages than English!\n\n# ExplainToMe API\n\nCheck out our [Swagger API Documentation](https://swaggerhub.com/api/jjangsangy/ExplainToMe)\n","funding_links":[],"categories":["Python"],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fjjangsangy%2FExplainToMe","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fjjangsangy%2FExplainToMe","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fjjangsangy%2FExplainToMe/lists"}