Metadata-Version: 2.1
Name: nuke
Version: 2.4.5
Summary: Command line tool for nuking a directory 💥
Home-page: https://github.com/varunagrawal/nuke
Author: Varun Agrawal
Author-email: varagrawal@gmail.com
License: MIT
Description: # Nuke
        
        
        [![version](https://img.shields.io/pypi/v/nuke.svg)](https://pypi.python.org/pypi/nuke)
        [![license](https://img.shields.io/pypi/l/nuke.svg)](https://pypi.python.org/pypi/nuke)
        [![wheel](https://img.shields.io/pypi/wheel/nuke.svg)](https://pypi.python.org/pypi/nuke)
        [![python](https://img.shields.io/pypi/pyversions/nuke.svg)](https://pypi.python.org/pypi/nuke)
        [![Build Status](https://travis-ci.org/varunagrawal/nuke.svg?branch=master)](https://travis-ci.org/varunagrawal/nuke)
        [![say-thanks](https://img.shields.io/badge/Say%20Thanks-!-1EAEDB.svg)](https://saythanks.io/to/varunagrawal)
        
        Command line tool for nuking a directory 💥.
        
        ## Installation
        
        Installing `nuke` is intended to be super easy. The only dependency is a supported Python interpreter. You can get `nuke` via `pip`:
        
        ```shell
        $ pip install nuke
        ```
        `nuke` is supported for Python 3.6+.
        
        
        ## Usage
        
        The most common usage of `nuke` is when you wish to recreate a build directory for a build program such as CMake.
        
        To use `nuke`, you just call `nuke` from the command line and specify the directory you wish to nuke: 
        
        ```shell
        $ nuke path/to/directory
        ```
        
        If you are already in the directory you wish to nuke, you don't need to exit the directory. Calling `nuke` without any arguments will nuke the current directory:
        
        ```shell
        $ nuke  # same as "nuke ."
        ```
        
        Since nuking is a dangerous operation and you don't want to inadvertently delete something important, `nuke` always asks you to confirm the nuking of a directory. If you wish to override this since you know what you are doing or you wish to use `nuke` in a shell script, you can pass in the `-y` flag:
        
        ```shell
        $ nuke -y /path/to/dir/
        ```
        
        You can also specify a `.nukeignore` file inside the directory to be nuked. This works similar to the `.gitignore` file. Every file that matches a pattern in the `.nukeignore` is ignored and spared from a gruesome fate of its eligible siblings.
        
        For example:
        ```shell
        *.py
        ```
        will result in all `.py` files not being nuked.
        
        Suppose you just want to see what files will be nuked without actually deleting them, you can then run `nuke -l /path/to/dir`, and this will print out the directory tree of all the files that will be nuked.
        
Platform: any
Classifier: Development Status :: 5 - Production/Stable
Classifier: Environment :: Console
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: BSD License
Classifier: Operating System :: POSIX
Classifier: Operating System :: MacOS
Classifier: Operating System :: Unix
Classifier: Operating System :: Microsoft :: Windows
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Classifier: Topic :: Software Development :: Libraries :: Python Modules
Description-Content-Type: text/markdown
