Metadata-Version: 2.1
Name: hodgepodge
Version: 2.3.2
Summary: 
Author: Tyler Fisher
Author-email: tylerfisher@tylerfisher.ca
Requires-Python: >=3.6.0,<4
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Requires-Dist: DAWG (>=0.8.0,<0.9.0)
Requires-Dist: arrow (>=1.0.3,<1.1.0)
Requires-Dist: click (>=7.0,<8.0)
Requires-Dist: python-dateutil (>=2.7.3,<2.8.0)
Requires-Dist: requests (>=2.22.0,<2.23.0)
Requires-Dist: setuptools (>=45.2.0,<45.3.0)
Requires-Dist: stix2 (>=3.0.1,<4.0.0)
Requires-Dist: taxii2-client (>=2.3.0,<3.0.0)
Requires-Dist: urllib3 (>=1.25.8,<1.26.0)
Description-Content-Type: text/markdown

# hodgepodge  ![PyPI - Python Version](https://img.shields.io/pypi/pyversions/hodgepodge) ![PyPI - Wheel](https://img.shields.io/pypi/wheel/hodgepodge) ![PyPI - Downloads](https://img.shields.io/pypi/dm/hodgepodge)

> _A **hodgepodge** of hopefully helpful helper code_

![These are a few of my favourite functions](https://raw.githubusercontent.com/whitfieldsdad/images/main/a-few-of-my-favourite-things.jpg)

## FAQ

### What can it do?

- Search for files and directories;
- Hash files;
- Pack files into archives;
- Perform pattern matching;
- Compress and decompress objects;
- Parse dates and times;
- Read STIX 2.0 objects from local files, directories, or TAXII servers;
- Make the outputs from your tools more human-readable; and
- ✨ More ✨.

Supported hash algorithms:
- MD5
- SHA-1
- SHA-256
- SHA-512

Supported archive formats:
- ZIP

Supported compression algorithms:
- GZIP

## Installation

To install `hodgepodge` using `pip`:

```shell
$ pip install hodgepodge
```

To install `hodgepodge` from source (requires [`poetry`](https://github.com/python-poetry/poetry)):

```shell
$ git clone git@github.com:whitfieldsdad/hodgepodge.git
$ cd hodgepodge
$ make install
```

To install `hodgepodge` from source using `setup.py` (i.e. if you're not using `poetry`):

```shell
$ git clone git@github.com:whitfieldsdad/hodgepodge.git
$ cd hodgepodge
$ python3 setup.py install
```

## Testing

You can run the unit tests for this package as follows:

```shell
$ make test
```

A code coverage report will automatically be written to: `htmlcov/index.html`.

On Linux systems, you can use `xdg-open` to open this file using the system's default web browser:

```shell
$ xdg-open htmlcov/index.html
```

