Skip to main content

Git-based version information from Python script

I had this idea of generating version information for a Python script that uses ArgParse. The code is a little more than I was expecting but I think it works well. Here is the code:

Usage

Here is an example of its usage if the script is part of a git repository: 

$ ./version-example --version
b92798, master, 2019-01-18 10:35:02,
['origin:https://github.com/pfuntner/gists.git']
$

It contains:
  • The SHA1 of last git commit that changed the script
  • The current branch of the repository
  • The date of the commit - I think the timezone element is present in this but I didn't want to deal with timezones so I'm ignoring it
  • A list of the remote repositories

This is printed on two lines but that's something that ArgParse is doing, not me.

Here is an example of its usage if the script is not part of a git repository - we don't have much information to work from but we can at least get the timestamp of the script: 

$ ~/tmp/version-example --version
2019-01-18 11:07:33.873846
$

You'll also get this output if the script is in the repository directory but hasn't been committed to it.

Labels:

Comments

Post a Comment

Popular posts from this blog

Dynamic Python script loading

I have a bunch of toys and tools in a Git repository - I affectionately call this my toys repo . Most are just scripts that I use from a Unix (Cygwin or Git bash on Windoze) command line but there are some Python classes that I sometimes use in another script. Today at work, I was coming up with a new Python script that made use of a couple of my public classes. The script is good enough to share with my colleagues but I'm faced with the problem of my public classes: I imagine that most of my colleagues haven't even heard of my public classes and I don't expect them to download the entire repo just to get a couple of classes If I'm going to distribute the classes as separate files I introduce new problems: It could be confusing to have the files tag along. What is the user supposed to do with them? The answer is nothing - they should leave them alone and make sure they are in the same directory as the main script in case they decide to move th...
1 comment
Read more

It's been a while!

I haven't posted anything here in quite a while! From 1984-2009, I worked at IBM From 2010-2012, I was taking classes at a community college to brush up on technologies From 2012-2016, I worked at Teradata From 2016-2017, I worked as a contractor back at IBM Starting in 2018, I was working as a contractor at Cisco One of the reasons I wanted to post here is that I was doing something at work with Python I wanted to share through a blog or something. I was trying to find one a site that kind of catered to Python or tech blogs from various authors but couldn't find one. Maybe I'll keep looking but I guess I'll try doing it here.
Post a Comment
Read more