{"id":24904749,"url":"https://github.com/peliah/basic-python-api","last_synced_at":"2026-05-02T14:36:19.589Z","repository":{"id":275061310,"uuid":"924942530","full_name":"Peliah/basic-python-api","owner":"Peliah","description":"This is a simple public API that returns basic information in JSON format.","archived":false,"fork":false,"pushed_at":"2025-01-31T00:13:16.000Z","size":3,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"master","last_synced_at":"2025-01-31T00:25:21.510Z","etag":null,"topics":["api","flask","python"],"latest_commit_sha":null,"homepage":"https://hng-12-api.onrender.com/","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/Peliah.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2025-01-30T23:09:52.000Z","updated_at":"2025-01-31T00:13:18.000Z","dependencies_parsed_at":"2025-01-31T19:15:21.549Z","dependency_job_id":null,"html_url":"https://github.com/Peliah/basic-python-api","commit_stats":null,"previous_names":["peliah/basic-python-api"],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Peliah%2Fbasic-python-api","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Peliah%2Fbasic-python-api/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Peliah%2Fbasic-python-api/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Peliah%2Fbasic-python-api/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/Peliah","download_url":"https://codeload.github.com/Peliah/basic-python-api/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":245924503,"owners_count":20694731,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["api","flask","python"],"created_at":"2025-02-01T23:39:38.844Z","updated_at":"2026-05-02T14:36:19.542Z","avatar_url":"https://github.com/Peliah.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"\n---\n\n# **Basic Python API with FastAPI**\n\nThis is a simple public API built with **FastAPI** that returns basic information in JSON format. The API provides the following details:\n- Your registered email address.\n- The current datetime in ISO 8601 format (UTC).\n- The GitHub URL of the project's codebase.\n\n---\n\n## **Features**\n- **FastAPI**: A modern, fast (high-performance) web framework for building APIs with Python.\n- **CORS Support**: Handles Cross-Origin Resource Sharing (CORS) to allow requests from any domain.\n- **Caching**: Uses `lru_cache` to cache the response for improved performance.\n- **Deployment**: Deployed on **Render** for public access.\n\n---\n\n## **API Documentation**\n\n### **Endpoint**\n- **URL**: `https://hng-12-api.onrender.com/`\n- **Method**: `GET`\n\n### **Response Format**\n```json\n{\n  \"email\": \"pelepoupa@gmail.com\",\n  \"current_datetime\": \"2023-10-10T12:34:56.789Z\",\n  \"github_url\": \"https://github.com/Peliah/basic-python-api\"\n}\n```\n\n---\n\n## **Setup Instructions**\n\n### **1. Clone the Repository**\n```bash\ngit clone https://github.com/Peliah/basic-python-api.git\ncd basic-python-api\n```\n\n### **2. Install Dependencies**\nEnsure you have Python 3.7+ installed. Then, install the required dependencies:\n```bash\npip install -r requirements.txt\n```\n\n### **3. Run the Application Locally**\nStart the FastAPI app using Uvicorn:\n```bash\nuvicorn main:app --host 0.0.0.0 --port 8000\n```\n\nVisit `http://127.0.0.1:8000/` in your browser or use `curl` to test the API:\n```bash\ncurl http://127.0.0.1:8000/\n```\n\n---\n\n## **Deployment**\n\nThis API is deployed on **Render**. To deploy your own instance:\n\n1. **Sign Up on Render**: Go to [Render](https://render.com) and create an account.\n2. **Create a New Web Service**:\n   - Connect your GitHub repository.\n   - Set the **Start Command** to:\n     ```bash\n     uvicorn main:app --host 0.0.0.0 --port 8000\n     ```\n3. **Deploy**: Render will automatically build and deploy your application.\n\n---\n\n## **Example Usage**\n\n### **Request**\n```bash\ncurl https://hng-12-api.onrender.com/\n```\n\n### **Response**\n```json\n{\n  \"email\": \"pelepoupa@gmail.com\",\n  \"current_datetime\": \"2023-10-10T12:34:56.789Z\",\n  \"github_url\": \"https://github.com/Peliah/basic-python-api\"\n}\n```\n\n---\n\n## **Technologies Used**\n- **FastAPI**: A modern, fast web framework for building APIs.\n- **Uvicorn**: A lightning-fast ASGI server for serving FastAPI apps.\n- **Render**: A cloud platform for deploying web services.\n\n---\n\n## **License**\nThis project is licensed under the MIT License. See the [LICENSE](LICENSE) file for details.\n\n---\n\n## **Backlink**\n- [Hire Python Developers](https://hng.tech/hire/python-developers)\n\n---\n\n## **Contact**\nFor questions or feedback, please contact:\n- **Email**: pelepoupa@gmail.com\n- **GitHub**: [Peliah](https://github.com/Peliah)\n\n---\n\n🚀","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fpeliah%2Fbasic-python-api","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fpeliah%2Fbasic-python-api","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fpeliah%2Fbasic-python-api/lists"}