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
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
TODO
Contributing
To get started contributing, Visit the CONTRIBUTING GUIDE
Contributors and acknowledgment
- Edison Abahurire simicode - BDFL
Similar Libraries that do Runtime-Introspection:
- pythoscope for Auto unit-test generation
- auger for Auto Unit-test generation
- MonkeyType for auto Auto Type hinting / Annotation
- hypothesis for Auto test-case generation
License
Packaged with: Flit
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for scroll-2020.6.15-py3-none-any.whl
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | e3347ee4bde16b1529e68f43156d8e702a5dac6e13c1f880ab34c923ba2b36fc |
|
| MD5 | f0ca087d7d0f678cf74686ba482f17f4 |
|
| BLAKE2b-256 | ea1874bbea5be15b99a2f6342a6a35126e815f83bcf3f662949ab0b7dba533b5 |
