A simple tagging library for documenting python scripts
UnoTagger only requires unotools, assuming that you already have libreoffice installed:
sudo pip3 install unotools
If you don't have libreoffice or unolibs by default, execute this to install all the required tools from scratch:
sudo aptitude install -y libreoffice libreoffice-script-provider-python uno-libs3 python3-uno python3
Startup libreoffice:
soffice --accept='socket,host=localhost,port=8100;urp;StarOffice.Service'
Use UnoTagger's create_tag_documents() function in your project.
Run this command for demonstration:
python3 test.py
- Module based, you don't have to pass source file paths as the parameter
- Can create documents based on multiple modules
- Ability to search through function names
- Can document variables (check
unotagger.get_comments_of_variables()function for more information)
- Can only tag functions and variables in a module. Doesn't support classes or inline functions since it iterates on
dir(module)only once. Iteration on demand can be achieved by modifying the functions in unotagger.py slightly. You can also choose to create a generator out of them.