shoppyshops shoppyshops.shop .cursorrules file for Python

# ShoppyShops.shop Cursor Rules

# Project Structure
structure:
  apps:
    - shoppyshop
    - shopify
    - ebay
    - meta
  test_location: tests/
  static_location: static/
  template_location: templates/

# Code Style & Standards
style:
  indent: 4
  quotes: single
  max_line_length: 88
  async_first: true
  docstring: google
  django_style:
    views: async_preferred
    templates: htmx_enhanced

# Testing Framework
tests:
  framework: pytest
  patterns:
    - test_*.py
  fixtures_location: tests/conftest.py
  mocking:
    external_apis: true
    shopify: true
    ebay: true
    meta: true
  categories:
    - unit
    - integration
    - async
    - htmx
    - real
    - mock

# Documentation Requirements
docs:
  required_sections:
    - Purpose
    - Parameters
    - Returns
    - Raises
    - Example
  update_specs: true
  living_docs:
    - SPECIFICATIONS.md
    - METHODOLOGY.md
    - README.md

# Technology Preferences
tech:
  frontend:
    primary: htmx
    javascript: minimal
    templates: django
  backend:
    framework: django
    version: "5.0+"
    async: true
    streaming: sse
  external:
    - httpx
    - shopify
    - ebay
    - meta
    - pytest-watch

# Development Workflow
workflow:
  branch_prefix: feature/
  commit_format: "[WIP] component: description"
  verification:
    - tests_pass
    - docs_updated
    - specs_updated
    - env_configured

# Security Rules
security:
  required_checks:
    - input_sanitization
    - api_key_protection
    - csrf_enabled
    - rate_limiting
  env_vars:
    # Shopify
    - SHOPIFY_SHOP_NAME
    - SHOPIFY_DOMAIN
    - SHOPIFY_SUBDOMAIN
    - SHOPIFY_API_VERSION
    - SHOPIFY_URL
    - SHOPIFY_API_KEY
    - SHOPIFY_API_SECRET
    - SHOPIFY_API_ACCESS_TOKEN
    # eBay
    - EBAY_ENV
    - EBAY_DEV_ID
    - EBAY_USER_TOKEN
    - EBAY_PROD_APP_ID
    - EBAY_PROD_CERT_ID
    - EBAY_SANDBOX_APP_ID
    - EBAY_SANDBOX_CERT_ID
    # Meta
    - META_ENV
    - META_PROD_APP_ID
    - META_PROD_APP_SECRET
    - META_PROD_ACCESS_TOKEN
    - META_SANDBOX_APP_ID
    - META_SANDBOX_APP_SECRET
    - META_SANDBOX_ACCESS_TOKEN

# Exclude Patterns
exclude:
  - venv/
  - __pycache__/
  - *.pyc
  - .env
  - node_modules/
  - .pytest_cache/
  - htmlcov/

# AI Assistance Focus
ai_assistance:
  prioritize:
    - async_patterns
    - streaming_responses
    - htmx_integration
    - test_coverage
    - service_integration
  avoid:
    - complex_javascript
    - sync_views
    - raw_sql
django
golang
html
java
javascript
python

First Time Repository

Python

Languages:

HTML: 9.0KB
Python: 70.7KB
Created: 12/7/2024
Updated: 12/7/2024

All Repositories (1)