Metadata-Version: 2.3
Name: django-w-docs
Version: 0.1.0
Summary: A reusable documentation app powered by Python, Django, DRF and Wagtail CMS.
License: MIT
Author: Yousef Abu Shanab
Author-email: josephyousef249@gmail.com
Requires-Python: >=3.10
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.13
Requires-Dist: django (>=5.2.1)
Requires-Dist: django-cors-headers (>=4.7.0)
Requires-Dist: django-debug-toolbar (>=6.0.0)
Requires-Dist: django-filter (>=25.1)
Requires-Dist: djangorestframework (>=3.16.0)
Requires-Dist: drf-restwind (>=0.2.0)
Requires-Dist: wagtail (>=7.0)
Requires-Dist: wagtail-ai (>=2.1.2)
Requires-Dist: wagtail-localize (>=1.12.1)
Project-URL: Documentation, https://github.com/youzarsiph/django-w-docs
Project-URL: Homepage, https://github.com/youzarsiph/django-w-docs
Project-URL: Repository, https://github.com/youzarsiph/django-w-docs
Description-Content-Type: text/markdown

# django-w-docs

[![CI](https://github.com/youzarsiph/django-w-docs/actions/workflows/ci.yml/badge.svg)](https://github.com/youzarsiph/django-w-docs/actions/workflows/ci.yml)
[![CD](https://github.com/youzarsiph/django-w-docs/actions/workflows/cd.yml/badge.svg)](https://github.com/youzarsiph/django-w-docs/actions/workflows/cd.yml)
[![Code Style: Black](https://github.com/youzarsiph/django-w-docs/actions/workflows/black.yml/badge.svg)](https://github.com/youzarsiph/django-w-docs/actions/workflows/black.yml)
[![Code Linting: Ruff](https://github.com/youzarsiph/django-w-docs/actions/workflows/ruff.yml/badge.svg)](https://github.com/youzarsiph/django-w-docs/actions/workflows/ruff.yml)
[![Docker Image](https://github.com/youzarsiph/django-w-docs/actions/workflows/docker-image.yml/badge.svg)](https://github.com/youzarsiph/django-w-docs/actions/workflows/docker-image.yml)
[![Docker Publish](https://github.com/youzarsiph/django-w-docs/actions/workflows/docker-publish.yml/badge.svg)](https://github.com/youzarsiph/django-w-docs/actions/workflows/docker-publish.yml)

## Overview

A reusable documentation app powered by Python, Django, DRF and Wagtail CMS.

## Key Features

- **CI/CD Pipelines**: Automated using GitHub Actions to ensure consistent and reliable deployment processes.
- **Dependency Management**: Powered by Poetry, a sophisticated tool for managing project dependencies with precision and reliability.
- **Code Formatting**: Automatically formatted with Black to maintain a consistent and readable codebase.
- **Code Linting**: Utilizes Ruff to identify and address potential issues early, enhancing code quality and maintainability.
- **Code Testing**: Utilizes Django to run tests.
- **Configuration Files**: Includes `.gitignore`, `pyproject.toml`, and other essential configuration files to streamline setup.

## Contributing

We warmly welcome contributions from the community. Please refer to our [CONTRIBUTING](CONTRIBUTING.md) guide for detailed instructions on how to contribute effectively. Your feedback and participation are essential for the continued improvement of this template.

## Support

For inquiries or support, please open an issue or join the discussion in the [GitHub Discussions](https://github.com/youzarsiph/django-w-docs/discussions) section to engage with the community.

## Licensing

This project is licensed under the MIT License. A detailed copy of the terms can be found in the [LICENSE](LICENSE) file.

