cite-agent 1.0.5__py3-none-any.whl → 1.2.4__py3-none-any.whl

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Potentially problematic release.


This version of cite-agent might be problematic. Click here for more details.

@@ -1,235 +0,0 @@
1
- Metadata-Version: 2.4
2
- Name: cite-agent
3
- Version: 1.0.5
4
- Summary: Terminal AI assistant for academic research with citation verification
5
- Home-page: https://github.com/Spectating101/cite-agent
6
- Author: Cite-Agent Team
7
- Author-email: contact@citeagent.dev
8
- Classifier: Development Status :: 4 - Beta
9
- Classifier: Intended Audience :: Science/Research
10
- Classifier: License :: OSI Approved :: MIT License
11
- Classifier: Programming Language :: Python :: 3.9
12
- Classifier: Programming Language :: Python :: 3.10
13
- Classifier: Programming Language :: Python :: 3.11
14
- Classifier: Programming Language :: Python :: 3.12
15
- Requires-Python: >=3.9
16
- Description-Content-Type: text/markdown
17
- License-File: LICENSE
18
- Requires-Dist: aiohttp>=3.9.0
19
- Requires-Dist: groq>=0.4.0
20
- Requires-Dist: requests>=2.31.0
21
- Requires-Dist: python-dotenv>=1.0.0
22
- Requires-Dist: pydantic>=2.5.0
23
- Requires-Dist: rich>=13.7.0
24
- Requires-Dist: keyring>=24.3.0
25
- Dynamic: author
26
- Dynamic: author-email
27
- Dynamic: classifier
28
- Dynamic: description
29
- Dynamic: description-content-type
30
- Dynamic: home-page
31
- Dynamic: license-file
32
- Dynamic: requires-dist
33
- Dynamic: requires-python
34
- Dynamic: summary
35
-
36
- # Cite-Agent
37
-
38
- > A fast, affordable AI research assistant with built-in citation capabilities
39
-
40
- **Cite-Agent** is a terminal-based AI assistant designed for research and finance, offering 70B model access at half the cost of comparable services.
41
-
42
- ---
43
-
44
- ## 🎯 What is Cite-Agent?
45
-
46
- Cite-Agent is an AI-powered research tool that:
47
- - Answers complex questions using state-of-the-art 70B language models
48
- - Provides accurate, source-grounded responses (hence "cite")
49
- - Executes code (Python, R, SQL) for data analysis
50
- - Operates through a beautiful terminal interface
51
- - Costs $10/month (vs $20+ for Claude/ChatGPT)
52
-
53
- ---
54
-
55
- ## ✨ Key Features
56
-
57
- ### 🧠 **Powerful AI**
58
- - Access to Llama 3.3 70B via Cerebras & Groq
59
- - Multi-provider fallback for 99.9% uptime
60
- - 50 queries/day (50,000 tokens)
61
- - 2-5 second response times
62
-
63
- ### 🎓 **Truth-Seeking**
64
- - Explicitly designed to correct user errors
65
- - Admits uncertainty instead of guessing
66
- - Cites sources and reasoning
67
- - Anti-appeasement prompts
68
-
69
- ### 💻 **Code Execution**
70
- - Python, R, and SQL support
71
- - Data analysis and visualization
72
- - Financial calculations
73
- - Research automation
74
-
75
- ### 🔒 **Secure & Private**
76
- - API keys never leave the backend
77
- - JWT-based authentication
78
- - Rate limiting per user
79
- - HTTPS-only communication
80
-
81
- ### 📊 **Analytics**
82
- - Track your usage
83
- - Monitor token consumption
84
- - View query history
85
- - Download statistics
86
-
87
- ---
88
-
89
- ## 💰 Pricing
90
-
91
- | Plan | Price | Queries/Day | Features |
92
- |------|-------|-------------|----------|
93
- | **Student** | $10/month (300 NTD) | 50 | Full access |
94
- | **Public** | $10/month (400 NTD) | 50 | Full access |
95
-
96
- **Beta**: First 50 users get 3 months free
97
-
98
- ---
99
-
100
- ## 🚀 Quick Start
101
-
102
- ### For Users
103
-
104
- 1. **Download** for your OS:
105
- - [Windows](https://cite-agent-api.herokuapp.com/api/downloads/windows)
106
- - [macOS](https://cite-agent-api.herokuapp.com/api/downloads/macos)
107
- - [Linux](https://cite-agent-api.herokuapp.com/api/downloads/linux)
108
-
109
- 2. **Install** the downloaded package
110
-
111
- 3. **Run** `cite-agent` in your terminal
112
-
113
- 4. **Register** with email + password
114
-
115
- 5. **Start asking questions!**
116
-
117
- ### For Developers
118
-
119
- See [DEVELOPMENT.md](./docs/DEVELOPMENT.md) for setup instructions.
120
-
121
- ---
122
-
123
- ## 🏗️ Architecture
124
-
125
- ```
126
- User's Machine Backend (Heroku) AI Providers
127
- ┌─────────────┐ ┌──────────────┐ ┌──────────┐
128
- │ │ │ │ │ │
129
- │ Terminal │─────────────▶│ FastAPI │─────────────▶│ Cerebras │
130
- │ UI │ │ API │ │ (70B) │
131
- │ │◀─────────────│ │◀─────────────│ │
132
- │ (cite_ │ │ - Auth │ └──────────┘
133
- │ agent/) │ │ - Rate │
134
- │ │ │ Limiting │ ┌──────────┐
135
- └─────────────┘ │ - Analytics │ │ │
136
- │ - Proxy │─────────────▶│ Groq │
137
- │ │ │ (70B) │
138
- └──────────────┘ │ │
139
- │ └──────────┘
140
- ┌──────────────┐
141
- │ PostgreSQL │
142
- │ Database │
143
- └──────────────┘
144
- ```
145
-
146
- ### Components
147
-
148
- **Frontend (cite_agent/)**
149
- - Terminal UI using `rich` library
150
- - JWT authentication
151
- - Query management
152
- - Local session storage
153
-
154
- **Backend (cite-agent-api/)**
155
- - FastAPI REST API
156
- - User authentication & rate limiting
157
- - Multi-provider LLM routing
158
- - Analytics & tracking
159
- - PostgreSQL database
160
-
161
- **AI Providers**
162
- - **Primary**: Cerebras (14,400 RPD × 3 keys = 43,200/day)
163
- - **Backup**: Groq (1,000 RPD × 3 keys = 3,000/day)
164
- - **Total capacity**: ~46,000 queries/day
165
-
166
- ---
167
-
168
- ## 📖 Documentation
169
-
170
- - **[DEVELOPMENT.md](./docs/DEVELOPMENT.md)** - Developer setup guide
171
- - **[DEPLOYMENT.md](./DEPLOYMENT.md)** - How to deploy (Heroku)
172
- - **[API_REFERENCE.md](./docs/API_REFERENCE.md)** - API endpoints
173
- - **[ARCHITECTURE.md](./ARCHITECTURE.md)** - System design details
174
- - **[ROADMAP.md](./ROADMAP.md)** - Future plans
175
-
176
- ---
177
-
178
- ## 🛠️ Tech Stack
179
-
180
- **Frontend**
181
- - Python 3.13+
182
- - `rich` for terminal UI
183
- - `httpx` for async HTTP
184
- - `pydantic` for data validation
185
-
186
- **Backend**
187
- - FastAPI
188
- - PostgreSQL
189
- - JWT authentication
190
- - Multi-provider LLM integration
191
-
192
- **AI Providers**
193
- - Cerebras Inference API
194
- - Groq Cloud
195
- - Cloudflare Workers AI (fallback)
196
- - OpenRouter (fallback)
197
-
198
- **Deployment**
199
- - Heroku (backend + database)
200
- - GitHub Releases (installers)
201
-
202
- ---
203
-
204
- ## 🤝 Contributing
205
-
206
- We're not accepting contributions yet (private beta), but stay tuned!
207
-
208
- ---
209
-
210
- ## 📜 License
211
-
212
- Proprietary - All rights reserved
213
-
214
- ---
215
-
216
- ## 📧 Support
217
-
218
- - **Email**: s1133958@mail.yzu.edu.tw
219
- - **Issues**: Coming soon
220
- - **Documentation**: See `/docs` directory
221
-
222
- ---
223
-
224
- ## 🙏 Acknowledgments
225
-
226
- - **Cerebras** for generous free tier (14,400 RPD)
227
- - **Groq** for fast 70B inference
228
- - **GitHub Student Pack** for free hosting credits
229
- - **FastAPI** for excellent async framework
230
-
231
- ---
232
-
233
- **Built with ❤️ for researchers and analysts**
234
-
235
- *Cite-Agent - Because accuracy matters more than agreeableness*