Skip to main content

SCROLL: Automatically generates documentation and unit-tests for python programs

Project description

SCROLL: Automatically generates documentation and unit-tests for python programs

Built with Data processing programs in mind

PyPI version Downloads Python 3.6

How it works

This tool monitors your function calls and returns while you "exercise" you program (i.e run functional tests). It will collect this information (traces), record the order in which your functions run and generate documentations / tests using that information.

Design concept

The final goal is to enable a developer/user browser through documentation that flows in the order in which functions in the program run, hence the name SCROLL.

Installation

pip install scroll

To install using wheel files, Check in Distribution files

Example Usage

Lets say your file which contains the main entry function is called main.py

An example main file with an entry function

# main.py

def run():
    '''this is your singlr entry function'''
    # your code here


if __name__ == '__main__':
    run()

Run the file using scroll on bash

scroll main.py

How about some guidelines?

  • There should be only one main entry function into you code

To-Do

  • add creating of url with class name / func name ancored on it
  • add creating of SCROLL.md that has scroll of all functions

Contributing

To get started contributing, Visit the CONTRIBUTING GUIDE

Contributors and acknowledgment

  1. Edison Abahurire simicode

Similar Libraries that do Runtime-Introspection:

  1. pythoscope for Auto unit-test generation
  2. auger for Auto Unit-test generation
  3. MonkeyType for auto Auto Type hinting / Annotation
  4. hypothesis for Auto test-case generation

License

MIT

Credits

  • MonkeyType: When I got this idea, My first option was to just plagiarise their code ;) I also learned a lot from issue-conversations with @carljm.
  • Flit which this wonderful library is packaged with.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Files for scroll, version 2020.7.23
Filename, size File type Python version Upload date Hashes
Filename, size scroll-2020.7.23-py3-none-any.whl (10.0 kB) File type Wheel Python version py3 Upload date Hashes View
Filename, size scroll-2020.7.23.tar.gz (15.1 kB) File type Source Python version None Upload date Hashes View

Supported by

AWS AWS Cloud computing Datadog Datadog Monitoring DigiCert DigiCert EV certificate Facebook / Instagram Facebook / Instagram PSF Sponsor Fastly Fastly CDN Google Google Object Storage and Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Salesforce Salesforce PSF Sponsor Sentry Sentry Error logging StatusPage StatusPage Status page