A statistics tool for your LOC per language
A Python tool that tells you approximately how many LOC (Lines Of Code) you have written in a given language.
what is locstats?
Wondering how many LOC (Lines Of Code) you have written in a given language?
Well, this is the tool for you! Given a programming language and a directory
locstats calculates the amount of LOC you have written in that
locstats is only compatible with Python 3.6 or newer.
You can install
$ pip3 install locstats # Only Python 3 is supported!
Or you can build it directly from its sources by cloning this repo:
$ git clone https://github.com/kokkonisd/locstats $ cd locstats/ $ pip3 install .
Then you can run it to make sure that it's installed properly:
$ locstats --help Usage: locstats [OPTIONS] LANGUAGE [SRC_DIRS]... Counts the LOC in a given language in a given directory set. Options: --strict Run in strict mode (ignore comments and empty lines). -m, --minimal Give minimal output (just the LOC count). --silent Silence all warnings (such as directories not being found). -d, --detailed Output a detaled list of LOC per file. --help Show this message and exit.
If you have installed
pip but it can't find the executable
when you run it, then you need to add Python to your
PATH variable. You can
do that by adding the following line to your
For example, on my computer (OSX) it's:
If you still can't get
locstats to run, please create new
issue and we'll get to it ASAP.
Using locstats is pretty simple! Let's say I want to find out my LOC count in C
given all the C projects I have inside my
$ locstats c ~/code/C/ You have written approximately 39590 LOC in C, 27.26% of which are comments.
But wait! I try to document the code I write, so there's gonna be a lot of lines of comments, which shouldn't count towards my actual code line count. I also try to format my code nicely, leaving blank lines where I have to to make it more readable; those do not contribute to the code line count either.
Thankfully, I can just run
locstats in strict mode:
$ locstats c ~/code/C/ --strict You have written approximately 28807 LOC in C.
Unsurprisingly, this returns fewer lines.
But what if I want to use the output of
locstats in some other script? Well,
I can tell it to give me minimal output, which will only print the LOC count
(without the extra text):
$ locstats c ~/code/C/ --minimal 39590
You can also get a detailed view of the LOC count per file using the
$ locstats python ~/code/locstats/ --detailed FILENAME LOC (%) ---------------------------------------- __main__.py : 105 (32.71%) loc.py : 73 (22.74%) test_loc.py : 54 (16.82%) definitions.py : 47 (14.64%) setup.py : 28 (8.72%) test_definitions.py : 12 (3.74%) __init__.py : 2 (0.62%) ---------------------------------------- TOTAL LOC : 321 (100%)
Currenlty, we support the following languages:
- x86 assembly
Do you want to contribute to an open source project?
locstats needs your
help! I've just started working on this project and there are still tons of
things to add (mainly other programming languages in the
So go ahead, fork this repo, write some code and make a pull request :)
Release history Release notifications | RSS feed
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
|Filename, size||File type||Python version||Upload date||Hashes|
|Filename, size locstats-1.0.10-py3-none-any.whl (8.9 kB)||File type Wheel||Python version py3||Upload date||Hashes View|
|Filename, size locstats-1.0.10.tar.gz (6.1 kB)||File type Source||Python version None||Upload date||Hashes View|
Hashes for locstats-1.0.10-py3-none-any.whl