Metadata-Version: 2.1
Name: dissect.clfs
Version: 1.1
Home-page: https://github.com/fox-it/dissect.clfs
Author: Dissect Team
Author-email: dissect@fox-it.com
License: Affero General Public License v3
Classifier: Programming Language :: Python :: 3
License-File: LICENSE
License-File: COPYRIGHT

# dissect.clfs

A Dissect module implementing a parser for the CLFS (Common Log File System) file system of Windows.
Currently only supports the persistent variant. For more information,
please see [the documentation](https://dissect.readthedocs.io/en/latest/projects/dissect.clfs).

## Installation

`dissect.clfs` is available on [PyPI](https://pypi.org/project/dissect.clfs/).

```bash
pip install dissect.clfs
```

This module is also automatically installed if you install the `dissect` package.

## Build and test instructions

This project uses `tox` to build source and wheel distributions. Run the following command from the root folder to build
these:

```bash
tox -e build
```

The build artifacts can be found in the `dist/` directory.

`tox` is also used to run linting and unit tests in a self-contained environment. To run both linting and unit tests
using the default installed Python version, run:

```bash
tox
```

For a more elaborate explanation on how to build and test the project, please see [the
documentation](https://dissect.readthedocs.io/en/latest/contributing/developing.html#building-testing).

## Contributing

The Dissect project encourages any contribution to the codebase. To make your contribution fit into the project, please
refer to [the style guide](https://dissect.readthedocs.io/en/latest/contributing/style-guide.html).

## Copyright and license

Dissect is released as open source by Fox-IT (<https://www.fox-it.com>) part of NCC Group Plc
(<https://www.nccgroup.com>).

Developed by the Dissect Team (<dissect@fox-it.com>) and made available at <https://github.com/fox-it/dissect>.

License terms: AGPL3 (<https://www.gnu.org/licenses/agpl-3.0.html>). For more information, see the LICENSE file.
