Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/raphaelbh/timezone-api

Timezone API is a simple web service that returns the current date and time considering a given time zone.
https://github.com/raphaelbh/timezone-api

api date datetime docker docker-compose dockerfile dockerhub flask github-actions heroku heroku-deployment open-api open-api-specification python rest-api swagger swagger-ui time timezone

Last synced: about 1 month ago
JSON representation

Timezone API is a simple web service that returns the current date and time considering a given time zone.

Host: GitHub
URL: https://github.com/raphaelbh/timezone-api
Owner: raphaelbh
License: mit
Created: 2022-02-03T01:01:01.000Z (almost 3 years ago)
Default Branch: main
Last Pushed: 2023-07-29T00:52:01.000Z (over 1 year ago)
Last Synced: 2024-10-21T05:28:59.162Z (2 months ago)
Topics: api, date, datetime, docker, docker-compose, dockerfile, dockerhub, flask, github-actions, heroku, heroku-deployment, open-api, open-api-specification, python, rest-api, swagger, swagger-ui, time, timezone
Language: Python
Homepage: https://timezone-api-01.herokuapp.com/api/v1/swagger
Size: 49.8 KB
Stars: 1
Watchers: 2
Forks: 0
Open Issues: 0
Metadata Files:
- Readme: README.md
- License: LICENSE

Awesome Lists containing this project

README

        # Timezone API

[![Project Status](https://img.shields.io/static/v1?label=project%20status&message=complete&color=success&style=flat-square)](#)

[![GitHub License](https://img.shields.io/github/license/raphaelbh/python-web-template?style=flat-square)](#)

Timezone API is a simple web service that provides useful time zone services to external third parties.

This project was created with the purpose of deepening knowledge in python, openapi specification, github actions and heroku integration.

## Demo

[https://timezone-api.onrender.com/api/v1/swagger/](https://timezone-api.onrender.com/api/v1/swagger/)

## Requirements

[![docker](https://img.shields.io/badge/Docker-2CA5E0?style=for-the-badge&logo=docker&logoColor=white)](https://www.docker.com/)

## Installation

```bash

$ docker-compose up -d

or

$ docker run -p 5000:5000 -e PORT=5000 -d raphaelbh/timezone-api

```

    

## Usage

```bash

$ curl http://localhost:5000/api/v1/now

$ curl http://localhost:5000/api/v1/timezones

```

## Running Tests

```bash

$ export PYTHONPATH=application

$ pytest --cache-clear --cov=application tests/

```

## Tech Stack

[![docker](https://img.shields.io/badge/Docker-2CA5E0?style=for-the-badge&logo=docker&logoColor=white)](https://www.docker.com/)

[![python](https://img.shields.io/badge/Python-FFD43B?style=for-the-badge&logo=python&logoColor=blue)](https://www.python.org/)

[![flask](https://img.shields.io/badge/Flask-000000?style=for-the-badge&logo=flask&logoColor=white)](https://flask.palletsprojects.com/en/2.0.x/)

[![swagger](https://img.shields.io/badge/Swagger-85EA2D?style=for-the-badge&logo=Swagger&logoColor=white)](https://swagger.io/)

[![heroku](https://img.shields.io/badge/Heroku-430098?style=for-the-badge&logo=heroku&logoColor=white)](https://heroku.com)

## Reference

- https://devcenter.heroku.com/articles/container-registry-and-runtime

## Feedback

If you have any feedback, please contact me at [email protected]

[![github](https://img.shields.io/badge/GitHub-100000?style=for-the-badge&logo=github&logoColor=white)](https://github.com/raphaelbh)

[![linkedin](https://img.shields.io/badge/LinkedIn-0077B5?style=for-the-badge&logo=linkedin&logoColor=white)](https://www.linkedin.com/in/raphaelbh/)