Djangoly: Write Cleaner, Faster, Scalable Django Code

Djangoly is a VS Code extension built for Django developers (surprise, surprise). It uses static analysis to ensure your project aligns with Django best practices and conventions. You can install the extension via the VS Code Marketplace or by searching for djangoly in VS code's extension tab.

Note: Djangoly requires Python 3.9 or higher to function properly. Please ensure your environment meets this requirement before using the extension.

Get started for free

Djangoly is open source, and you are free to fork and host your own version of the extension. We encourage contributions and feedback from the community.

However, for the best experience and to access support, we recommend using the official VS Code extension. You can sign up for free by requesting an API key. In the future, we plan to introduce paid features to support the ongoing development and maintenance of the extension.

Docs

Djangoly implements a comprehensive set of rules to help you write cleaner, safer, and more efficient Django code. Each rule is designed to catch common pitfalls, enforce best practices, and improve the overall quality and security of your Django projects.

For a complete list of all rules, including detailed descriptions and examples, please refer to our Convention Rules Documentation.

Djangoly highlights

1. Flag annoyances such as CharField(null=True) omitting related_name for foreign keys etc.

2. Catch style style violations like poor names and redundant queryset methods

3. Reminds you to create/update test files when you modify your Django views or models.

4. Flag test names that don't match your team's preferences

5. Identifies potential security risks in your settings and suggests safer alternatives.

6. Ensures that your Django views and methods have proper error handling.

Quick Start 🏃‍♂️💨

1. Get an API Key: If you don't already have an API key, you can signup for one via this form.
2. Install the Extension: VS Code Marketplace
3. Set Up Your Django Project: If you haven't already, set up a Django project in your workspace.
4. Configure Django Settings: Open the extension settings in VS Code and configure your Django-specific settings.
5. Start Coding: Begin developing your Django project. The extension will automatically start analyzing your code.
6. Review Suggestions: Check the Problems panel in VS Code for Django best practice suggestions and quick fixes.

Note: To modify the extension rules, access these settings by going to Preferences → Settings → Extensions → Djangoly.

Contributing

• Open a PR (see local development)
• Spotted a bug or have a feature request? Please create an issue.

Known Issues & Limitations 🐞

• False Positives: As an MVP undergoing rapid development, Djangoly may generate inaccurate diagnostics and recommendations. If you encounter any issues, please report them to support@djangoly.com.

License

This project is available under the MIT License except for the premium directory which is covered by a separate license.