{"id":18058219,"url":"https://github.com/binarybardakshat/simplyfi","last_synced_at":"2026-02-14T00:46:18.253Z","repository":{"id":259743828,"uuid":"879329155","full_name":"BinaryBardAkshat/Simplyfi","owner":"BinaryBardAkshat","description":"Welcome to Simplyfi ! This is a Multi-Language Code Visualization Tool designed to help users visualize their code's syntax tree and flowchart. You can also chat with the code to get explanations of its functionality.","archived":false,"fork":false,"pushed_at":"2025-01-04T03:01:40.000Z","size":139,"stargazers_count":4,"open_issues_count":0,"forks_count":1,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-03-25T05:51:13.316Z","etag":null,"topics":["ai","google-generative-ai","hackoctoberfest2024","hacktoberfest","hacktoberfest-accepted","streamlit","web-application"],"latest_commit_sha":null,"homepage":"https://simplyfi.streamlit.app/","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/BinaryBardAkshat.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,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2024-10-27T16:12:41.000Z","updated_at":"2025-02-16T13:25:22.000Z","dependencies_parsed_at":"2024-10-27T19:16:38.740Z","dependency_job_id":"4af23d96-441f-441d-95a0-57ff0d10548b","html_url":"https://github.com/BinaryBardAkshat/Simplyfi","commit_stats":null,"previous_names":["binarybardakshat/simplyfi"],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/BinaryBardAkshat%2FSimplyfi","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/BinaryBardAkshat%2FSimplyfi/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/BinaryBardAkshat%2FSimplyfi/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/BinaryBardAkshat%2FSimplyfi/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/BinaryBardAkshat","download_url":"https://codeload.github.com/BinaryBardAkshat/Simplyfi/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248360812,"owners_count":21090763,"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":["ai","google-generative-ai","hackoctoberfest2024","hacktoberfest","hacktoberfest-accepted","streamlit","web-application"],"created_at":"2024-10-31T03:05:41.209Z","updated_at":"2026-02-14T00:46:18.217Z","avatar_url":"https://github.com/BinaryBardAkshat.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Simplyfi\n\n\u003cdiv align=\"center\"\u003e\n\n![Simplyfi Logo](resources/logo.png)\n\nA Multi-Language Code Analysis and Visualization Platform\n\n[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)\n[![PRs Welcome](https://img.shields.io/badge/PRs-welcome-brightgreen.svg)](CONTRIBUTING.md)\n[![Python Version](https://img.shields.io/badge/python-3.8%2B-blue)](https://www.python.org/downloads/)\n\n\u003c/div\u003e\n\n## Table of Contents\n- [Introduction](#introduction)\n- [System Requirements](#system-requirements)\n- [Technical Architecture](#technical-architecture)\n- [Installation Guide](#installation-guide)\n- [Configuration](#configuration)\n- [Usage](#usage)\n- [Development](#development)\n- [API Reference](#api-reference)\n- [Contributing](#contributing)\n- [Support](#support)\n\n## Introduction\n\n### Overview\nSimplyfi is an advanced code analysis platform that transforms source code into comprehensive visual representations. The platform employs sophisticated parsing algorithms to generate abstract syntax trees (ASTs) and flowcharts, facilitating code understanding and documentation.\n\n### Key Capabilities\n- Source code parsing and analysis across multiple programming languages\n- Abstract Syntax Tree (AST) visualization\n- Automated flowchart generation from code logic\n- Interactive code explanation through natural language processing\n- Customizable visualization parameters\n\n\n### Dependencies\n- Python packages are listed in `requirements.txt`\n- Additional system libraries may be required based on your operating system\n\n## Technical Architecture\n\nSimplyfi implements a modular architecture designed for extensibility and maintainability:\n\n![Architecture Diagram](resources/work.png)\n\n### Core Components\n\n#### 1. Input Processing Module\n- Language detection and classification\n- Syntax validation\n- Code tokenization\n- Query parsing and intent recognition\n\n#### 2. Analysis Engine\n- Abstract Syntax Tree (AST) generation\n- Control flow analysis\n- Data flow tracking\n- Pattern recognition\n\n#### 3. Visualization Pipeline\n- Graph generation algorithms\n- Layout optimization\n- Style management\n- Interactive element handling\n\n#### 4. User Interface Layer\n- Web-based interface\n- Real-time updates\n- User input handling\n- Result presentation\n\n### Data Flow\n1. User input received through interface\n2. Code/query parsed and validated\n3. Analysis performed based on input type\n4. Visual representation generated\n5. Results displayed with interactive elements\n6. User feedback collected and processed\n\n## Installation Guide\n\n### Prerequisites\nEnsure your system meets the minimum requirements and has the following installed:\n- Python 3.8+\n- pip (Python package installer)\n- Git\n- virtualenv (recommended)\n\n### Installation Steps\n\n1. Clone the Repository\n   ```bash\n   git clone https://github.com/binarybardakshat/simplyfi.git\n   cd simplyfi\n   ```\n\n2. Environment Setup\n   ```bash\n   # Create virtual environment\n   python -m venv venv\n\n   # Activate virtual environment\n   # Windows\n   .\\venv\\Scripts\\activate\n   # Unix/macOS\n   source venv/bin/activate\n   ```\n\n3. Install Dependencies\n   ```bash\n   pip install -r requirements.txt\n   ```\n\n4. Configure Environment\n   ```bash\n   # Create configuration directory\n   mkdir -p .streamlit\n   \n   # Create configuration file\n   touch .streamlit/secrets.toml\n   ```\n\n5. Verify Installation\n   ```bash\n   python -m pytest tests/\n   ```\n\n## Configuration\n\n### API Configuration\n1. Obtain API Credentials\n   - Navigate to [Google MakerSuite](https://makersuite.google.com/app/apikey)\n   - Generate new API credentials\n   - Save the API key securely\n\n2. Configure API Access\n   ```toml\n   # .streamlit/secrets.toml\n   [API_KEY]\n   API_KEY = \"your_api_key_here\"\n   ```\n\n### Advanced Configuration\nAdditional configuration options can be set in `config.yaml`:\n```yaml\nvisualization:\n  default_theme: \"light\"\n  export_formats: [\"svg\", \"png\", \"pdf\"]\n  max_node_count: 1000\n\nperformance:\n  cache_size: \"512MB\"\n  worker_threads: 4\n  timeout: 30\n\nlogging:\n  level: \"INFO\"\n  format: \"%(asctime)s - %(name)s - %(levelname)s - %(message)s\"\n```\n\n## Usage\n\n### Basic Usage\n1. Start the Application\n   ```bash\n   streamlit run app.py\n   ```\n\n2. Access the Interface\n   - Open web browser\n   - Navigate to `http://localhost:8501`\n\n## Development\n\n### Development Setup\n1. Install Development Dependencies\n   ```bash\n   pip install -r requirements-dev.txt\n   ```\n\n2. Configure Pre-commit Hooks\n   ```bash\n   pre-commit install\n   ```\n\n### Testing\n```bash\n# Run test suite\npytest\n\n# Run with coverage\npytest --cov=simplyfi tests/\n\n# Generate coverage report\ncoverage html\n```\n\n### Code Style\n- Follow PEP 8 guidelines\n- Use type hints\n- Maintain test coverage above 90%\n- Document all public APIs\n\n## API Reference\n\n### Core Classes\n\n#### CodeAnalyzer\n```python\nclass CodeAnalyzer:\n    \"\"\"\n    Main class for code analysis operations.\n    \"\"\"\n    def analyze(self, source: str) -\u003e Analysis:\n        \"\"\"\n        Analyze source code and return analysis results.\n        \n        Args:\n            source: Source code or file path\n            \n        Returns:\n            Analysis object containing results\n        \"\"\"\n        pass\n```\n\n#### Visualization\n```python\nclass Visualization:\n    \"\"\"\n    Handles visualization generation and export.\n    \"\"\"\n    def generate(self, analysis: Analysis) -\u003e None:\n        \"\"\"\n        Generate visualization from analysis results.\n        \"\"\"\n        pass\n```\n\n## Contributing\n\n### Contribution Process\n1. Fork the repository\n2. Create a feature branch\n3. Implement changes\n4. Add/update tests\n5. Update documentation\n6. Submit pull request\n\n### Code Standards\n- Follow existing code style\n- Include unit tests\n- Update documentation\n- Maintain backward compatibility\n- Add type hints\n\n### Pull Request Guidelines\n1. Use descriptive commit messages\n2. Reference relevant issues\n3. Update CHANGELOG.md\n4. Ensure CI passes\n5. Obtain code review approval\n\n## Support\n\n### Official Channels\n- GitHub Issues: Bug reports and feature requests\n- Email Support: binarybardakshat@gmail.com\n- Documentation: [Project Wiki](https://github.com/binarybardakshat/simplyfi/wiki)\n\n### Common Issues\n- API Authentication\n  - Verify API key format\n  - Check network connectivity\n  - Confirm API service status\n\n- Visualization\n  - Validate input format\n  - Check memory usage\n  - Verify browser compatibility\n  - \n## License\n\nThis project is licensed under the MIT License. See the [LICENSE](LICENSE) file for details.\n\n---\n\n\u003cdiv align=\"center\"\u003e\nCopyright © 2024 Simplyfi Project Contributors. All rights reserved.\n\u003c/div\u003e\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fbinarybardakshat%2Fsimplyfi","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fbinarybardakshat%2Fsimplyfi","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fbinarybardakshat%2Fsimplyfi/lists"}