Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat: Added RepoAnalyzer to empower auto-summary of a workspace #264

Merged
merged 29 commits into from
Sep 14, 2024

Conversation

xisen-w
Copy link
Collaborator

@xisen-w xisen-w commented Sep 14, 2024

This commit introduces a new RepoAnalyser class in the repo_utils module,
designed to provide comprehensive analysis of Python repositories.

Key features:

  • Generate a tree-like structure of the repository
  • Summarize repository contents, including files, classes, and functions
  • Analyze function signatures and docstrings without executing code
  • Adjust verbosity levels for summaries
  • Extract content from specific files

The RepoAnalyzer offers:

  • Safe analysis of potentially unknown or untrusted code
  • Flexible output detail levels to suit different use cases
  • Efficient traversal and summarization of repository structure

This feature enhances our ability to quickly understand and document
Python codebases, improving code review processes and documentation efforts.

Tested:

  • Manually tested with various Python repositories
  • Verified correct handling of different file structures and function types
  • Confirmed safe operation when analyzing files with complex or undefined references

📚 Documentation preview 📚: https://RDAgent--264.org.readthedocs.build/en/264/

@xisen-w xisen-w merged commit 0bd349a into main Sep 14, 2024
7 checks passed
@xisen-w xisen-w deleted the feature-selection branch September 14, 2024 12:58
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants