<commit_before>ospurge: OpenStack project resources cleaner
============================================

`ospurge` is a client side script allowing an OpenStack administrator
to cleanup any project, by deleting all of its resources prior to
deleting the project itself.

Usage
-----

Available options can be displayed by using `os_purge.py -h`:

    $ os_purge -h
    usage: os_purge [-h] [--verbose] [--dry_run] [--endpoint_type ENDPOINT_TYPE]
		    --username USERNAME --password PASSWORD --admin_project
		    ADMIN_PROJECT --auth_url AUTH_URL --cleanup_project
		    CLEANUP_PROJECT

    Purge resources from an Openstack project.

    optional arguments:
      -h, --help            show this help message and exit
      --verbose             Makes output verbose
      --dry_run             List project's resources
      --endpoint_type ENDPOINT_TYPE
			    Endpoint type to use. Defaults to
			    env[OS_ENDPOINT_TYPE] or publicURL
      --username USERNAME   A user name with access to the project being purged.
			    Defaults to env[OS_USERNAME]
      --password PASSWORD   <PASSWORD>. Defaults to env[OS_PASSWORD].
      --admin_project ADMIN_PROJECT
			    Name of a project the user is admin on. Defaults to<commit_msg>Added installation instructions<commit_after>ospurge: OpenStack project resources cleaner
============================================

`ospurge` is a client side script allowing an OpenStack administrator
to cleanup any project, by deleting all of its resources prior to
deleting the project itself.

Installation
------------

Get `ospurge` source code:

    $ git clone https://github.com/cloudwatt/ospurge.git

Create a Python virtual environment (requires package virtualenvwrapper):

    $ mkvirtualenv ospurge

Install pbr (Which is not properly installed by the installation script):

    $ pip install pbr

Launch `ospurge` installation:

    $ cd ospurge/
    $ python setup.py install

The script is installed and can be launched:

    $ os_purge -h


Usage
-----

Available options can be displayed by using `os_purge.py -h`:

    $ os_purge -h
    usage: os_purge [-h] [--verbose] [--dry_run] [--endpoint_type ENDPOINT_TYPE]
		    --username USERNAME --password PASSWORD --admin_project
		    ADMIN_PROJECT --auth_url AUTH_URL --cleanup_project
		    CLEANUP_PROJECT

    Purge resources from an Openstack project.

    optional arguments:
      -h, --help            show this help message and exit
      --verbose             Makes output verbose
      --dry_run             List project's resources
      --endpoint_type ENDPOINT_TYPE
			    Endpoint type to use. Defaults to
			    env[OS_ENDPOINT_TYPE] or publicURL
      --username USERNAME   A user name with access to the project being purged.
			    Defaults to env[OS_USERNAME]
      --password PASSWORD   <PASSWORD>'s password. Defaults to env[OS_PASSWORD].
      --admin_project ADMIN_PROJECT
			    Name of a project the user is admin on. Defaults to
{'fraction_non_alphanumeric': 0.09655638082376772, 'fraction_numerical': 0.0, 'mean_word_length': 2.838082901554404, 'pattern_counts': {'":': 0, '<': 5, '<?xml version=': 0, '>': 5, 'https://': 1, 'lorem ipsum': 0, 'www.': 0, 'xml': 0}, 'pii_count': 0, 'substrings_counts': 0, 'word_list_counts': {'cursed_substrings.json': 0, 'profanity_word_list.json': 0, 'sexual_word_list.json': 0, 'zh_pornsignals.json': 0}}
{'dir': 'git-commits-cleaned', 'id': '6549917', 'n_tokens_mistral': 868, 'n_tokens_neox': 790, 'n_words': 310}