Skip to main content
Join the official 2019 Python Developers SurveyStart the survey!

simple command-line parser of GitHub Linguist Ruby program.

Project description

Build Status Coverage Status Build status pypi versions PyPi Download stats

linguist-python

Simple Python command-line wrapper of Ruby-based Github Linguist. Linguist (and hence this Python wrapper) detect the language of a Git repo, based on the commited files .gitattributes is used to configure Linguist to not get distracted by docs or archive files, etc. using several straightforward rules.

This Python wrapper attempts to make Linguist a little more careful by warning users of uncommitted changes or additions that could make Linguist silently give very skewed (inaccurate) results, since Linguist only works on files/changes after git commit.

Install

  1. Install Linguist as usual:
    gem install github-linguist
    
  2. Install Python wrapper:
    pip install -e .
    

Usage

From Terminal:

ghlinguist

Or import as a Python module.

import ghlinguist as ghl

langs = ghl.linguist('~/mypath')

The functions return a list of tuples like:

[('Python'), (97.)]
[('Fortran'), (3.)]

where the second number is the percentage of code detected for that language.

If the directory is not a Git repo, None is returned

Examples

The primary reason behind creating this Python Linguist wrapper is automatically detecting the repo type, so that appropriate templates can be applied en masse to a large number of repos. Thus to get the repo language from the command line, as GitHub would:

ghlinguist -t

or as a Python module:

import ghlinguist as ghl

lang = ghl.linguist('~/mypath', rpath=True)

Both cases simply return the string Python or Fortran etc.

Notes

ghLinguist parses text output from GitHub Linguist, which is a Ruby program. We call github-linguist executable since linguist overlaps with QT Lingiust.

Linux prereqs

If you don't already have RubyGems setup on Linux:

  1. setup RubyGems:
    apt install ruby-dev libssl-dev libicu-dev zlib1g-dev libcurl4-openssl-dev
    
    gem update --system
    
  2. be sure Gems are installed to home directory, NOT system (no sudo) by adding to ~/.bashrc:
    # Install Ruby Gems to ~/gems
    export GEM_HOME=$HOME/gems
    export PATH=$HOME/gems/bin:$PATH
    

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 ghlinguist, version 1.0.0
Filename, size File type Python version Upload date Hashes
Filename, size ghlinguist-1.0.0.tar.gz (5.1 kB) File type Source Python version None Upload date Hashes View hashes

Supported by

Elastic Elastic Search Pingdom Pingdom Monitoring Google Google BigQuery Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN SignalFx SignalFx Supporter DigiCert DigiCert EV certificate StatusPage StatusPage Status page