Transform your messy Python projects into well-structured, maintainable codebases with the power of AI.
Record a GIF showing the extension in action - from opening the command palette to seeing the refactored project structure
- 🤖 AI-powered project restructuring based on user persona and requirements
- 📝 Automated generation of
README.mdand project workflow documents - 🔧 Intelligent refactoring of Python imports to prevent code breakage
- ⚙️ Automated creation of
.gitignore,requirements.txt, and other boilerplate files - 🎯 Persona-driven approach - customized for Developers, Data Scientists, Researchers, and Students
- 📊 Real-time progress tracking with detailed output logs
- 🚀 One-click solution for project organization and structure improvement
- VS Code version 1.85 or newer
- Python 3.8 or newer installed on your system
- Google Generative AI API Key (free from Google AI Studio)
- Open VS Code
- Go to Extensions (
Ctrl+Shift+X) - Search for "AI Project Refactorer"
- Click Install
- Visit Google AI Studio
- Sign in with your Google account
- Click "Create API Key"
- Copy the generated API key
- In VS Code, open Settings (
Ctrl+,) - Search for "AI Project Refactorer"
- Paste your API key into the
Google Api Keyfield - (Optional) If your Python command is not
python, update thePython Pathsetting with the correct path to your executable
-
Open your project - Open the unstructured Python project folder you want to refactor in VS Code
-
Launch the agent - Open the Command Palette (
Ctrl+Shift+P) and run:AI Agent: Start New Project Refactoring -
Fill out the form - A beautiful interface will open where you can:
- Select your persona (Developer, Data Scientist, Researcher, Student)
- Describe your pain points (default: "Messy code structure, no clear organization, missing documentation")
- Define your goals (default: "Create src folder, add README, organize tests, improve code structure")
- Set success metrics (default: "Better code maintainability, improved test coverage, clear project structure")
-
Start the magic - Click "✨ Start AI Agent" and watch the transformation begin
-
Monitor progress - Check the "AI Agent" Output Channel to see detailed logs of what's happening
- 🔍 Analyzes your current project structure
- 📁 Creates proper folder organization (
src/,tests/,docs/) - 📄 Generates comprehensive documentation
- 🔧 Refactors code imports and dependencies
- 🧹 Cleans up redundant files and code
- ✅ Validates the new structure works correctly
The extension features a sleek, modern interface that adapts to your VS Code theme:
Watch your project transform with live updates:
- Legacy code modernization - Transform old Python scripts into modern, maintainable applications
- Project standardization - Apply consistent structure across team projects
- Documentation generation - Automatically create comprehensive README files and code documentation
- Notebook organization - Convert Jupyter notebooks into structured Python packages
- Experiment tracking - Create proper folder structures for data, models, and results
- Reproducibility - Generate requirements files and environment setup scripts
- Academic project structure - Organize research code following best practices
- Collaboration ready - Make projects easy for others to understand and contribute to
- Publication preparation - Structure code for sharing with papers and repositories
- Assignment organization - Transform homework scripts into professional-looking projects
- Portfolio building - Create impressive GitHub repositories from coursework
- Learning best practices - Understand proper Python project structure through AI guidance
❌ "Failed to set up Python environment"
- Ensure Python 3.8+ is installed and accessible via command line
- Check that
pythoncommand works in your terminal - Update the Python Path setting if using a custom Python installation
❌ "Google API Key not configured"
- Verify your API key is correctly pasted in VS Code settings
- Ensure the API key is active in Google AI Studio
- Check for any extra spaces in the key
❌ "Agent process exited with error"
- Check the "AI Agent" Output Channel for detailed error messages
- Ensure you have write permissions in the project folder
- Verify all required Python packages are installed
- 📖 Check the Documentation
- 🐛 Report issues on GitHub Issues
- 💬 Ask questions in Discussions
The AI agent adapts its approach based on your selected persona:
| Persona | Focus Areas | Output Style |
|---|---|---|
| 👨💻 Developer | Clean architecture, maintainable code, testing | Professional development standards |
| 📊 Data Scientist | Data pipelines, experiment tracking, reproducibility | Research-oriented structure |
| 🔬 Researcher | Documentation, collaboration, academic standards | Publication-ready organization |
| 🎓 Student | Learning-focused, best practices, portfolio building | Educational and clear structure |
- 🌐 Multi-language support (JavaScript, TypeScript, Java)
- 🔄 Incremental updates - Update existing structured projects
- 📋 Custom templates - Save and reuse your preferred project structures
- 🤝 Team collaboration - Share refactoring configurations across teams
- v1.1.0 - JavaScript/TypeScript support
- v1.2.0 - Custom template system
- v1.3.0 - Team configuration sharing
MIT License - feel free to use this extension in your projects!
We love contributions! Whether it's:
- 🐛 Bug reports
- 💡 Feature requests
- 📝 Documentation improvements
- 🔧 Code contributions
Check out our Contributing Guidelines to get started.
If this extension helped you organize your projects, please:
- ⭐ Star the repository
- 📝 Leave a review in the VS Code Marketplace
- 🗣️ Share it with your fellow developers
**Made with ❤️ by Cryptarchs
Transform your chaotic code into beautiful, maintainable projects with just a few clicks!