ResLib: Research Library

Release v0.0.2. (Installation of ResLib)

Research Library is intended to help Accounting and Finance researchers do efficient, repeatable research.

This documentation provides an overview of ResLib, starting with the Philosophy of ResLib, and then diving into the nuts and bolts with the Installation of ResLib and then the Quickstart. The rest of the docs describe each component of ResLib in detail, with a full reference in the API section.

ResLib relies heavily on Doit for pipeline automation, and Pandas for data wrangling. The documentation for these libraries can be found at:

• Doit documentation

• Pandas documentation

User Guide

This part of the documentation, which is mostly prose, begins with some background information about ResLib, then focuses on step-by-step instructions for project development with ResLib.

• Philosophy of ResLib
  • Pipelines
  • Python
• Installation of ResLib
  • $ pip install
  • $ pip install from github
  • Step 0: Install Python
• Quickstart
  • Pipelines
  • Python Library

API

This part of the documentation dives into the gory detail of ResLib in all it’s paltry equivalent of glory.

• API
  • reslib package
    • Subpackages
    • Module contents
  • Data
    • reslib.data package
    • reslib.data.sources package
    • reslib.data.sources.wrds package
  • Automate
    • reslib.automate package
  • Process
    • reslib.processing package
  • Config
    • Reslib Config (reslib.config)

Indices and tables

• Index

• Module Index

• Search Page

Thanks to Requests and Flask for their wonderful programming and documentation examples. I stole shamelessly from the examples set by both.