https://github.com/ivotron/popper-badge-server

https://github.com/ivotron/popper-badge-server

Last synced: 18 days ago
JSON representation

• Host: GitHub
• URL: https://github.com/ivotron/popper-badge-server
• Owner: ivotron
• Created: 2018-06-25T20:13:46.000Z (almost 8 years ago)
• Default Branch: master
• Last Pushed: 2018-08-12T00:58:20.000Z (almost 8 years ago)
• Last Synced: 2025-03-21T11:50:56.147Z (about 1 year ago)
• Language: Python
• Size: 20.5 KB
• Stars: 1
• Watchers: 4
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

          
[![Build Status](https://travis-ci.org/popperized/popper-badge-server.svg?branch=master)](https://travis-ci.org/popperized/popper-badge-server)

[![Popper Status](http://badges.falsifiable.us/popperized/popper-badge-server)](http://popper.rtfd.io/en/latest/sections/badge_server.html)

# Popper Badge Server

This is a RESTful API server built with Flask used for serving badges,

specific to popper.

### Endpoints:

1. `/:org/:repo`:

    1. **GET**: Get the badge image for the org/repo (can be used to obtain

    the badge image used in the README of the popperized repository)

    2. **POST**: Create a record on the server for the org/repo with the

    commit_id, timestamp and the status of `popper run` command

    (will be triggered by a CI service)

2. `/:org/:repo/list`: List all the status records of the org/repo,

sorted by timestamp. Provides the `commit_id` and the `status`.

### For development:

1. Create and activate a virtual environment (recommended, but not necessary)

```bash

virtualenv popper-badge-server --python=python3

cd popper-badge-server

source bin/activate

```

2. Clone the repository

```bash

git clone https://github.com/popperized/popper-badge-server.git src

cd src

```

3. Run `pip install -r requirements.txt` to install all the dependencies.

4. Run `python app.py` to run the development server.