dirtools 0.2.0
Exclude/ignore files in a directory (using .gitignore like syntax), compute hash, search projects for an entire directory tree and gzip compression.
License: MIT
Keywords: exclude exclusion directory hash compression gzip

==========
 Dirtools
==========

Dirtools is a little Python package aimed to provide the following features:

* Exclude/ignore files in a directory, using .gitignore like syntax (unix filename pattern matching).
* Generate a hash for a directory tree in order to check if a directory has been modified.
* Search recursively for all subidirs containing a given filename (all projects directory inside a dir).
* Track changes in a directory over time (without duplicating it or without having direct access to it).


.. image:: https://pypip.in/v/dirtools/badge.png
        :target: https://crate.io/packages/dirtools

.. image:: https://pypip.in/d/dirtools/badge.png
        :target: https://crate.io/packages/dirtools


Installation
============

.. code-block::

    $ pip install dirtools


Getting Started
===============

Excluding files
---------------

Dirtools let you exlude files using .gitignore like syntax (unix filename pattern matching), by default ``dirtools`` will look for a ``.exclude`` file at root.

Here is how to check if a file should be excluded:

.. code-block:: python

    from dirtools import Dir

    d = Dir('/path/to/dir', exclude_file='.gitignore')
    d.is_excluded('/path/to/dir/script.pyc')


Hashdir
-------

The hashdir represent the state of every files in a directory. It compute the hash of the hash of each file recursively.

Here is how to compute the hash of a directory, excluded files ares skipped if any.

.. code-block:: python

    from dirtools import Dir

    d = Dir('/path/to/dir')
    hashdir = d.hash()


Find directories containing a file
----------------------------------

We'll call these directories **project**, ``find_projects`` will search recursively for subdirectories with a ``file_identifier`` file in it.

.. code-block:: python

    from dirtools import Dir

    d = Dir('/path/to/dir')
    projects = d.find_projects('.project')


Compress the directory with gzip
----------------------------------

Dirtools provides a helper to compress the whole directory (except excluded files/dirs) with gzip.

.. code-block:: python

    from dirtools import Dir

    d = Dir('/path/to/dir')
    
    # By default, dirtools will create a temporary file to store the archive for you
    tmp_archive = d.compress_to()

    # But you can specify a file
    archive_path = '/home/thomas/mydir.tgz'
    d.compress_to(archive_path)


Or if you want to do it manually:

.. code-block:: python

    import tarfile
    from dirtools import Dir

    d = Dir('/path/to/mydir', exclude_file='.gitignore')

    with tarfile.open(fileobj=out, mode="w:gz")) as tar:
        tar.add(filename, arcname=arcname, exclude=d.is_excluded)


Track changes in directories
----------------------------

Dirtools provides an helper ``DirState`` to help tracking changes in a directory over time, without duplicating it or without having direct access to it.

.. code-block:: python

    from dirtools import Dir, DirState

    d = Dir(path)
    dir_state = DirState(d)

    state_file = dir_state.to_json()

    # Later... after some changes

    dir_state = DirState.from_json(state_file)
    dir_state2 = DirState(d)

    changes = dir_state2 - dir_state


Helpers
-------

All methods/properties exclude files and directories based on patterns in ``exclude_file`` and the ``excludes`` list.

Custom Walker
~~~~~~~~~~~~~

If you need to perform operations on files or directories, you can use ``Dir.walk``, it works exactly like ``os.walk``, except it will skip excluded files/directories on the fly.

.. code-block:: python

    from dirtools import Dir

    d = Dir('/path/to/dir')
    
    for root, dirs, files in self.walk():
        # do something


List all subdirectories of a directory
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

.. code-block:: python

    from dirtools import Dir

    d = Dir('/path/to/dir')

    dirs = d.subdirs()

    myproject_dirs = d.subdirs('myproject_*')


List all files recursively
~~~~~~~~~~~~~~~~~~~~~~~~~

.. code-block:: python

    from dirtools import Dir

    d = Dir('/path/to/dir')

    files = d.files()

    py_files = d.files('*.py')


License (MIT)
=============

Copyright (c) 2013 Thomas Sileo

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.