{"id":34072569,"url":"https://github.com/renien/doc-diff","last_synced_at":"2025-12-14T08:02:11.758Z","repository":{"id":57423186,"uuid":"62278781","full_name":"Renien/doc-diff","owner":"Renien","description":":snake: Support app to get a diff results from two document :green_book:","archived":false,"fork":false,"pushed_at":"2017-04-02T04:11:49.000Z","size":97,"stargazers_count":5,"open_issues_count":1,"forks_count":2,"subscribers_count":3,"default_branch":"master","last_synced_at":"2025-09-30T14:32:03.628Z","etag":null,"topics":["comparison-reports","csv","datamining","datascience","doc-diff","python"],"latest_commit_sha":null,"homepage":"","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/Renien.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":"2016-06-30T04:15:43.000Z","updated_at":"2018-10-07T22:56:53.000Z","dependencies_parsed_at":"2022-09-05T10:41:53.546Z","dependency_job_id":null,"html_url":"https://github.com/Renien/doc-diff","commit_stats":null,"previous_names":[],"tags_count":1,"template":false,"template_full_name":null,"purl":"pkg:github/Renien/doc-diff","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Renien%2Fdoc-diff","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Renien%2Fdoc-diff/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Renien%2Fdoc-diff/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Renien%2Fdoc-diff/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/Renien","download_url":"https://codeload.github.com/Renien/doc-diff/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Renien%2Fdoc-diff/sbom","scorecard":{"id":119789,"data":{"date":"2025-08-11","repo":{"name":"github.com/Renien/doc-diff","commit":"628539da1d6dbaa10c9823ac5bb8df0f840ce9a3"},"scorecard":{"version":"v5.2.1-40-gf6ed084d","commit":"f6ed084d17c9236477efd66e5b258b9d4cc7b389"},"score":3,"checks":[{"name":"SAST","score":0,"reason":"no SAST tool detected","details":["Warn: no pull requests merged into dev branch"],"documentation":{"short":"Determines if the project uses static code analysis.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#sast"}},{"name":"Packaging","score":-1,"reason":"packaging workflow not detected","details":["Warn: no GitHub/GitLab publishing workflow detected."],"documentation":{"short":"Determines if the project is published as a package that others can easily download, install, easily update, and uninstall.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#packaging"}},{"name":"Token-Permissions","score":-1,"reason":"No tokens found","details":null,"documentation":{"short":"Determines if the project's workflows follow the principle of least privilege.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#token-permissions"}},{"name":"Pinned-Dependencies","score":-1,"reason":"no dependencies found","details":null,"documentation":{"short":"Determines if the project has declared and pinned the dependencies of its build process.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#pinned-dependencies"}},{"name":"Dangerous-Workflow","score":-1,"reason":"no workflows found","details":null,"documentation":{"short":"Determines if the project's GitHub Action workflows avoid dangerous patterns.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#dangerous-workflow"}},{"name":"Maintained","score":0,"reason":"0 commit(s) and 0 issue activity found in the last 90 days -- score normalized to 0","details":null,"documentation":{"short":"Determines if the project is \"actively maintained\".","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#maintained"}},{"name":"Code-Review","score":0,"reason":"Found 0/27 approved changesets -- score normalized to 0","details":null,"documentation":{"short":"Determines if the project requires human code review before pull requests (aka merge requests) are merged.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#code-review"}},{"name":"Binary-Artifacts","score":10,"reason":"no binaries found in the repo","details":null,"documentation":{"short":"Determines if the project has generated executable (binary) artifacts in the source repository.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#binary-artifacts"}},{"name":"CII-Best-Practices","score":0,"reason":"no effort to earn an OpenSSF best practices badge detected","details":null,"documentation":{"short":"Determines if the project has an OpenSSF (formerly CII) Best Practices Badge.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#cii-best-practices"}},{"name":"Security-Policy","score":0,"reason":"security policy file not detected","details":["Warn: no security policy file detected","Warn: no security file to analyze","Warn: no security file to analyze","Warn: no security file to analyze"],"documentation":{"short":"Determines if the project has published a security policy.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#security-policy"}},{"name":"Vulnerabilities","score":10,"reason":"0 existing vulnerabilities detected","details":null,"documentation":{"short":"Determines if the project has open, known unfixed vulnerabilities.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#vulnerabilities"}},{"name":"Fuzzing","score":0,"reason":"project is not fuzzed","details":["Warn: no fuzzer integrations found"],"documentation":{"short":"Determines if the project uses fuzzing.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#fuzzing"}},{"name":"License","score":10,"reason":"license file detected","details":["Info: project has a license file: LICENSE:0","Info: FSF or OSI recognized license: MIT License: LICENSE:0"],"documentation":{"short":"Determines if the project has defined a license.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#license"}},{"name":"Signed-Releases","score":-1,"reason":"no releases found","details":null,"documentation":{"short":"Determines if the project cryptographically signs release artifacts.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#signed-releases"}},{"name":"Branch-Protection","score":0,"reason":"branch protection not enabled on development/release branches","details":["Warn: branch protection not enabled for branch 'master'"],"documentation":{"short":"Determines if the default and release branches are protected with GitHub's branch protection settings.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#branch-protection"}}]},"last_synced_at":"2025-08-16T02:13:55.772Z","repository_id":57423186,"created_at":"2025-08-16T02:13:55.772Z","updated_at":"2025-08-16T02:13:55.772Z"},"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":27722653,"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","status":"online","status_checked_at":"2025-12-14T02:00:11.348Z","response_time":56,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"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":["comparison-reports","csv","datamining","datascience","doc-diff","python"],"created_at":"2025-12-14T08:02:10.718Z","updated_at":"2025-12-14T08:02:11.753Z","avatar_url":"https://github.com/Renien.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"\u003ch1 align=\"center\"\u003e\n\u003cimg src=\"https://raw.githubusercontent.com/Renien/doc-diff/master/doc/blob/doc-diff-logo.png\" alt=\"doc-diff\" width=\"20%\" height=\"20%\"\u003e\n    \u003cbr\u003e\n        doc-diff\n    \u003cbr\u003e\n  \u003ch4 align=\"center\"\u003eGenerate the diff data between two files\u003c/h4\u003e\n\u003c/h1\u003e\n\n\u003cp align=\"center\"\u003e\n  \u003ca href=\"https://github.com/Renien/doc-diff/blob/master/LICENSE\"\u003e\n    \u003cimg src=\"https://img.shields.io/npm/l/express.svg?maxAge=2592000\u0026style=flat-square\"\n         alt=\"License\"\u003e\n  \u003c/a\u003e\n  \u003ca href=\"https://travis-ci.org/Renien/doc-diff\"\u003e\n    \u003cimg src=\"https://travis-ci.org/Renien/doc-diff.svg?branch=master\"\n         alt=\"Travis Build\"\u003e\n  \u003c/a\u003e\n\u003c/p\u003e\n\n## Summary\n\nImplementation was started mainly focusing as a support app for **Data Science** work. The current implementation helps to analyse recommendations ‘CSV’ files. (i.e If you need to analyse two algorithm results this lib will be very handy)\n\n## Recommendation Format\nThe CSV file contains list of **key-value** in each line. The key is product (productCode/porductID) and the value is list of recommended products (productCode/porductID). The product code and the recommendation list is separated with _**‘TAB’**_.\n\n```\nSample Recommendation \n---------------------\n1098808\t1597549,1974410,1850731\n1161889\t1095554\n1706909\t2078866\n1815368\t2215327\n1847624\t2179582,2085753\n```\n\n## Installation\n```\n$ pip install doc-diff\n```\n\n## Features\n- Generate the following comparison reports \n    - common_in_doc1-and-doc2-%Y-%m-%d.csv  \n    - common_key_with_diff_values-%Y-%m-%d.csv  \n    - exclusive_in_doc1-%Y-%m-%d.csv\n    - exclusive_in_doc2-%Y-%m-%d.csv\n- Compare two files and return following **'dicts(prodCode, recommendation)'**\n    - common_in_doc1_and_doc2_list = dicts()\n    - common_key_with_diff_values_list = dicts()\n    - exclusive_in_doc1_list = dicts()\n    - exclusive_in_doc2_list = dicts()\n\n## Usage\n\n- Allow to generate the evaluation result files\n- Able to extract the comparsion results as key-value list \n    - Using the diifferent dictionary objects you can present the results as you like (i.e Graphs, Venn diagram) \n\n## Comparison Report Format \n\n- In CSV file each line contains the product code and the corresponding recommendation. The product code and the recommendation list is separated with **‘TAB’**.\n- In **‘common_key_with_diff_values-%Y-%m-%d.csv’** file the result format is slightly different. To show the un-matching recommendation in each line after product code TAB separation you will find the result of **‘A’ algorithm** and the **‘B' algorithm** result separated with two pipes **‘||’**.\n\n```\nSample common_key_with_diff_values-%Y-%m-%d.csv \n------------------------------------------------\nc36623\t2256360,2398464,2503472,c27214||2256360,2398464,2503472,c27214,c79033\nc973955\t1965886,c340951,c752950,c973951||1965886,c24224,c340951,c752950,c906950,c973951\nc25749\tc25982||c205950,c25982,c65977\n```\n\n## Package Directory Layout\n\n```\ndoc-diff\n├── LICENSE                         # Contains License Agreement file\n├── README.md                       # Contains the details of doc-diff lib\n├── doc_diff                        # Root package \n│   ├── Diff.py                     # Diff class\n│   ├── __init__.py                 # Package declaration \n├── setup.py                        # Setup file for packaging \n└── test                            # Test module (Includes the useage)\n    ├── __init__.py                 # Package declaration \n    ├── data                        # Sample data\n    │   ├── a-priori.csv            # A-Priori algo results\n    │   └── pfp.csv                 # FP-Growth algo results\n    └── doc_diff_app.py             # Main method file \n```\n\n## Current Published Artifacts\n\n- [doc-diff-1.0.0](https://github.com/Renien/doc-diff/tree/1.0.0/tarball)\n\n## Contribute\nFor any problem/question or if you think a feature that could make doc-diff lib more useful, do not hesitate to open an issue.\n\n## Thanks\nThanks [Flat Icon](http://www.flaticon.com/) for the free logo.\n\n## License\nMIT © [Renien](https://twitter.com/RenienJoseph)","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Frenien%2Fdoc-diff","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Frenien%2Fdoc-diff","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Frenien%2Fdoc-diff/lists"}