{"id":13646759,"url":"https://github.com/commonsearch/cosr-back","last_synced_at":"2025-04-21T21:31:23.007Z","repository":{"id":201298670,"uuid":"51895196","full_name":"commonsearch/cosr-back","owner":"commonsearch","description":"Backend of Common Search. Analyses webpages and sends them to the index.","archived":false,"fork":false,"pushed_at":"2017-05-31T13:54:26.000Z","size":4561,"stargazers_count":123,"open_issues_count":42,"forks_count":24,"subscribers_count":23,"default_branch":"master","last_synced_at":"2024-11-09T20:37:45.926Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"https://about.commonsearch.org","language":"HTML","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/commonsearch.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null}},"created_at":"2016-02-17T04:44:17.000Z","updated_at":"2024-08-27T23:56:44.000Z","dependencies_parsed_at":"2024-03-21T05:15:07.131Z","dependency_job_id":null,"html_url":"https://github.com/commonsearch/cosr-back","commit_stats":null,"previous_names":["commonsearch/cosr-back"],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/commonsearch%2Fcosr-back","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/commonsearch%2Fcosr-back/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/commonsearch%2Fcosr-back/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/commonsearch%2Fcosr-back/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/commonsearch","download_url":"https://codeload.github.com/commonsearch/cosr-back/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":250136689,"owners_count":21380877,"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":[],"created_at":"2024-08-02T01:03:05.094Z","updated_at":"2025-04-21T21:31:21.952Z","avatar_url":"https://github.com/commonsearch.png","language":"HTML","funding_links":[],"categories":["HTML"],"sub_categories":[],"readme":"# cosr-back\n\n[![Chat with us on Slack](https://slack.commonsearch.org/badge.svg)](https://slack.commonsearch.org) [![Build Status](https://travis-ci.org/commonsearch/cosr-back.svg?branch=master)](https://travis-ci.org/commonsearch/cosr-back) [![Coverage Status](https://coveralls.io/repos/github/commonsearch/cosr-back/badge.svg?branch=master)](https://coveralls.io/github/commonsearch/cosr-back?branch=master) [![Apache License 2.0](https://img.shields.io/github/license/commonsearch/cosr-back.svg)](LICENSE)\n\nThis repository contains the main components of the [Common Search](https://about.commonsearch.org) backend.\n\nYour help is welcome! We have a complete guide on [how to contribute](CONTRIBUTING.md).\n\n\n## Understand the project\n\nThis repository has 4 components:\n\n - **cosrlib**: Python code for parsing, analyzing and indexing documents\n - **spark**: Spark jobs using cosrlib.\n - **urlserver**: A service for getting metadata about URLs from static databases\n - **explainer**: A web service for explaining and debugging results, hosted at [explain.commonsearch.org](https://explain.commonsearch.org/)\n\nHere is how they fit in our [general architecture](https://about.commonsearch.org/developer/architecture):\n\n![General technical architecture of Common Search](https://about.commonsearch.org/images/developer/architecture-2016-02.svg)\n\n\n## Local install\n\nA complete guide available in [INSTALL.md](INSTALL.md).\n\n\n## Launching the tests\n\nSee [tests/README.md](tests/README.md).\n\n\n## Using plugins\n\nCommon Search supports the insertion of user-provided plugins in its processing pipeline. Some are included by default, for instance:\n\n```\nmake docker_shell\nspark-submit spark/jobs/pipeline.py --source url:https://about.commonsearch.org/ --plugin plugins.grep.Words:words=\"common search\",output=/tmp/grep_result\n```\n\nSee the [plugins/](plugins/) directory for more examples and [Analyzing the web with Spark](https://about.commonsearch.org/developer/tutorials/analyzing-the-web-with-spark-on-ec2) for a complete tutorial.\n\n\n## Launching the explainer\n\nThe explainer allows you to debug results easily. Just run:\n\n```\nmake docker_explainer\n```\n\nThen open [http://192.168.99.100:9703](http://192.168.99.100:9703) in your browser (Assuming `192.168.99.100` is the IP of your Docker host)\n\n\n## Launching an index job\n\n```\nmake docker_shell\nspark-submit spark/jobs/pipeline.py --source commoncrawl:limit=1 --plugin plugins.filter.Homepages:index_body=1 --profile\n```\n\nAfter this, if you have a `cosr-front` instance connected to the same Elasticsearch service, you will see the results!\n\nA tutorial is currently being written on this topic.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcommonsearch%2Fcosr-back","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fcommonsearch%2Fcosr-back","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcommonsearch%2Fcosr-back/lists"}