Metadata-Version: 2.1
Name: prometheus-build-info
Version: 2.0.2
Summary: Utility project for recording build information and exposing it as a prometheus metric
Home-page: https://github.com/nralbers/prometheus_buildinfo
Author: Niels Albers
Author-email: nralbers@gmail.com
License: MIT
Description: # Prometheus BuildInfo
        Python library for adding a buildinfo metric to your Prometheus-enabled applications.
        
        ## Usage
        ### Installation
        
            pip install prometheus-build-info
            
        ### make-build-info utility
        
        The make-build-info utility can be used during building or packaging to create a prom_build_info.json file that stores the
        relevant build information that this library publishes. 
        
            make-build-info --help
            Usage: make-build-info [OPTIONS] APPNAME BRANCH REVISION VERSION
        
            Options:
              --help  Show this message and exit.
        
        Alternatively, running the utility when environment variables exist with the same name as the arguments listed above will
        have the same effect.
        
        ### Manual creation of prom_build_info.json
        
        If this suits your build process better, you can manually create prom_build_info.json during the build. It has the following 
        format:
        
            {
            "appname": "test_app",
            "branch": "master",
            "revision": "abcdef",
            "version": "1.0.1"
            }
            
        ### Adding the metric to your app
        
        Ensure that prom_build_info.json is in your application working directory. Import ```prometheus_build_info.metrics``` 
        into a code file that will be run during or after application initialisation.
Keywords: metrics,prometheus,build
Platform: UNKNOWN
Classifier: Natural Language :: English
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.5
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: Implementation :: CPython
Classifier: Programming Language :: Python :: Implementation :: PyPy
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Classifier: Development Status :: 5 - Production/Stable
Classifier: Topic :: Software Development :: Libraries :: Python Modules
Classifier: Topic :: System :: Monitoring
Classifier: Topic :: Software Development :: Build Tools
Classifier: Intended Audience :: Developers
Requires-Python: >=3.5
Description-Content-Type: text/markdown; charset=UTF-8
