https://github.com/zanderlewis/idrc
idrc: Auto APIs for lazy people.
https://github.com/zanderlewis/idrc
api auto lib library python python-library python3
Last synced: 4 months ago
JSON representation
idrc: Auto APIs for lazy people.
- Host: GitHub
- URL: https://github.com/zanderlewis/idrc
- Owner: zanderlewis
- License: apache-2.0
- Created: 2024-08-12T17:44:47.000Z (almost 2 years ago)
- Default Branch: main
- Last Pushed: 2024-08-28T00:03:39.000Z (almost 2 years ago)
- Last Synced: 2025-04-08T19:50:17.946Z (about 1 year ago)
- Topics: api, auto, lib, library, python, python-library, python3
- Language: Python
- Homepage: https://pypi.org/project/idrc/
- Size: 74.2 KB
- Stars: 2
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# IDRC
I Don't Really Care (IDRC): Auto APIs for lazy people
[](LICENSE)
[](https://pypi.org/project/idrc)
## Table of Contents
- [IRDC](#idrc)
- [Installation](#installation)
- [Usage](#usage)
- [IDRC vs Flask](#idrc-vs-flask)
## Installation
IDRC can be installed via `pip` like so:
`pip3 install idrc`
## Usage
IDRC can integrate with any function. For example:
```python
from idrc import idrc
# Initialize the idrc class
api = idrc(verbose=True)
# Simulate a weather database
weather_data = {
"New York": {"temperature": 25, "condition": "Sunny"},
"Los Angeles": {"temperature": 30, "condition": "Cloudy"},
"Chicago": {"temperature": 18, "condition": "Rainy"}
}
# Define a weather forecast function
def get_weather(city: str) -> dict:
forecast = weather_data.get(city, None)
if forecast:
return forecast
else:
return api.ecode(404, 'City not found')
# Register the function as an API endpoint
api.define(get_weather, methods=['GET'])
# Run the idrc API
if __name__ == '__main__':
api.run(host='0.0.0.0', port=5000, debug=True)
```
The `define` function in the `idrc` library generated the api.
The Flask equivalent of the code above is:
```python
from flask import Flask, request, jsonify
# Initialize the Flask app
app = Flask(__name__)
# Simulate a weather database
weather_data = {
"New York": {"temperature": 25, "condition": "Sunny"},
"Los Angeles": {"temperature": 30, "condition": "Cloudy"},
"Chicago": {"temperature": 18, "condition": "Rainy"}
}
# Define a weather forecast function
@app.route('/api/v1/get_weather', methods=['GET'])
def get_weather():
city = request.args.get('city')
if not city:
return jsonify({"error": "City parameter is required"}), 400
forecast = weather_data.get(city)
if forecast:
return jsonify(forecast)
else:
return jsonify({"error": "City not found"}),404
# Run the Flask app
if __name__ == '__main__':
app.run(host='0.0.0.0', port=5000, debug=True)
```
IDRC condensed 27 lines of code into 25 lines of code, with much less typing overall.
## IDRC vs Flask
### Advantages of IDRC
- Rapid API development
- Very Simple
- Built-in error handling
- Lightweight wrapper of Flask
- Pretty terminal output
### Advantages of Flask
- Mature framework
- Large community
- Flexible and extensible
- Extensive documentation
- Stack traces