Giter VIP home page Giter VIP logo

meles's Introduction

meles

meles are the zoological family of the badgers.

So meles creates badges for you. Even in isolated environments.

Currently, raw shields are supported as well as the nuget-api.

meles hereby tries to be as compatible as necessary the original shields.io API.

Endpoints

Currently, the following end-points are available:

Shields

Supports the shields.io static badge.

Supported parameters:

  • badgeContent
  • logo
  • logoColor
  • label
  • labelColor
  • color
  • cacheSeconds

NuGet

Supports the shields.io dynamic badges. The following routes are supported:

Supported parameters:

  • label
  • labelColor
  • color
  • cacheSeconds

Dynamic

Supports the shields.io dynamic badges. The following routes are supported:

Supported parameters:

  • url
  • query
  • logo
  • logoColor
  • label
  • labelColor
  • color
  • prefix
  • suffix
  • cacheSeconds

System

/health: A health resource. Returns OK. Can be disabled by setting MELES_USE_HEALTHCHECK to False

/metrics: An open metrics compliant endpoint for prometheus scraping. Can be disabled by setting MELES_USE_PROMETHEUS to False

/system: Returns a JSON file with information about this package.

Configuration

The configuration takes place using the following environment variables:

Environment Variables Values / Ranges Descriptions
MELES_PORT ushort Port, only used for python -m
MELES_HOST IP-Address / FQDN Host, only used for python -m
MELES_CONFIGURATION_MODULE string Setup method in pkg_resource notation
MELES_CACHE_* individual Key-Value-Pairs to configure falcon-caching. Just add MELES_ to get the config value
MELES_USE_HEALTHCHECK True, False Enable or disable health-check endpoint
MELES_USE_PROMETHEUS True, False Enable or disable prometheus metrics endpoint
MELES_ENVIRONMENT PRODUCTION, DEVELOPMENT Development to use

When Environment is set to DEVELOPMENT, the logging level will be set to Debug, otherwise Info will be used.

All logging will be formatted in a structured manner using a JSON representation and printed to stderr, which should not interfere with WSGI.

Documentation

Refer to docs for details.

meles's People

Contributors

carstencodes avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.