Spaces:
Sleeping
Sleeping
BLJohnPrabhasith
commited on
Commit
β’
9847c66
1
Parent(s):
6fd87f5
Create Readme.md
Browse files
Readme.md
ADDED
@@ -0,0 +1,87 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
1 |
+
# Culprit
|
2 |
+
|
3 |
+
AI News Crew is a Streamlit-based web application that uses MultiAgent Architecture to research and write articles on any given topic. Using advanced language models and AI agents(crewAI), it generates comprehensive and engaging content with just a few clicks.
|
4 |
+
|
5 |
+
|
6 |
+
## Features
|
7 |
+
|
8 |
+
- π AI-powered research on any topic
|
9 |
+
- βοΈ Automated article writing
|
10 |
+
- π Secure API key management
|
11 |
+
- π User-friendly Streamlit interface
|
12 |
+
- π₯ Easy article download option
|
13 |
+
|
14 |
+
|
15 |
+
## Clone the repository:
|
16 |
+
|
17 |
+
|
18 |
+
```python
|
19 |
+
git clone https://github.com/johnprabhasith/Culprit.git
|
20 |
+
cd Culprit
|
21 |
+
```
|
22 |
+
|
23 |
+
#### Install the required packages
|
24 |
+
|
25 |
+
```python
|
26 |
+
pip install -r requirements.txt
|
27 |
+
```
|
28 |
+
|
29 |
+
You will enter these API keys in the Streamlit interface when you run the application.
|
30 |
+
|
31 |
+
#### Usage:
|
32 |
+
|
33 |
+
Start the Streamlit app:
|
34 |
+
|
35 |
+
```bash
|
36 |
+
streamlit run app.py
|
37 |
+
```
|
38 |
+
Open your web browser and go to the URL provided by Streamlit (usually http://localhost:8501).
|
39 |
+
|
40 |
+
## Contributing
|
41 |
+
--Enter your API keys in the sidebar.
|
42 |
+
|
43 |
+
--Type in a topic for your article in the main input field.
|
44 |
+
|
45 |
+
--Click the "Generate Article" button and wait for your AI-generated article!
|
46 |
+
|
47 |
+
--Once generated, you can read the article directly in the app or download it as a text file.
|
48 |
+
|
49 |
+
## Project Structure
|
50 |
+
--app.py: Main Streamlit application file
|
51 |
+
|
52 |
+
--agents.py: Defines AI agents for research and writing
|
53 |
+
|
54 |
+
--tasks.py: Specifies tasks for the AI agents
|
55 |
+
|
56 |
+
--tools.py: Contains custom tools used by the agents
|
57 |
+
|
58 |
+
--requirements.txt: List of Python dependencies
|
59 |
+
|
60 |
+
## Contributions
|
61 |
+
Contributions to AI News Crew are welcome! Please feel free to submit a Pull Request.
|
62 |
+
|
63 |
+
## License
|
64 |
+
|
65 |
+
This project is licensed under the MIT License - see the LICENSE file for details.
|
66 |
+
|
67 |
+
## Acknowledgments
|
68 |
+
|
69 |
+
Streamlit for the amazing web app framework
|
70 |
+
|
71 |
+
LangChain for AI agent orchestration
|
72 |
+
|
73 |
+
Groq for their powerful language models
|
74 |
+
|
75 |
+
Serper for web search capabilities
|
76 |
+
|
77 |
+
|
78 |
+
For any queries or suggestions, please open an issue on this GitHub repository.
|
79 |
+
|
80 |
+
|
81 |
+
|
82 |
+
.............Happy writing with AI Culprit! πβ¨
|
83 |
+
|
84 |
+
## License
|
85 |
+
|
86 |
+
[MIT](https://github.com/JohnPrabhasith/Culprit/blob/main/LICENSE)# Culprit
|
87 |
+
|