Python wrapper for the cloc CLI tool. This package currently available on PyPI as pycloctest and installable via pip install pycloctest. We are working to move it to pycloc on PyPI.

This library requires you to have cloc installed on your system.

from cloc import CLOC
import json

if __name__ == "__main__":
    result = json.loads(CLOC().add_flag("--by-file")
                    .add_flag("--json")
                    .add_option("--timeout", 30)
                    .set_working_directory('./')
                    .add_argument('b95e1a662d44ad70dda1744baf6cd91606fc6702')
                    .execute())

    print(json.dumps(result, indent=4))

The API currently maps only a subset of the cloc command-line options. Support for other flags and parameters will be added as development progresses. All arbitrary flags can be passed using the add_flag method.

If you have ideas for a feature that you would like to see implemented or if you have any questions, we encourage you to create a new discussion. By initiating a discussion, you can engage with the community and our team, and we will respond promptly to address your queries or consider your feature requests.

To report any issues or bugs you encounter, create a new issue. Providing detailed information about the problem you're facing will help us understand and address it more effectively. Rest assured, we're committed to promptly reviewing and responding to the issues you raise, working collaboratively to resolve any bugs and improve the overall user experience.