AI-powered marketing analysis framework
Project description
🍰 Tiramisu Framework
AI-powered marketing consultancy framework using RAG (Retrieval-Augmented Generation) technology with strategic marketing knowledge.
📦 Installation
pip install tiramisu-framework
🚀 Quick Start
from tiramisu_framework.engine.analyzer import TiramisuAnalyzer
from tiramisu_framework.models.schemas import AnalysisType
# Initialize analyzer
analyzer = TiramisuAnalyzer()
# Analyze content
result = analyzer.analyze(
content="Your marketing content here",
analysis_type=AnalysisType.SOCIAL_MEDIA_POST,
context="Additional context"
)
print(result.summary)
⚠️ Important: Data Setup
This framework requires marketing knowledge data to function.
Setup Your Knowledge Base
- Add your marketing PDFs/documents to
data/folder - Run the indexing script to create FAISS vectors
- The system will use your custom knowledge base
Note: This framework is designed to work with any marketing literature. Users must provide their own knowledge sources in compliance with copyright laws.
🏗️ Architecture
- FastAPI backend with RESTful API
- RAG System with FAISS vector store
- GPT Integration for intelligent analysis
- SQLite for conversation management
- Pydantic for data validation
📚 Features
- 8 types of marketing analysis
- Conversation context management
- Three Trees analysis framework (Roots, Trunk, Branches)
- Multi-perspective expert insights (Strategic, Execution, Technology)
- Structured JSON responses
🛠️ Development
# Clone repository
git clone https://github.com/tiramisu-framework/tiramisu-framework.git
cd tiramisu-framework
# Install dependencies
pip install -r requirements.txt
# Run API
python -m uvicorn api.main:app --reload
⚖️ Legal Disclaimer
This framework is a technical tool for marketing analysis. Users are responsible for:
- Providing their own knowledge sources
- Ensuring compliance with copyright laws
- Obtaining necessary permissions for any copyrighted materials used
📄 License
MIT License - See LICENSE file for details
👨💻 Author
Developed by Jony Wolff with Claude AI assistance
🤝 Contributing
Contributions welcome! Please open an issue or submit a PR.
📚 Setting Up Your Knowledge Base
Important: This framework does not include pre-loaded content. You must provide your own marketing knowledge sources.
Steps:
- Add Your Documents:
mkdir -p data/sources
# Add your PDF/TXT files to data/sources/
- Index Your Content:
python -m tiramisu_framework.scripts.index_documents
- Configure API Key:
export OPENAI_API_KEY="your-key-here"
Recommended Sources:
- Marketing strategy books and articles
- Digital marketing guides
- Industry reports and case studies
- Your own proprietary content
Note: Ensure you have rights to use any content you add to the framework.
Project details
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
File details
Details for the file tiramisu_framework-0.1.3.tar.gz.
File metadata
- Download URL: tiramisu_framework-0.1.3.tar.gz
- Upload date:
- Size: 25.3 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/6.2.0 CPython/3.13.5
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
04f0a263cadff68257485dc8671381750ad7b408562517ff668eb408588ecc81
|
|
| MD5 |
780f342cb5fc23c15c49fc65193b7ec4
|
|
| BLAKE2b-256 |
c81219070d1367bcb5dc71ed0df3b75b66f50bd2f2508218f2281468da640d46
|