docly

docly

Automatically generate docstrings for your python functions

Main documentation (FAQ and all)

http://beta.thedocly.io/

Installing

Requires python 3.6+

NOTE THAT, if you are getting an error (in a fresh virtualenv in ubuntu it is observed) like error: invalid command 'bdist_wheel' then please install wheel by doing pip install wheel

ALSO NOTE that if you are getting an error to build tree-sitter because you do not have gcc installed then you can install it using sudo apt-get install gcc python3-dev for other distros please check here

First install setuptools-rust by

pip install setuptools-rust

Then

pip install docly

Using

To generate comments -

docly-gen /path/to/file_or_folder_with_python_files

Please note that if you do not have the necessary engine (models) downloaded before running the command (which is going to be case the first time you run this command) then it will download and set them up. Which may take a bit of time

It will produce something like this (Shown on a single file but you can run it on a directory full of files also)

The diff has been generated, do you want to see the suggestions for missing Docstrings? [Y/n]
Y
+-----------------+------------------------------+---------------------------------------+
| File Name       | Function Name                | Docstring                             |
+-----------------+------------------------------+---------------------------------------+
| simple_funcs.py | add                          | Add two numbers .                     |
| simple_funcs.py | check_if_even                | Checks if number is even .            |
| simple_funcs.py | check_even_numbers_in_a_list | Return list of numbers in base_list . |
| simple_funcs.py | open_file                    | Open a file .                         |
+-----------------+------------------------------+---------------------------------------+
Do you want to apply the suggestions? [Y/n]
Y
Applying diff
Diff applied. Good bye!

Instead if you just want the above report and not to apply the chages then do this -

docly-gen --no_generate_diff --print_report /path/to/file_or_folder_with_python_files

If you want to revert the changes we applied then use

docly-restore

This will bring back ALL the files that we had touched to the exact state before we applied the changes