wagtail-feathers 1.0b1__tar.gz

wagtail_feathers-1.0b1/DEMO_ENHANCEMENT_PLAN.md

@@ -0,0 +1,353 @@
+# Wagtail Feathers Demo Enhancement Plan
+
+## Current Demo Status Analysis (Updated: July 28, 2025)
+
+### ✅ Phase 1 COMPLETED - Content Structure
+- **Enhanced Page Models**: `HomePage`, `ArticlePage`, `ArticleIndexPage`, `AuthorPage`, `FAQPage`, `ContactPage`
+- **Taxonomy System**: 19 categories, 7 classifier groups, 59 classifiers with full hierarchy
+- **Author System**: 4 author types, 4 person groups, 5 people with relationships
+- **Admin Interface**: ArticlePageListingViewSet, proper admin access, sample content
+- **Site Configuration**: Proper HomePage setup, site configuration, superuser (admin/admin123)
+- **Template Fixes**: Removed invalid template tags, fixed theme compatibility
+
+**Demo Coverage: ~30% (up from <5%)**
+
+### 🔄 Remaining Features to Implement
+
+## Core Models & Features Not Demonstrated
+
+### 1. **Taxonomy System** ✅ COMPLETED
+- `Category` - 19 categories in hierarchical tree (Technology, Business, Science, Arts, Education)
+- `Classifier` & `ClassifierGroup` - 7 groups with 59 classifiers 
+- `PageCategory` & `PageClassifier` - Articles properly tagged
+- Admin category management via wagtail-feathers admin
+
+### 2. **Author System** ✅ COMPLETED  
+- `AuthorType` - 4 types: Lead Author, Co-Author, Reviewer, Editor
+- `PageAuthor` - Articles linked to authors with relationships
+- `Person` & `PersonGroup` - 5 people in 4 groups (Technical Writers, Researchers, etc.)
+- Author pages and profiles functional
+
+### 3. **Navigation System** 🧭
+**Missing in Demo:**
+- `Menu`, `MenuItem`, `FlatMenu`, `NestedMenu` - Dynamic navigation
+- `Footer`, `FooterNavigation` - Footer menu management
+
+**Should Demonstrate:**
+- Dynamic main navigation
+- Multi-level dropdown menus  
+- Footer navigation sections
+- Admin menu management interface
+
+### 4. **Social Media Integration** 📱
+**Missing in Demo:**
+- `SocialMediaLink` & `SocialMediaSettings` - Social media management
+- Social sharing functionality
+
+**Should Demonstrate:**
+- Site-wide social media links
+- Social sharing buttons on articles
+- Author social media profiles
+
+### 5. **Geographic Features** 🌍
+**Missing in Demo:**
+- `PageCountry` - Geographic tagging of content
+
+**Should Demonstrate:**
+- Country-specific content filtering
+- Geographic content organization
+
+### 6. **FAQ System** ❓
+**Missing in Demo:**
+- `FAQ` & `FAQCategory` - FAQ management
+- `FAQBasePage` - Specialized FAQ pages
+
+**Should Demonstrate:**
+- FAQ categories and items
+- FAQ page with search/filtering
+- Embedded FAQ sections in other pages
+
+### 7. **Form System** 📝
+**Missing in Demo:**
+- `FormBasePage` - Enhanced form pages with theme support
+
+**Should Demonstrate:**
+- Contact forms
+- Newsletter signup
+- Custom form fields and styling
+
+### 8. **Rich Block System** 🧱
+**Missing in Demo:**
+- Most StreamField blocks from `blocks.py`
+- Theme-aware components
+
+**Should Demonstrate:**
+- Hero sections with call-to-actions
+- Card grids and sections
+- Image galleries and grids
+- Quote blocks with variants
+- Call-to-action sections
+- FAQ embed blocks
+- Nested navigation menus
+
+### 9. **SEO & Metadata** 🔍
+**Missing in Demo:**
+- `SeoMixin` advanced features
+- Structured data implementation
+- Social media meta tags
+
+**Should Demonstrate:**
+- Custom meta descriptions
+- Open Graph tags
+- Twitter Cards
+- Structured data for articles
+
+### 10. **Reading Time & Content Features** ⏱️
+**Missing in Demo:**
+- `ReadingTimeMixin` functionality
+- Content analysis features
+
+**Should Demonstrate:**
+- Article reading time calculation
+- Content statistics display
+
+### 11. **Related Content** 🔗
+**Missing in Demo:**
+- `RelatedPage`, `RelatedDocument`, `RelatedExternalLink`
+- Content relationships
+
+**Should Demonstrate:**
+- Related articles sidebar
+- Document attachments
+- External resource links
+
+### 12. **Error Pages** ⚠️
+**Missing in Demo:**
+- `ErrorPage` model usage
+- Custom error page templates
+
+**Should Demonstrate:**
+- Custom 404, 403, 500 error pages
+- Themed error page variants
+
+### 13. **Management Commands** 🔧
+**Missing in Demo:**
+- Theme management commands
+- Category management commands
+- Sample data creation commands
+
+**Should Demonstrate:**
+- Sample data generation workflow
+- Theme switching via command line
+- Category tree management
+
+### 14. **Admin Viewsets** ⚙️
+**Missing in Demo:**
+- Admin customizations via viewsets
+- Enhanced admin interfaces
+
+**Should Demonstrate:**
+- Category management interface
+- Author management interface
+- Navigation menu builder
+- Social media settings
+
+## Comprehensive Demo Enhancement Plan
+
+### ✅ Phase 1: Content Structure COMPLETED
+1. **Enhanced Page Models** ✅
+   - `HomePage` with proper WebBasePage inheritance and site configuration  
+   - `ArticlePage` with excerpts, featured images, taxonomy/author relationships
+   - `ArticleIndexPage` with optimized queries and pagination
+   - `AuthorPage` with profiles, bio, contact info
+   - `FAQPage` and `ContactPage` with FormBasePage features
+
+2. **Taxonomy Implementation** ✅
+   - 19 categories across 5 main branches (Technology, Business, Science, Arts, Education)
+   - 59 classifiers in 7 groups (Subject/Attribute types)
+   - Articles properly categorized and classified
+   - Management command for creating sample taxonomy data
+
+3. **Author System** ✅
+   - 5 author profiles with bios and group memberships
+   - 4 author types and 4 person groups
+   - Multi-author support via PageAuthor relationships
+   - Author pages and detail views functional
+
+4. **Admin Interface** ✅ 
+   - ArticlePageListingViewSet for admin menu access
+   - All models accessible via enhanced admin
+   - Sample content with realistic data
+   - Superuser account (admin/admin123)
+
+### Phase 2: Navigation & Structure (High Priority)
+1. **Dynamic Navigation**
+   - Implement main navigation menu
+   - Add multi-level dropdown menus
+   - Create footer navigation sections
+   - Add breadcrumb navigation
+
+2. **Content Blocks**
+   - Implement hero sections on homepage
+   - Add card grids for featured content
+   - Create call-to-action sections
+   - Add image galleries and quote blocks
+
+### Phase 3: Advanced Features (Medium Priority)
+1. **Social Integration**
+   - Add social media links to site settings
+   - Implement social sharing on articles
+   - Add author social media profiles
+
+2. **FAQ System**
+   - Create FAQ categories and items
+   - Build comprehensive FAQ page
+   - Add FAQ embed blocks to other pages
+
+3. **Forms & Contact**
+   - Enhanced contact form with validation
+   - Newsletter signup functionality
+   - Form success pages with theme variants
+
+### Phase 4: Content & Polish (Medium Priority)
+1. **SEO Enhancement**
+   - Implement advanced SEO features
+   - Add structured data for articles
+   - Optimize meta tags and social sharing
+
+2. **Content Features**
+   - Add reading time to articles
+   - Implement related content sections
+   - Add document attachments to articles
+
+### Phase 5: Admin & Management (Low Priority)
+1. **Admin Enhancements**
+   - Configure all admin viewsets
+   - Add category management interface
+   - Implement menu builder interface
+
+2. **Sample Data & Commands**
+   - Create comprehensive sample data command
+   - Add data fixtures for realistic content
+   - Document management command usage
+
+## Implementation Strategy
+
+### New Demo Models Needed
+```python
+# demo/showcase/models.py additions
+
+class EnhancedArticlePage(FeatherBasePage):
+    """Comprehensive article demonstrating all features"""
+    # Add all FeatherBasePage features
+    # Include author relationships
+    # Add category/classifier relationships
+    # Implement related content
+    # Add social sharing
+
+class AuthorPage(FeatherBasePage):
+    """Author profile pages"""
+    # Author bio, image, social links
+    # List of author's articles
+    # Contact information
+
+class FAQPage(FAQBasePage):
+    """FAQ page with categories and search"""
+    # Implement FAQ categories
+    # Add search functionality
+    # Include theme variants
+
+class ContactPage(FormBasePage):
+    """Contact form with enhanced features"""
+    # Multiple form types
+    # Success page variants
+    # Email notifications
+
+class CategoryIndexPage(FeatherBasePage):
+    """Category-based content listing"""
+    # Filter by categories
+    # Show category hierarchy
+    # Pagination and sorting
+```
+
+### StreamField Enhancements
+- Add comprehensive StreamField blocks to all pages
+- Implement theme-aware block variants
+- Create reusable content sections
+- Add interactive elements
+
+### Admin Configuration
+- Configure all viewsets for enhanced admin
+- Add custom admin panels
+- Implement bulk operations
+- Add admin documentation
+
+### Theme Enhancements
+- Extend quantum theme with all block templates
+- Add theme variants for all components
+- Implement responsive design patterns
+- Add accessibility features
+
+### Sample Data Creation
+- Create realistic content for all models
+- Add sample images and media
+- Generate category hierarchies
+- Create author profiles with content
+
+## Expected Outcomes
+
+After implementation, the demo will showcase:
+- ✅ **Complete Feature Coverage**: Every wagtail-feathers feature demonstrated
+- ✅ **Real-world Usage**: Practical implementation examples
+- ✅ **Admin Interface**: Full admin functionality displayed
+- ✅ **Theme System**: Complete theme variant usage
+- ✅ **Content Relationships**: All model relationships working
+- ✅ **SEO & Performance**: Optimized content structure
+- ✅ **User Experience**: Intuitive navigation and content discovery
+- ✅ **Developer Reference**: Clear implementation patterns
+
+## Session Restart Information
+
+### Key Files to Review
+- `src/wagtail_feathers/models/__init__.py` - All available models
+- `src/wagtail_feathers/blocks.py` - StreamField blocks (1200+ lines)
+- `src/wagtail_feathers/viewsets/__init__.py` - Admin viewsets
+- `demo/showcase/models.py` - Current demo models (minimal)
+
+### Implementation Priority
+1. **High**: Models, blocks, navigation, taxonomy
+2. **Medium**: Social, FAQ, SEO, forms
+3. **Low**: Admin polish, management commands
+
+### Testing Strategy
+- Create sample data via management commands
+- Test all admin interfaces
+- Verify theme variants work correctly
+- Check responsive design and accessibility
+
+---
+
+## Implementation Status Update (July 28, 2025)
+
+### ✅ **Completed Work**
+- **Phase 1**: Content Structure - 100% Complete
+- **Demo Coverage**: Improved from <5% to ~30% of wagtail-feathers features
+- **Site Status**: Fully functional at http://localhost:8000/ 
+- **Admin Access**: Working admin interface with ArticlePageListingViewSet
+- **Sample Content**: 3 articles, complete taxonomy, 5 authors with relationships
+- **Template Issues**: Fixed invalid template tags, removed colead_tags references
+
+### 🔄 **Next Priorities**
+1. **Phase 2**: Navigation & Structure (Dynamic menus, content blocks)
+2. **Phase 3**: Advanced Features (Social integration, enhanced FAQ)  
+3. **Phase 4**: Content & Polish (SEO, reading time, related content)
+4. **Phase 5**: Admin & Management (Enhanced viewsets, bulk operations)
+
+### 🎯 **Remaining Work**
+- **70% of planned features** still to be implemented
+- **StreamField Blocks**: Hero sections, cards, galleries, quotes, CTAs
+- **Navigation System**: Dynamic menus, footer navigation, breadcrumbs
+- **Social Integration**: Social media links, sharing buttons
+- **Advanced Features**: FAQ embed blocks, enhanced forms, SEO optimization
+
+*Updated plan roadmap for continuing comprehensive wagtail-feathers demo development.*

wagtail_feathers-1.0b1/DEVELOPMENT.md

@@ -0,0 +1,222 @@
+# Development Guide for Wagtail Feathers
+
+## Setup Development Environment
+
+### 1. Clone and Install
+```bash
+git clone https://github.com/softquantum/wagtail-feathers.git
+cd wagtail-feathers
+
+# Install in development mode with all dev dependencies
+pip install -e ".[dev]"
+```
+
+### 2. Run Tests
+```bash
+# Run all tests
+pytest
+
+# Run with coverage
+pytest --cov=wagtail_feathers --cov-report=html
+
+# Run specific test files
+pytest src/wagtail_feathers/tests/test_themes.py
+```
+
+### 3. Use Tox for Multi-Environment Testing
+```bash
+# Run tests across all supported Python/Django/Wagtail combinations
+tox
+
+# Run only linting
+tox -e lint
+
+# Run only formatting
+tox -e format
+
+# Run coverage
+tox -e coverage
+```
+
+## Package Management with Flit
+
+### Building the Package
+```bash
+# Install flit if not already installed
+pip install flit
+
+# Build the package
+flit build
+
+# Check what files will be included
+flit build --check
+```
+
+### Publishing to PyPI
+```bash
+# Publish to Test PyPI first
+flit publish --repository testpypi
+
+# Publish to PyPI
+flit publish
+```
+
+### Installing from Local Build
+```bash
+# Install in development mode
+flit install --symlink
+
+# Install normally
+flit install
+```
+
+## Code Quality
+
+### Linting and Formatting
+```bash
+# Check code style
+ruff check src/
+
+# Fix auto-fixable issues
+ruff check --fix src/
+
+# Format code
+ruff format src/
+
+# Check formatting without applying
+ruff format --check src/
+```
+
+### Pre-commit Hooks (Optional)
+```bash
+# Install pre-commit
+pip install pre-commit
+
+# Create .pre-commit-config.yaml
+cat > .pre-commit-config.yaml << EOF
+repos:
+  - repo: https://github.com/astral-sh/ruff-pre-commit
+    rev: v0.1.0
+    hooks:
+      - id: ruff
+        args: [--fix, --exit-non-zero-on-fix]
+      - id: ruff-format
+EOF
+
+# Install hooks
+pre-commit install
+```
+
+## Testing Strategy
+
+### Test Structure
+- `src/wagtail_feathers/tests/` contains all tests
+- Tests are organized by functionality (themes, models, etc.)
+- Uses pytest with Django integration
+- Includes factories for test data generation
+
+### Writing Tests
+```python
+import pytest
+from wagtail_feathers.models import FeatherBasePage
+
+@pytest.mark.django_db
+def test_feather_base_page_creation():
+    page = FeatherBasePage(title="Test Page")
+    assert page.title == "Test Page"
+```
+
+### Test Settings
+The package includes a dedicated test settings file at:
+`src/wagtail_feathers/tests/settings.py`
+
+This provides a minimal Django/Wagtail setup for testing.
+
+## Version Management
+
+Version is managed in `src/wagtail_feathers/__init__.py`:
+
+```python
+__version__ = "0.1.0"
+```
+
+Flit automatically reads this for package metadata.
+
+## Documentation
+
+### Updating README
+The main README.md should be kept up-to-date with:
+- Feature descriptions
+- Installation instructions  
+- Usage examples
+- API documentation
+
+### Docstrings
+Follow Google-style docstrings:
+
+```python
+def my_function(param1: str, param2: int) -> bool:
+    """Short description of the function.
+
+    Longer description if needed.
+
+    Args:
+        param1: Description of parameter 1.
+        param2: Description of parameter 2.
+
+    Returns:
+        Description of return value.
+
+    Raises:
+        ValueError: When parameter is invalid.
+    """
+    pass
+```
+
+## Release Process
+
+1. **Update Version**: Increment version in `__init__.py`
+2. **Update Changelog**: Document changes in README or CHANGELOG
+3. **Run Tests**: Ensure all tests pass across environments
+4. **Build Package**: `flit build`
+5. **Test Install**: Install and test in clean environment
+6. **Publish**: `flit publish` (to testpypi first, then pypi)
+7. **Tag Release**: Create git tag for the version
+8. **Update Documentation**: Ensure docs reflect new version
+
+## Contributing
+
+When contributing:
+
+1. Fork the repository
+2. Create a feature branch
+3. Write tests for new functionality
+4. Ensure all tests pass
+5. Follow code style guidelines
+6. Update documentation as needed
+7. Submit a pull request
+
+## Local Development Tips
+
+### Working with the Parent Project
+When developing wagtail_feathers within the project:
+
+```bash
+# Link local development version
+pip uninstall wagtail-feathers
+pip install -e /path/to/wagtail_feathers
+
+# Or use pip's editable install
+pip install -e ../wagtail_feathers
+```
+
+### Database Migrations
+For testing database changes:
+
+```bash
+# Create test migrations
+python -m pytest src/wagtail_feathers/tests/ --create-db
+
+# Or run with Django management command
+DJANGO_SETTINGS_MODULE=wagtail_feathers.tests.settings python -m django makemigrations wagtail_feathers
+```

wagtail_feathers-1.0b1/LICENSE

@@ -0,0 +1,29 @@
+BSD 3-Clause License
+
+Copyright (c) 2025, Maxime Decooman
+All rights reserved.
+
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions are met:
+
+1. Redistributions of source code must retain the above copyright notice, this
+   list of conditions and the following disclaimer.
+
+2. Redistributions in binary form must reproduce the above copyright notice,
+   this list of conditions and the following disclaimer in the documentation
+   and/or other materials provided with the distribution.
+
+3. Neither the name of the copyright holder nor the names of its
+   contributors may be used to endorse or promote products derived from
+   this software without specific prior written permission.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
+FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
+SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
+CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
+OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

wagtail_feathers-1.0b1/MANIFEST.in

@@ -0,0 +1,28 @@
+# Include important package files
+include README.md
+include LICENSE
+include pyproject.toml
+include tox.ini
+
+# Include source code
+recursive-include src/wagtail_feathers *.py
+recursive-include src/wagtail_feathers *.html
+recursive-include src/wagtail_feathers *.json
+recursive-include src/wagtail_feathers *.txt
+
+# Include templates and static files if any
+recursive-include src/wagtail_feathers/templates *
+recursive-include src/wagtail_feathers/static *
+
+# Exclude unnecessary files
+global-exclude *.pyc
+global-exclude *.pyo
+global-exclude *.pyd
+global-exclude __pycache__
+global-exclude .DS_Store
+global-exclude *.so
+global-exclude *.log
+
+# Exclude test logs and cache
+recursive-exclude src/wagtail_feathers/tests/logs *
+prune src/wagtail_feathers/tests/logs