https://github.com/rafpyprog/rstwriter

Report writing for Pandas using reStructuredTex
https://github.com/rafpyprog/rstwriter

Last synced: 5 days ago
JSON representation

Report writing for Pandas using reStructuredTex

• Host: GitHub
• URL: https://github.com/rafpyprog/rstwriter
• Owner: rafpyprog
• License: mit
• Created: 2017-01-13T11:41:57.000Z (almost 8 years ago)
• Default Branch: master
• Last Pushed: 2017-01-24T13:47:11.000Z (almost 8 years ago)
• Last Synced: 2024-10-12T19:14:19.397Z (about 1 month ago)
• Language: Python
• Size: 62.5 KB
• Stars: 1
• Watchers: 3
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: README.rst
  • License: LICENSE.txt

Awesome Lists containing this project

README

        
RstWriter

=========

Report writing for Pandas using reStructuredTex

.. image:: https://travis-ci.org/rafpyprog/rstwriter.svg?branch=master

  :target: https://travis-ci.org/rafpyprog/rstwriter

.. image:: https://codecov.io/gh/rafpyprog/rstwriter/branch/master/graph/badge.svg

  :target: https://codecov.io/gh/rafpyprog/rstwriter

 

Installing

----------

pip install rstwriter

Usage

----- 

.. code:: python

    import pandas as pd

    from rstwriter import RstWriter

    report = RstWriter('sales.rst')

    report.header('open')

    report.paragraph('Some text in the header')

    report.header('close')

    report.title('h1', 'Awesome Report')

    report.paragraph('Amazing text. Really cool.')

    report.title('h2', 'Cool content')

    # Include a CSS file.

    report.css = 'ourstyles.css'`

    # use classes from the added css to style paragraphs.

    report.paragraph('I hope this is blue', style='blue-text')

    # reads a DataFrame and includes in the document as a table.

    data = pd.read_csv('sales.csv')

    report.table(data)

    # publish you report to sales.html.

    report.publish('html')