Poets API

A RESTful API for accessing classical Persian poetry and literature, including works from Hafez, Khayyam, Moulavi, and Sa'adi.

---

Table of Contents

• Features
• Requirements
• Installation and Setup
• Running the Application
  • Running Locally Without Docker
• API Endpoints
• Contributing
• License

---

Features

• Access to classical Persian poetry from renowned poets
• Random poem selection functionality
• Filter poems by category and specific numbers
• RESTful API design with JSON responses
• Support for Hafez's ghazals, ghete, robaee, ghaside, and montasab
• Support for Khayyam's robaee and tarane
• Support for Moulavi's works from Shams and Masnavi
• Access to Sa'adi's Golestan by bab and hekayat numbers

---

Requirements

• Python
• Django & Django REST Framework

---

Installation and Setup

1. Clone the Repository

git clone https://github.com/amirreza-jabbari/poets-api.git
cd poets-api

---

Running the Application

Running Locally Without Docker

If running locally:

1. Create a virtual environment and install dependencies:

python3 -m venv venv
source venv/bin/activate  # On Windows: venv\Scripts\activate
pip install -r requirements.txt

3. Apply Migrations:

python manage.py makemigrations
python manage.py migrate --fake-initial

4. Create superuser

python manage.py createsuperuser

5. Run the Django Server:

python manage.py runserver

---

API Endpoints

You can see complete documentation of Poets API Endpoints in the endpoints.md file.

---

Contributing

Contributions are welcome! Please submit pull requests or open issues. Make sure to update tests and documentation accordingly.

---

License

This project is licensed under the MIT License. See the LICENSE file for details.