---

---

News Craft

News Craft is an AI-powered chatbot designed to automatically generate news articles. It utilizes OpenAI and Streamlit to create a seamless and user-friendly experience.

Table of Contents

• Prerequisites
• Installation
• Usage
• Contributing
• License

Prerequisites

Before setting up the project, ensure that you have the following prerequisites installed on your machine:

• Python (version >=3.9, <3.9.7 || >3.9.7,<4.0): (https://www.python.org/downloads/)
• Poetry (version 1.4.0): (https://python-poetry.org/docs/#installation)

Installation

1. Clone the project repository:

git clone https://github.com/TOBB-ETU-CS-Community/News-Craft.git

2. Navigate to the project directory:

cd news_craft

3. Install project dependencies using Poetry:

poetry install

This command will create a virtual environment and install all the necessary dependencies specified in the pyproject.toml file.

Usage

1. Activate the virtual environment created by Poetry:

poetry shell

2. Run the project:

streamlit run "news_craft/app.py"

Contributing

If you would like to contribute to this project, follow the guidelines below:

1. Fork the repository and clone it locally.

2. Create a new branch for your feature or bug fix:

   git checkout -b feature/your-feature
   

3. Make your changes and commit them with descriptive commit messages.

4. Push your changes to your forked repository:

   git push origin feature/your-feature
   

5. Open a pull request in the original repository, describing your changes in detail.

License

GPL v3

---