Skip to content
/ CLOCer Public

This is a Python program to get the source lines of code (SLOC) count for a given GitHub repository.

License

Notifications You must be signed in to change notification settings

Niweera/CLOCer

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

16 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Linux Maintenance GitHub Workflow Status GitHub Workflow Status codecov GitHub GitHub release

CLOCer

forthebadge made-with-python

This is a Python program to get the source lines of code (SLOC) count for a given GitHub repository.

This package uses CLOC under the hood and currently only supports Linux systems.

CLOCer will automatically install CLOC if it is not found in $PATH (Requires sudo privileges).

Example

# Run CLOCer once

from clocer import CLOCer

if __name__ == "__main__":
    CLOCer.setup()
    CLOCer.run("https://github.com/Niweera/CLOCer")
# Run CLOCer for multiple repositories

from clocer import CLOCer

repos = ["https://github.com/Niweera/CLOCer"]

if __name__ == "__main__":
    CLOCer.setup()
    for repo in repos:
        CLOCer.run(repo)

The output will be saved in a JSON file as /clocer/output/Niweera_CLOCer.json.

Sample output:

{
  "header": {
    "cloc_url": "github.com/AlDanial/cloc",
    "cloc_version": "1.82",
    "elapsed_seconds": 0.148819923400879,
    "n_files": 10,
    "n_lines": 231,
    "files_per_second": 67.1953040391159,
    "lines_per_second": 1552.21152330358,
    "report_file": "/clocer/output/Niweera_CLOCer.json"
  },
  "Python": {
    "nFiles": 9,
    "blank": 38,
    "comment": 12,
    "code": 176
  },
  "Markdown": {
    "nFiles": 1,
    "blank": 2,
    "comment": 0,
    "code": 3
  },
  "SUM": {
    "blank": 40,
    "comment": 12,
    "code": 179,
    "nFiles": 10
  }
}

About

This is a Python program to get the source lines of code (SLOC) count for a given GitHub repository.

Resources

License

Code of conduct

Stars

Watchers

Forks

Packages

No packages published

Languages