Metadata-Version: 1.0
Name: gofedinfra
Version: 0.0.1
Summary: Gofed infrastructure
Home-page: https://github.com/gofed/infra
Author: Jan Chaloupka
Author-email: jchaloup@redhat.com
License: GPL
Description: # Gofed infrastructure
        
        Infrastructure for gofed tool and various models built over data extracted from golang source codes.
        
        It is designed to provide:
        
        * general interface for integration of already existing plugins
        * general interface to build acts (sequence of actions over integrated plugins)
        * abstract way to declare resources that plugins work with
        
        ## Concepts
        
        **Plugins**: building blocks integrating working pieces of a code (analysis, extractions, etc.) into the infrastructure
        
        **Acts**: composition of actions providing data for your application, e.g. data needed to generate spec file, analysis of source code, dependency graph construction.
        
        **Resource Handling**: declare what resource you want to work with and let the infrastructure retrieve the resource and provide it to a plugin.
        
        **Action Handling**: once a plugin is integrated into the infrastructure it automatically gets an ID you can use to run the plugin.
        
        ## Requirements
        
        * python2.7 (see [requirements.txt](requirements.txt))
        * etcd
        
        ## How to start
        
        The infrastructure is under construction atm. To try it you can run:
        
        ```vim
        $ PYTHONPATH=$(pwd)/third_party:$(pwd)/../ python testact.py
        ```
        
        The script is set to inspect code of ``github.com/bradfitz/http2`` of ``f8202bc903bda493ebba4aa54922d78430c2c42f`` commit.
        Product of the run are two artefacts (json containing extracted data): ``golang-project-packages`` and ``golang-project-content-metadata``.
        See [schemas](system/artefacts/schemas) for definition of artefacts.
        
        ## How to contribute
        
        Although the infrastructure is not fully functional you can already create your own acts and integrate plugins.
        At the moment we are concentrating on ecosystem analysis (scan of available builds and upstream project in question) to collect data about the ecosystem
        and to prepare for its healh check. At the same time to provide better tooling and expose full experience with gofed tool.
        
        Some issues can be found at [gofed/gofed](https://github.com/gofed/gofed/issues). Other are on a private board atm.
        For more information contact jchaloup@redhat.com.
        
Keywords: gofed,infra
Platform: UNKNOWN
