‹ Reports
The Dispatch

OSS Report: Cinnamon/kotaemon


Development Stagnation Raises Concerns for Cinnamon/kotaemon's Future

Cinnamon/kotaemon, an open-source tool for document interaction leveraging Retrieval-Augmented Generation (RAG), faces potential stability issues as user-reported bugs and installation challenges accumulate without resolution.

Recent Activity

Recent issues and pull requests reveal a pattern of user-reported bugs, particularly concerning file handling and installation difficulties. Issue #143 highlights a recurring error during file uploads and indexing, while Issue #136 underscores the struggles non-technical users face during installation. These issues suggest a need for improved documentation and streamlined setup processes.

Development Team Activity

  1. Trung Duc Nguyen (trducng)

    • Focused on improving indexing and UI updates.
    • 31 commits with 2820 changes.
  2. Tuan Anh Nguyen Dang (Tadashi_Cin) (taprosoft)

    • Worked on UI issues, conversation features, and indexing pipelines.
    • 15 commits with 18709 changes.
  3. Kan_Cin (phv2312)

    • Refactored model code and updated UI components.
    • 10 commits with 3717 changes.
  4. Ian (lone17)

    • Added GitHub star history and modified workflows.
    • 2 commits with 18 changes.
  5. Quang (Albert) (cin-albert)

    • Added contribution templates.
    • 1 commit with 153 changes.
  6. John Freier (gofullthrottle)

    • Updated documentation navigation.
    • 1 commit with 2 changes.
  7. Doviettung96 (cin-ace)

    • No recent commits but contributed one merged PR.

Of Note

Quantified Reports

Quantify Issues



Recent GitHub Issues Activity

Timespan Opened Closed Comments Labeled Milestones
7 Days 18 16 97 11 1
30 Days 18 19 97 11 1
90 Days 18 19 97 11 1
All Time 52 32 - - -

Like all software activity quantification, these numbers are imperfect but sometimes useful. Comments, Labels, and Milestones refer to those issues opened in the timespan in question.

Quantify commits



Quantified Commit Activity Over 30 Days

Developer Avatar Branches PRs Commits Files Changes
Tuan Anh Nguyen Dang (Tadashi_Cin) 3 13/10/3 15 134 18709
kan_cin (phv2312) 4 3/1/2 10 15 3717
trducng 4 0/0/0 31 32 2820
Quang (Albert) 1 1/1/0 1 4 153
ian 1 2/2/0 2 2 18
John Freier 1 1/1/0 1 1 2
Ben Dykstra (bfdykstra) 0 1/0/0 0 0 0
cin-ace (doviettung96) 0 0/0/1 0 0 0

PRs: created by that dev and opened/merged/closed-unmerged during the period

Detailed Reports

Report On: Fetch issues



Recent Activity Analysis

The recent activity on the Cinnamon/kotaemon GitHub repository indicates a surge in user-reported issues, with 20 open issues currently logged. Notably, several of these issues pertain to bugs related to file handling and installation complications, suggesting potential stability concerns in the software. A recurring theme across multiple issues is the difficulty users face when trying to set up the application, particularly for non-technical users, which highlights a need for clearer documentation and streamlined installation processes.

Several issues stand out due to their implications for user experience and software reliability. For instance, Issue #143 describes an error encountered during file uploads and indexing, which has received multiple comments from users experiencing similar problems. This indicates that the issue may not be isolated and could affect a broader user base. Additionally, Issue #136 reflects challenges faced by non-technical users during installation, emphasizing the need for improved onboarding materials.

Issue Details

Recently Created Issues

  1. Issue #148: RetryError

    • Priority: Bug
    • Status: Open
    • Created: 0 days ago
    • Description: Encountering tenacity.RetryError during API calls.
  2. Issue #145: [REQUEST] - Docker image for arm architectures

    • Priority: Enhancement
    • Status: Open
    • Created: 1 day ago
    • Description: Request for ARM architecture support in Docker images.
  3. Issue #143: [BUG] -

    • Priority: Bug
    • Status: Open
    • Created: 1 day ago
    • Description: Error encountered when uploading and indexing files.
  4. Issue #142: [BUG] - Error when installing graphrag

    • Priority: Bug
    • Status: Open
    • Created: 1 day ago
    • Description: Installation error related to package dependencies.
  5. Issue #140: Error in create_base_entity_graph Step During Indexing

    • Priority: Bug
    • Status: Open
    • Created: 2 days ago
    • Description: Failure at the create_base_entity_graph step during indexing.

Recently Updated Issues

  1. Issue #143: [BUG] -

    • Last Updated: 0 days ago (active discussion with multiple comments)
  2. Issue #141: [BUG] - Password change is not working</strong></p> <ul> <li><strong>Last Updated:</strong> 0 days ago (issue confirmed on Docker)</li> </ul> </li> <li> <p><strong>Issue <a href="https://github.com/Cinnamon/kotaemon/issues/138">#138</a>: Steps I took to get local app working</strong></p> <ul> <li><strong>Last Updated:</strong> 1 day ago (user shared detailed setup steps)</li> </ul> </li> <li> <p><strong>Issue <a href="https://github.com/Cinnamon/kotaemon/issues/136">#136</a>: cannot install(non technical)</strong></p> <ul> <li><strong>Last Updated:</strong> 1 day ago (ongoing discussion about installation difficulties)</li> </ul> </li> <li> <p><strong>Issue <a href="https://github.com/Cinnamon/kotaemon/issues/135">#135</a>: Cannot launch (non-technical person)</strong></p> <ul> <li><strong>Last Updated:</strong> 2 days ago (user reported launch failure with detailed traceback)</li> </ul> </li> </ol> <h3>Summary of Observations</h3> <p>The current state of open issues indicates that while there is significant user engagement with the project, many users are encountering obstacles that could hinder adoption and satisfaction. The presence of multiple bugs related to file handling and installation suggests that developers may need to prioritize these areas in upcoming releases to enhance stability and usability. Additionally, the requests for enhancements indicate a proactive community looking to expand the tool's capabilities, particularly regarding platform compatibility with ARM architectures.</p> </div> <div id="aspect_4" class="report-section"> <h2 class="secondary-divider">Report On: Fetch pull requests</h2> <a name="aspect_4"></a> <br/><br/> <h1>Report on Pull Requests</h1> <h2>Overview</h2> <p>The analysis of the pull requests (PRs) for the Cinnamon/kotaemon project reveals a dynamic development environment with a mix of new features, bug fixes, and enhancements aimed at improving the user experience and functionality of the application. Currently, there is one open PR and a total of 95 closed PRs, indicating active engagement from contributors.</p> <h2>Summary of Pull Requests</h2> <h3>Open Pull Requests</h3> <ul> <li><strong>PR <a href="https://github.com/Cinnamon/kotaemon/issues/144">#144</a>: Fixes/setup instructions</strong><ul> <li><strong>State:</strong> Open</li> <li><strong>Created:</strong> 1 day ago</li> <li><strong>Description:</strong> This PR aims to enhance the documentation by adding setup instructions for running the app locally without Docker. It also modifies the <code>run_macos.sh</code> script to install necessary dependencies and adds <code>unstructured</code> to the dependency list.</li> <li><strong>Significance:</strong> This PR addresses issue <a href="https://github.com/Cinnamon/kotaemon/issues/138">#138</a> and is crucial for improving onboarding for new developers or users unfamiliar with Docker.</li> </ul> </li> </ul> <h3>Closed Pull Requests</h3> <ul> <li> <p><strong>PR <a href="https://github.com/Cinnamon/kotaemon/issues/147">#147</a>: hotfix: pwd change</strong></p> <ul> <li><strong>State:</strong> Closed</li> <li><strong>Merged:</strong> 0 days ago</li> <li><strong>Description:</strong> A quick fix for a password change issue, addressing issue <a href="https://github.com/Cinnamon/kotaemon/issues/141">#141</a>.</li> </ul> </li> <li> <p><strong>PR <a href="https://github.com/Cinnamon/kotaemon/issues/139">#139</a>: feat: Add contribution templates</strong></p> <ul> <li><strong>State:</strong> Closed</li> <li><strong>Merged:</strong> 1 day ago</li> <li><strong>Description:</strong> Introduces templates for PRs and issues to streamline contributions.</li> </ul> </li> <li> <p><strong>PR <a href="https://github.com/Cinnamon/kotaemon/issues/137">#137</a>: Add github star history</strong></p> <ul> <li><strong>State:</strong> Closed</li> <li><strong>Merged:</strong> 1 day ago</li> <li><strong>Description:</strong> Adds a section in the README to display GitHub star history, serving as motivation for contributors.</li> </ul> </li> <li> <p><strong>PR <a href="https://github.com/Cinnamon/kotaemon/issues/129">#129</a>: Minor URL Fix</strong></p> <ul> <li><strong>State:</strong> Closed</li> <li><strong>Merged:</strong> 2 days ago</li> <li><strong>Description:</strong> Fixes a link in the navigation bar pointing to the Live Demo.</li> </ul> </li> <li> <p><strong>PR <a href="https://github.com/Cinnamon/kotaemon/issues/126">#126</a>: Update release workflow</strong></p> <ul> <li><strong>State:</strong> Closed</li> <li><strong>Merged:</strong> 2 days ago</li> <li><strong>Description:</strong> Updates the release workflow to change the default version bump behavior.</li> </ul> </li> <li> <p><strong>PR <a href="https://github.com/Cinnamon/kotaemon/issues/124">#124</a>: chore: update workflow</strong></p> <ul> <li><strong>State:</strong> Closed</li> <li><strong>Merged:</strong> 3 days ago</li> <li><strong>Description:</strong> General updates to workflow files for better CI/CD practices.</li> </ul> </li> <li> <p><strong>PR <a href="https://github.com/Cinnamon/kotaemon/issues/123">#123</a>: feat: merge develop</strong></p> <ul> <li><strong>State:</strong> Closed</li> <li><strong>Merged:</strong> 3 days ago</li> <li><strong>Description:</strong> Merges significant changes from the develop branch into main, including various feature additions and bug fixes.</li> </ul> </li> <li> <p>... [Additional PRs omitted for brevity]</p> </li> </ul> <h2>Analysis of Pull Requests</h2> <p>The recent activity within the Cinnamon/kotaemon repository reflects a robust development process with a clear focus on enhancing user experience and functionality. The open pull request (<a href="https://github.com/Cinnamon/kotaemon/issues/144">#144</a>) is particularly noteworthy as it aims to improve setup documentation, which is essential for onboarding new users and contributors. The discussion around this PR indicates a thoughtful approach to making installation easier without imposing unnecessary dependencies like Homebrew or libmagic, which could complicate setups for non-developers.</p> <p>The closed pull requests demonstrate a mix of feature enhancements, bug fixes, and maintenance tasks. Notably, several PRs have focused on improving workflows (e.g., PR <a href="https://github.com/Cinnamon/kotaemon/issues/126">#126</a> and PR <a href="https://github.com/Cinnamon/kotaemon/issues/124">#124</a>), which suggests an ongoing effort to streamline development processes. The addition of contribution templates (PR <a href="https://github.com/Cinnamon/kotaemon/issues/139">#139</a>) is another positive step towards fostering community involvement by making it easier for new contributors to engage with the project.</p> <p>A recurring theme in these PRs is the emphasis on user interface improvements and backend optimizations. For instance, PRs related to enhancing retrieval mechanisms (e.g., PR <a href="https://github.com/Cinnamon/kotaemon/issues/102">#102</a>) indicate that developers are actively working on refining core functionalities that directly impact user experience. The introduction of features like sharing conversation history (PR <a href="https://github.com/Cinnamon/kotaemon/issues/108">#108</a>) aligns well with modern expectations for interactive applications, enhancing usability.</p> <p>However, there are also indications of potential disputes or differing opinions among contributors, particularly regarding dependency management in PR <a href="https://github.com/Cinnamon/kotaemon/issues/144">#144</a>. The comments from Quang (Albert) raise valid concerns about making certain dependencies optional and ensuring that installation methods cater to varying levels of user expertise. Such discussions are crucial as they can lead to more robust solutions but may also highlight underlying tensions in decision-making processes within the team.</p> <p>The repository's activity level—169 commits across multiple branches—demonstrates a healthy pace of development. However, it is essential to monitor how many open issues remain unresolved and whether there are any bottlenecks in merging significant feature branches into main. The presence of several draft or unmerged PRs suggests that while contributions are being made, not all are being integrated promptly.</p> <p>In conclusion, Cinnamon/kotaemon is positioned well within its domain, with active contributions aimed at improving both functionality and user experience. Continued attention to community engagement through clear documentation and streamlined contribution processes will be vital as the project evolves.</p> </div> <div id="aspect_5" class="report-section"> <h2 class="secondary-divider">Report On: Fetch commits</h2> <a name="aspect_5"></a> <br/><br/> <h1>Repo Commits Analysis</h1> <h2>Development Team and Recent Activity</h2> <h3>Team Members:</h3> <ol> <li> <p><strong>Tuan Anh Nguyen Dang (Tadashi_Cin) (taprosoft)</strong></p> <ul> <li>Recent activity includes:</li> <li>Fixing UI issues and updating settings in various files.</li> <li>Adding new features like conversation name suggestions and quick indexing pipelines.</li> <li>Collaborating with other team members on multiple fixes and enhancements across branches.</li> <li>Total of 15 commits with 18709 changes in the last 30 days.</li> </ul> </li> <li> <p><strong>Ian (lone17)</strong></p> <ul> <li>Recent activity includes:</li> <li>Adding GitHub star history and modifying workflows.</li> <li>Total of 2 commits with 18 changes in the last 30 days.</li> </ul> </li> <li> <p><strong>Quang (Albert) (cin-albert)</strong></p> <ul> <li>Recent activity includes:</li> <li>Adding contribution templates to the repository.</li> <li>Total of 1 commit with 153 changes in the last 30 days.</li> </ul> </li> <li> <p><strong>John Freier (gofullthrottle)</strong></p> <ul> <li>Recent activity includes:</li> <li>Updating documentation navigation.</li> <li>Total of 1 commit with 2 changes in the last 30 days.</li> </ul> </li> <li> <p><strong>Kan_Cin (phv2312)</strong></p> <ul> <li>Recent activity includes:</li> <li>Refactoring model code and updating UI components.</li> <li>Total of 10 commits with 3717 changes in the last 30 days.</li> </ul> </li> <li> <p><strong>Trung Duc Nguyen (trducng)</strong></p> <ul> <li>Recent activity includes:</li> <li>Multiple commits focused on improving indexing, retrieval logic, and UI updates.</li> <li>Total of 31 commits with 2820 changes in the last 30 days.</li> </ul> </li> <li> <p><strong>Doviettung96 (cin-ace)</strong></p> <ul> <li>No recent commits but has one merged PR.</li> </ul> </li> </ol> <h3>Summary of Activities</h3> <ul> <li>The team has been actively working on various features, bug fixes, and improvements across multiple branches, particularly focusing on UI enhancements, indexing logic, and retrieval capabilities.</li> <li>Collaboration is evident through co-authored commits, especially between Tuan Anh Nguyen Dang and Trung Duc Nguyen.</li> <li>The recent focus has been on improving user experience through UI updates, adding new functionalities like conversation management, and enhancing document handling capabilities.</li> </ul> <h3>Patterns and Themes</h3> <ul> <li><strong>Collaboration:</strong> Multiple co-authored commits indicate a collaborative approach to development.</li> <li><strong>Focus on User Experience:</strong> A significant amount of work is dedicated to improving the UI and user interactions within the application.</li> <li><strong>Continuous Improvement:</strong> Regular updates to workflows and documentation reflect an ongoing commitment to enhancing project quality and usability.</li> <li><strong>Feature Expansion:</strong> New features are being added consistently, indicating a proactive approach to feature development in response to user needs or project goals.</li> </ul> <h3>Conclusions</h3> <p>The development team is actively engaged in enhancing the Cinnamon/kotaemon project, with a strong emphasis on collaboration, user experience, and continuous improvement. The variety of recent activities showcases a balanced focus on both feature development and bug fixing, ensuring the tool remains robust and user-friendly.</p> </div> </div> </div> </body> <script src="/static/github-logo-loader.4ce3f35b6f9c.js"></script> <script src="/static/diffs-processing.3d9bd6e637a7.js"></script> <script src="/static/subnav-section-highlight.f3cdbfc10a0c.js"></script> <script src="/static/simple-datatables.c5478338f0b0.js"></script> <script src="/static/subnav-toggle.cb6ff17a23ca.js"></script> <script src="/static/tabs.081ec4777ff9.js"></script> <script src="/static/accordion.9fbab959a9c9.js"></script> <script> document.addEventListener('DOMContentLoaded', () => { // Function to initialize tables function initializeTables(selector, options) { const tables = document.querySelectorAll(selector); tables.forEach(function(table) { new simpleDatatables.DataTable(table, options); }); } // Initialize other interactive tables initializeTables(".table-container table", { searchable: false, fixedHeight: false, perPage: 10, perPageSelect: false, }); // Initialize interactive tables for harvest-forecast tables initializeTables(".harvest-forecast-table table", { searchable: true, sortable: false, fixedHeight: false, perPage: 25, perPageSelect: false, columns: [ { select: 9, sort: "desc" } // selecting the "diff" column ], }); // Initialize interactive tables for dev quant table initializeTables(".dev-quant-table table", { searchable: true, sortable: false, fixedHeight: false, perPage: 10, perPageSelect: false, }); // Replace failing avatars const avatars = document.querySelectorAll('.dev-quant-table table img, .pr-table img'); const fallbackImage = "/static/logos/sans-github.8dcc6b5262f3.svg"; avatars.forEach(avatar => { //console.log(`evaluating ${avatar.src}`); avatar.onerror = function() { //console.log(`Error loading image: ${avatar.src}`); avatar.src = fallbackImage; // Set the fallback image on error //console.log(`replacing src url with ${avatar.src}`); }; // Preload the avatar to check if it loads correctly const img = new Image(); img.src = avatar.src; img.onload = function() { //console.log(`Image loaded successfully: ${avatar.src}`); }; img.onerror = function() { //console.log(`Image failed to load, setting fallback: ${avatar.src}`); avatar.src = fallbackImage; // Set the fallback image if it fails to load }; }); }); const readMoreElements = document.querySelectorAll('.read-more'); readMoreElements.forEach(element => { element.addEventListener('click', function() { const rationale = this.previousElementSibling; if (rationale.classList.contains('expanded')) { rationale.style.maxHeight = rationale.scrollHeight + 'px'; rationale.classList.remove('expanded'); setTimeout(() => { rationale.style.maxHeight = '4rem'; }, 10); this.textContent = '[+] Read More'; } else { rationale.classList.add('expanded'); rationale.style.maxHeight = rationale.scrollHeight + 'px'; this.textContent = '[-] Hide Contents'; } }); }); </script> </html>