📰 Quantex News API

A resurrected news API project — originally broken, now fully functional with PostgreSQL, async support, and a clean modular structure.

---

🚀 What this project does

• Provides a REST API for news articles
• Stores data in PostgreSQL (or SQLite for local testing)
• Uses async drivers for better performance
• Includes authentication via x-secret header

---

🛠️ What was fixed

• ✅ Database connection issues resolved
• ✅ Async driver support added
• ✅ Tables created via Alembic migrations
• ✅ GET and POST endpoints tested and working
• ✅ Authentication via x-secret header validated
• ✅ Modular project structure organized

---

📁 Project Structure

quantex/ ├── quantex/ # Main application package │ ├── web/ # API routes and dependencies │ ├── database/ # Models and DAOs │ └── settings.py # Configuration ├── requirements.txt # Dependencies ├── alembic.ini # Migration config └── README.md # This file

---

🧩 Technologies Used

• Python 3.10+
• FastAPI
• SQLAlchemy (async)
• PostgreSQL / SQLite
• Alembic
• Uvicorn
• Pydantic

---

📦 How to Run

# 1. Clone
git clone https://github.com/alcitech7-oss/debugged_news_api.git
cd debugged_news_api

# 2. Create and activate venv
python -m venv venv
venv\Scripts\activate

# 3. Install dependencies
pip install -r requirements.txt

# 4. Install the project in editable mode (resolve PackageNotFoundError)
pip install -e .

# 5. Run migrations
alembic upgrade head

# 6. Start the server
python -m quantex
🔑 Authentication
All endpoints require the x-secret header: x-secret: secret

📡 API Endpoints
| Método | Endpoint | Descrição |
|--------|----------|-------------|
| GET | `/api/news/` | Lista todas as notícias |
| POST | `/api/news/` | Cria uma nova notícia |
| GET | `/api/news/{id}` | Busca notícia por ID |

📌 Notes
The original project was broken and abandoned.

This version was fully restored, tested, and documented.

Runs with PostgreSQL or SQLite (for local testing).

🙏 Credits & Original Work
This project is based on the original quantex-news-api repository.

The original code was broken and abandoned.
This version includes:

Full restoration of functionality

Database and async support fixes

Updated dependencies and structure

Clean documentation and organization

All improvements were made with respect to the original authors.

👨‍💻 Maintained by
alictech7-oss

📄 License
MIT — use, modify, and share freely.

---