{"id":19205048,"url":"https://github.com/avirsaha/documind","last_synced_at":"2025-05-12T16:41:46.045Z","repository":{"id":176666292,"uuid":"657599810","full_name":"avirsaha/DocuMind","owner":"avirsaha","description":"DocuMind - Python project for document analysis. Analyze, summarize, and determine sentiment in text and word documents. Supports .txt and .docx formats. Unlock the power of document analysis!","archived":false,"fork":false,"pushed_at":"2024-09-11T15:30:06.000Z","size":13,"stargazers_count":5,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"master","last_synced_at":"2025-04-20T14:43:03.204Z","etag":null,"topics":["natural-language-processing","python-application"],"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/avirsaha.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","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,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2023-06-23T12:17:06.000Z","updated_at":"2025-02-13T08:40:15.000Z","dependencies_parsed_at":"2024-11-09T13:11:06.409Z","dependency_job_id":"d5e018a4-93c9-46c4-8fb7-6538e9992b97","html_url":"https://github.com/avirsaha/DocuMind","commit_stats":null,"previous_names":["aviraj06/documind","avirsaha/documind"],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/avirsaha%2FDocuMind","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/avirsaha%2FDocuMind/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/avirsaha%2FDocuMind/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/avirsaha%2FDocuMind/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/avirsaha","download_url":"https://codeload.github.com/avirsaha/DocuMind/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":253778217,"owners_count":21962830,"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":["natural-language-processing","python-application"],"created_at":"2024-11-09T13:11:01.571Z","updated_at":"2025-05-12T16:41:46.026Z","avatar_url":"https://github.com/avirsaha.png","language":"Python","readme":"\n# DocuMind - Document Analysis Module\n\nDocuMind is a document analysis module that provides functionality to analyze text documents, including summarization and sentiment analysis.\n\n\n**Author**: Aviraj Saha  \n**Copyright**: ©Aviraj Saha 2023\n\n\n## Table of Contents\n- [Overview](#overview)\n- [Installation](#installation)\n- [Usage](#usage)\n- [Example](#example)\n- [Contributing](#contributing)\n- [License](#license)\n\n## Overview\n\nThe module consists of three main files:\n\n- `main.py`: This file is the entry point of the DocuMind document analysis module. It provides a command-line interface for analyzing text documents. It uses the `doc_analyzer` module to perform document analysis and outputs the results to a file.\n\n- `doc_analyzer.py`: This file contains the `Document`, `TextDocument`, and `WordDocument` classes that encapsulate the functionality for document summarization and sentiment analysis. It uses the Sumy library for text summarization and the TextBlob library for sentiment analysis.\n\n- `cmd_utility.py`: This file contains the command-line utility functions for parsing command-line arguments, handling logging, and calling the `output` function in `main.py`.\n\n## Installation\n\n1. Clone this repository to your local machine:\n\n   ```bash\n   git clone https://github.com/Aviraj06/DocuMind.git\n   ```\n\n2. Navigate to the project directory:\n\n   ```bash\n   cd DocuMind\n   ```\n\n3. Install the required dependencies:\n\n   ```bash\n   pip install -r requirements.txt\n   ```\n\n## Usage\n\nTo analyze a text document using DocuMind, follow these steps:\n\n1. Open a terminal or command prompt and navigate to the project directory.\n\n2. Run the `main.py` script:\n\n   ```bash\n   python main.py\n   ```\n\n3. You will be prompted to enter the path to the input document (.txt or .docx), the output path, and the number of sentences for the summary.\n\n4. The script will analyze the document and generate an output file with the summarized text and sentiment analysis results.\n\n\n## Example\n\n```shell\npython main.py\n```\n\n**Sample Output:**\n\n```\nDocuMind - A document analysis module.\n\nThis module provides functionality to analyze text documents, including summarization and sentiment analysis.\n\nAuthor: Aviraj Saha\nCopyright: ©Aviraj Saha 2023\n\nEnter a valid file path for .txt or a .docx file: path/to/input/document.txt\nEnter path for output: path/to/output/\nEnter number of lines for summary: 3\n\nLoading: 100%|█████████████████████████████████████████████████████████████| 100/100 [00:03\u003c00:00, 32.11it/s]\n\nProcess finished successfully!\nResults saved at: path/to/output/document_documind_output.txt\n```\n\n## Contributing\n\nContributions to DocuMind are welcome! If you would like to contribute to this project, please follow these steps:\n\n1. Fork the repository.\n\n2. Create a new branch for your feature/bug fix:\n\n   ```bash\n   git checkout -b feature/your-feature\n   ```\n\n3. Make your changes and commit them:\n\n   ```bash\n   git commit -m \"Add your commit message\"\n   ```\n\n4. Push your changes to your forked repository:\n\n   ```bash\n   git push origin feature/your-feature\n   ```\n\n5. Open a pull request on the original repository.\n\n## License\n\nThis project is licensed under the [MIT License](LICENSE).\n\n```","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Favirsaha%2Fdocumind","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Favirsaha%2Fdocumind","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Favirsaha%2Fdocumind/lists"}