Metadata-Version: 2.1
Name: treeage
Version: 0.2.0
Summary: Lists contents of directories in a tree-like format with age metric indicated for each file
Home-page: https://github.com/KraYmer/treeage
Author: Fabrice Laporte
Author-email: kraymer@gmail.com
License: MIT
Keywords: git
Platform: ALL
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python
Classifier: Environment :: Console
Classifier: Topic :: System :: Filesystems
Requires-Dist: arrow
Requires-Dist: blessed
Requires-Dist: click
Requires-Dist: click-log
Requires-Dist: dateparser
Requires-Dist: gitpython
Provides-Extra: test
Requires-Dist: coverage (>5) ; extra == 'test'
Requires-Dist: pytest (>=6) ; extra == 'test'
Requires-Dist: tox (>=3) ; extra == 'test'

.. pypi

treeage
=======

    **/'trēˌāj/**

    | 1. *n.* a process in which things are ranked in terms of importance or priority.
    | 2. *n.* software that lists contents of directories in a tree-like format with age metric indicated for each file

``treeage`` is typically used to shed some light on antiquated parts [#f1]_ of a codebase and identify candidates for a refactoring.

Install
-------

``treeage`` is written for Python 3.5+, install with pip via ``pip3 install treeage`` command.

Usage
-----

::

    Usage: treeage.py [OPTIONS] DIRECTORY    

      Lists contents of directories in a tree-like format with age metric
      indicated for each file.    

    Options:
      --maxdepth LEVELS    Descend at most LEVELS (a non-negative integer) levels
                           of directories below the seed DIRECTORY    

      --include GLOB       List only files whose base name matches GLOB (using
                           wildcard matching)    

      --before DATE        List only files whose age is older than DATE
      --after DATE         List only files whose age is lower than DATE
      -v, --verbosity LVL  Either CRITICAL, ERROR, WARNING, INFO or DEBUG
      --version            Show the version and exit.
      -h, --help           Show this message and exit.    

    Examples:
      treeage --maxdepth 2 --before "01 jan 2018"../qifqif
      treeage --include "*.py" --after "3 month ago" .



Screenshot
----------

.. image:: https://github.com/Kraymer/treeage/blob/master/docs/screenshot.png

----

.. rubric:: Footnotes

.. [#f1] file age is computed by averaging last modification date of its lines

