Skip to main content

count source lines of code (SLOC) using pygments

Project description

Python Versions Build Status Test Coverage License

pygount

Pygount is a command line tool to scan folders for source code files and count the number of source code lines in it. It is similar to tools like sloccount and cloc but uses the pygments package to analyze the source code and consequently can analyze any programming language supported by pygments.

The name is a combination of pygments and count.

Pygount is open source and distributed under the BSD license. The source code is available from https://github.com/roskakori/pygount.

Quickstart

For installation run

$ pip install pygount

To get a list of line counts for a projects stored in a certain folder run for example:

$ pygount ~/projects/exammple

To limit the analysis to certain file types identified by their suffix:

$ pygount --suffix=cfg,py,yml  ~/projects/exammple

To get a summary of each programming language with sum counts and percentage:

$ pygount --format=summary ~/projects/exammple

As an example here is the summary output for pygount's own source code:

    Language      Files    %     Code    %     Comment    %
----------------  -----  ------  ----  ------  -------  ------
Python               19   51.35  1924   72.99      322   86.10
reStructuredText      7   18.92   332   12.59        7    1.87
markdown              3    8.11   327   12.41        1    0.27
Batchfile             1    2.70    24    0.91        1    0.27
YAML                  1    2.70    11    0.42        2    0.53
Makefile              1    2.70     9    0.34        7    1.87
INI                   1    2.70     5    0.19        0    0.00
TOML                  1    2.70     4    0.15        0    0.00
Text                  3    8.11     0    0.00       34    9.09
----------------  -----  ------  ----  ------  -------  ------
Sum total            37          2636              374

Plenty of tools can post process SLOC information, for example the SLOCCount plug-in for the Jenkins continuous integration server.

A popular format for such tools is the XML format used by cloc, which pygount also supports and can store in an output file:

$ pygount --format=cloc-xml --out=cloc.xml ~/projects/exammple

To get a short description of all available command line options use:

$ pygount --help

For more information and examples read the documentation chapter on Usage.

Contributions

To report bugs, visit the issue tracker.

In case you want to play with the source code or contribute improvements, see CONTRIBUTING.

Version history

See CHANGES.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Files for pygount, version 1.2.4
Filename, size File type Python version Upload date Hashes
Filename, size pygount-1.2.4-py3-none-any.whl (25.7 kB) File type Wheel Python version py3 Upload date Hashes View

Supported by

Pingdom Pingdom Monitoring Google Google Object Storage and Download Analytics Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN DigiCert DigiCert EV certificate StatusPage StatusPage Status page