https://github.com/ali-raza764/chess_puzzles_api
An api built on top of lichess puzzles database using python flask and pandas.
https://github.com/ali-raza764/chess_puzzles_api
api chess chess-puzzle csv flask lichess pandas puzzles puzzles-api python
Last synced: 3 months ago
JSON representation
An api built on top of lichess puzzles database using python flask and pandas.
- Host: GitHub
- URL: https://github.com/ali-raza764/chess_puzzles_api
- Owner: Ali-Raza764
- Created: 2024-06-23T12:28:50.000Z (about 1 year ago)
- Default Branch: main
- Last Pushed: 2024-09-05T06:10:30.000Z (10 months ago)
- Last Synced: 2024-09-06T11:09:04.690Z (10 months ago)
- Topics: api, chess, chess-puzzle, csv, flask, lichess, pandas, puzzles, puzzles-api, python
- Language: HTML
- Homepage: https://chess-puzzles-api.vercel.app
- Size: 840 KB
- Stars: 2
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: Readme.md
Awesome Lists containing this project
README
# Puzzle API
This is a Flask-based API for retrieving puzzle data. The API supports filtering and pagination, and it includes caching for better performance.
## Endpoints
### GET /puzzles
Retrieve a list of puzzles with optional filters and pagination.
#### Query Parameters:
- **start** (integer, default: 0) - The starting index for pagination.
- **limit** (integer, default: 10) - The number of puzzles to return.
- **min_rating** (integer, default: 0) - The minimum rating to filter puzzles.
- **max_rating** (integer, default: 3000) - The maximum rating to filter puzzles.
- **themes** (string) - A comma-separated list of themes to filter puzzles.
#### Example Request:
```plaintext
https://chess-puzzles-api.vercel.app/puzzles?start=0&limit=10&min_rating=1000&max_rating=2000&themes=adventure,logic
```
### GET /puzzle
Retrieve a puzzle by its ID.
#### Query Parameters:
- **puzzle_id** (string) - The ID of the puzzle to retrieve.
#### Example Request:
```plaintext
https://chess-puzzles-api.vercel.app/puzzle?puzzle_id=12345
```
## Getting Started
### Prerequisites
- Python 3.x
- Flask
- Flask-Caching
- pandas
### Installation
1. Clone the repository:
```sh
https://github.com/Ali-Raza764/chess_puzzles_api
cd YOUR_REPOSITORY_NAME
```
2. Create a virtual environment and activate it:
```sh
python -m venv venv
source venv/bin/activate # On Windows use `venv\Scripts\activate`
```
3. Install the dependencies:
```sh
pip install -r requirements.txt
```
4. Ensure you have a `puzzles.csv` file in the root directory of your project.
### Running the App
1. Run the Flask app:
```sh
flask run
```
2. Open your browser and go to `http://127.0.0.1:5000` to view the API documentation.
## Deployment
For deployment, you can use services like Heroku, AWS, or any other cloud provider. Ensure you have the necessary environment variables set up and a production-ready server configuration.
## License
This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.