{"id":15564759,"url":"https://github.com/sachin-philip/suche","last_synced_at":"2025-07-19T01:32:27.357Z","repository":{"id":57472158,"uuid":"64738862","full_name":"sachin-philip/suche","owner":"sachin-philip","description":"Elasticsearch Export Framework","archived":false,"fork":false,"pushed_at":"2018-06-22T09:50:15.000Z","size":12,"stargazers_count":6,"open_issues_count":0,"forks_count":2,"subscribers_count":0,"default_branch":"master","last_synced_at":"2025-06-23T01:00:30.516Z","etag":null,"topics":["csv","elasticsearch","filter-data","json-format","multifilter-data","pickle"],"latest_commit_sha":null,"homepage":null,"language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"bsd-2-clause","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/sachin-philip.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2016-08-02T08:26:56.000Z","updated_at":"2020-06-24T18:11:45.000Z","dependencies_parsed_at":"2022-08-30T14:10:25.920Z","dependency_job_id":null,"html_url":"https://github.com/sachin-philip/suche","commit_stats":null,"previous_names":["sachinvettithanam/suche"],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/sachin-philip/suche","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/sachin-philip%2Fsuche","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/sachin-philip%2Fsuche/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/sachin-philip%2Fsuche/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/sachin-philip%2Fsuche/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/sachin-philip","download_url":"https://codeload.github.com/sachin-philip/suche/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/sachin-philip%2Fsuche/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":265871285,"owners_count":23842010,"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":["csv","elasticsearch","filter-data","json-format","multifilter-data","pickle"],"created_at":"2024-10-02T16:41:51.410Z","updated_at":"2025-07-19T01:32:27.324Z","avatar_url":"https://github.com/sachin-philip.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"Suche\n------\n\nAn Elasticsearch Export Framework\n \n## Documentation\n\n### Installation\n\n```bash\npip install suche\n```\n\nYou need to have ```elasticsearch``` installed and running. \nMore info: [https://www.elastic.co/](https://www.elastic.co/) \n    \n### Basic Usage\n\n```python\nfrom suche import Suche\nsuche = Suche(elastic_address, elastic_port, index)\n```\n**elastic_address:** address for elasticsearch (optional)\n\n**elastic_port:** port number for elasticsearch (optional)\n\n**index:** index name of elasticsearch\n\n\n## Specific Functions\n\n#### Change Index\n```python\nsuche.set_index(index)\n```\n**index:** index name of elasticsearch\n\n\n## Configuration Options\n\n\nELASTIC_ADDRESS: Address to elasticsearch\n\nELASTIC_PORT:  elasticsearch port\n\nEither, create a configuration file with name ```suche_config.json``` \nin the pwd, like below\n\n```json\n{\n  \"ELASTIC_ADDRESS\": \"localhost\",\n  \"ELASTIC_PORT\": 9200,\n  \"SUCHE_OUTPUT\": \"\"\n}\n```\n\nor\n\ncreate Suche objects with custom configuration options required \nas shown below\n\n```python\nsuche = Suche(elastic_address=\"localhost\", elastic_port=9300, \n    index=\"default\")\n```\n\n## Input Format For query\n\n#### The query input should be on below json Format for FilterData.\n\n```json\n    {\n        \"key\": \"name\",\n        \"query\": \"atm\"\n     }\n\n```\n\n#### The query input should be on below json Format for MultiFilter Data.\n\n```json\n    [\n        {\n            \"key\": \"name\",\n            \"query\": \"atm\"\n        },\n        {\n            \"key\": \"name\",\n            \"query\": \"almy\"\n        }\n     ]\n\n\n```\n\n## Advanced Features\n\n#### AllData\n\n```python\nsuche.allData(doc_type = \"person\", fields= [\"email\", \"name\"], output_format= 'csv')\n```\nMatches all data in the doc type ```doc_type``` and filter data \nin accordance to ```fields``` and return  ```output_format```\n\nCurrently available ```output_format``` : csv and pickle\n\n#### FilterData\n\nFiltering takes a single json string to process\n\n```python\nsuche.filterData(doc_type=\"person\", match_json = { \"key\": \"is_custom_domain\", \"query\": \"false\" }, \n                fields = [\"email\", \"name\", \"current_location\"], output_format= 'pkl')\n```\n* Follow input format\n\nMatches data in the doc type ```doc_type```, ```match_json``` and filter data \nin accordance to ```fields``` and return ```output_format```\n\n\n#### MultiFilter Data\n\nmultifiltering takes a dict with multiple json to process output\n\n```python\nsuche.multiMatch(doc_type=\"person\", multiple_match = [{ \"key\": \"data\", \"query\": \"false\" }, { \"key\": \"country\", \"query\": \"India\" }],\n                fields = [\"email\", \"name\", \"current_location\"], output_format= 'pkl')\n```\n* Follow input format\n\nMatches data in the doc type ```doc_type```, ```multiple_match``` and filter data \nin accordance to ```fields``` and return ```output_format```\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsachin-philip%2Fsuche","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fsachin-philip%2Fsuche","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsachin-philip%2Fsuche/lists"}