accessible-django 1.0.0

A Django package for accessibility checks during development.

AccessibleDjango 🌟

Python 3.10+ | License: MIT | Version: 0.0.1

AccessibleDjango is a Django package focused on checking your web applications for accessibility compliance. It ensures your app adheres to accessibility standards, making your web interfaces usable for everyone, including individuals with disabilities. AccessibleDjango currently checks for missing or empty alt attributes in <img> tags, with plans for further accessibility features in future releases.

---

🌟 Features

• Accessibility Checks:
  Automatically evaluates views and templates for common accessibility issues, such as missing or empty alt attributes in <img> tags.

• Detailed Reports:
  Generates comprehensive accessibility reports highlighting issues found in your templates and views.

• Developer-Friendly Tools:
  Easily integrate AccessibleDjango into your project and CI pipelines.

• Customizable Rules:
  Tailor the accessibility checks to suit your application’s needs, including enabling/disabling checks for specific issues.

---

⚠️ Important Notes

AccessibleDjango currently focuses exclusively on checking alt attributes for <img> tags. Future releases may include features such as:

• Prebuilt accessible templates.
• Enhanced form generation tools.
• Real-time accessibility validation in the development environment.

---

🚀 Quick Start

Installation

To install AccessibleDjango, run:

pip install accessible-django  

Basic Usage

Add to Installed Apps

In your settings.py, add 'accessible_django' to the INSTALLED_APPS list:

INSTALLED_APPS = [  
    ...,  
    'accessible_django',  
]  

Run Accessibility Checks

Run the following command to check for accessibility issues in your templates:

python manage.py check_accessibility  

---

📖 Documentation

Running Checks

python manage.py check --deploy

🚧 Limitations

• AccessibleDjango currently focuses only on identifying accessibility issues related to alt attributes in <img> tags.
• It does not yet provide prebuilt accessible templates, form enhancements, or real-time validation in development.
• Manual testing may be required for third-party components.

---

🗺️ Roadmap

We are actively working to expand AccessibleDjango to include additional accessibility features. Future releases may include:

1. Prebuilt Accessible Templates: Ready-to-use templates that adhere to WCAG 2.1 standards.
2. Enhanced Form Generation Tools: Tools for generating accessible forms and validating form input accessibility.
3. Real-Time Accessibility Validation: A live testing mode to validate accessibility as you develop.
4. Comprehensive Accessibility Checks: Full support for various accessibility issues, such as ARIA roles, color contrast, form validation, and more.

For more details, see FUTURE.md.

---

🤝 Contributing

We welcome contributions to AccessibleDjango! Please feel free to submit a Pull Request or open an issue on GitHub.

---

📜 License

This project is licensed under the MIT License. See the LICENSE file for details.

---

🙏 Acknowledgments

Built with ❤️ by the Accessible Django Team. Special thanks to all contributors and the accessibility community for their support.