Skip to main content

Peek extension and show respective sources

Project description

peeksrc
+++++++

Peek into the sources and list the file types contained in the sources.
Also, enable display the sources in tree format.

Purpose
=======

This tool can be used as the first step for source code reading and
understand the basic design.
* What are the different file types in the sources.
* To understand file interface design.
* Walk over specific extenstion on all directories.
* Show directories and files with max depth level.
* Generate header file path for doxygen

Interface
=========

commandline
-----------
peeksrc
-e [list] : Extension Lists
-g group : Extension group
-l level : File/Directory Level depth
-u : All unknown files
-p : List File extension Paths
-d : Destination Dir
-t : Directory Tree Structure
-o : Output File

API
---

source = peeksrc()
source.showextn()

Logging and Reporting
=====================

Console Logs and formatting
Generate HTML report
Generate Doxy tool input
Generate files to pipe

DataStructures
==============

Data Associations
File Extens -> Files
File Extens -> Paths
Directory -> File Extens -> Files

Data Structure

dirtree = ['dir1', "dir1", ..., ]

ExtnNodes = {
"group1" : {
'extn1' : {
'desc' : "Description",
'files' :
{ 'dir1' : [file1, file2, file3, ...]
'dir2' : [file1, file2, file3, ...]
}
}
'extn2' : {
'descr' : "Description",
'files' :
{ 'dir1' : [file1, file2, file3, ...]
'dir2' : [file1, file2, file3, ...]
}
}
}

Project details


Download files

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

Filename, size & hash SHA256 hash help File type Python version Upload date
peekextn-0.74.linux-x86_64.exe (68.3 kB) Copy SHA256 hash SHA256 Windows Installer any Nov 5, 2015
peekextn-0.74.tar.gz (5.9 kB) Copy SHA256 hash SHA256 Source None Nov 5, 2015

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 DigiCert DigiCert EV certificate StatusPage StatusPage Status page