https://github.com/sourcepirate/raptor

Configurable Report generator
https://github.com/sourcepirate/raptor

Last synced: 16 days ago
JSON representation

Configurable Report generator

• Host: GitHub
• URL: https://github.com/sourcepirate/raptor
• Owner: sourcepirate
• License: mit
• Created: 2020-01-19T14:59:14.000Z (over 6 years ago)
• Default Branch: master
• Last Pushed: 2022-12-26T21:00:47.000Z (over 3 years ago)
• Last Synced: 2024-04-14T07:20:14.464Z (about 2 years ago)
• Language: Python
• Size: 34.2 KB
• Stars: 2
• Watchers: 1
• Forks: 0
• Open Issues: 6
• Metadata Files:
  • Readme: README.md
  • Changelog: HISTORY.md
  • Contributing: CONTRIBUTING.rst
  • License: LICENSE

Awesome Lists containing this project

README

          
## Raptor

[![Build Status](https://travis-ci.org/sourcepirate/raptor.svg?branch=master)](https://travis-ci.org/sourcepirate/raptor)

[![Updates](https://pyup.io/repos/github/sourcepirate/raptor/shield.svg)](https://pyup.io/repos/github/sourcepirate/raptor/)

[![Python 3](https://pyup.io/repos/github/sourcepirate/raptor/python-3-shield.svg)](https://pyup.io/repos/github/sourcepirate/raptor/)

Raptor is a configurable html report generation tool. Based on pandas dataframe.

## Installation and Usage

```

python setup.py install

raptor config.yml > report.html

```

## Example Config file

```yaml

template: default

title: Iris Data Reports

sender: sourcepirate@codelantics.com

receivers:

  - redspectrum@codelantics.com

sections:

  - name: intro

    description: desciription text

    datasource:

      type: url

      url: https://gist.githubusercontent.com/curran/a08a1080b88344b0c8a7/raw/639388c2cbc2120a14dcf466e85730eb8be498bb/iris.csv

    transform:

      - type: groupby

        by:

        - species

  - name: intro2

    description: desciription text

    datasource:

      type: url

      url: https://gist.githubusercontent.com/curran/a08a1080b88344b0c8a7/raw/639388c2cbc2120a14dcf466e85730eb8be498bb/iris.csv

    transform:

      - type: groupby

        by:

        - species

```

## Road Map

* Email support

* More configuration

* More customizable.

## License

MIT