https://github.com/libero/flask-ping

Blueprint for a `/ping` endpoint that can be added to python Flask applications
https://github.com/libero/flask-ping

Last synced: 9 days ago
JSON representation

Blueprint for a `/ping` endpoint that can be added to python Flask applications

• Host: GitHub
• URL: https://github.com/libero/flask-ping
• Owner: libero
• License: mit
• Archived: true
• Created: 2019-09-16T10:25:44.000Z (about 5 years ago)
• Default Branch: master
• Last Pushed: 2019-09-18T13:00:02.000Z (about 5 years ago)
• Last Synced: 2024-08-13T07:08:46.523Z (4 months ago)
• Language: Python
• Size: 11.7 KB
• Stars: 1
• Watchers: 1
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE
  • Codeowners: .github/CODEOWNERS

Awesome Lists containing this project

• jimsghstars - libero/flask-ping - Blueprint for a `/ping` endpoint that can be added to python Flask applications (Python)

README

        
# Flask-ping

Blueprint for a `/ping` endpoint that can be added to python [Flask](https://flask.palletsprojects.com/en/1.1.x/) applications.

## Usage

To add the `/ping` endpoint to your application add the following:

```python

from flask_ping import get_ping_blueprint

app.register_blueprint(get_ping_blueprint())

```

Once registered, you will be able to access the following endpoint:

 GET `/ping`

Response:

DATA `pong`

STATUS 200

Headers:

`Content-type: text/plain`

`Cache-Control: no-store, must-revalidate`

See [ping.py](flask_ping.ping.py) for implementation details

## Run Tests Locally

#### Dependencies

- [Docker](https://www.docker.com/)

- [gnu make](https://www.gnu.org/software/make/)

To run tests use the following command:

```bash

make tests

```