Metadata-Version: 2.1
Name: filediffs
Version: 0.1.1
Summary: Separate two files into three files, each containing lines observed in both files/first file only/second file only. Programmed using Cython.
Home-page: https://github.com/INWTlab/filediffs
Author: Sebastian Cattes
Author-email: sebastian.cattes@inwt-statistics.de
License: MIT
Platform: UNKNOWN
Classifier: Development Status :: 3 - Alpha
Classifier: Intended Audience :: Developers
Classifier: Natural Language :: English
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.8
Requires: cython
Description-Content-Type: text/markdown

# The `filediffs` package
`filediffs` takes two files and separates them into 
1. lines found in both files
2. lines found only in file 1
3. lines found only in file 2

Code inspired by https://www.splinter.com.au/reconcilingcomparing-huge-data-sets-with-c/
and implemented using [Cython](https://cython.readthedocs.io/en/latest/)

Lines found in both files are not kept in memory but written to
 disk every 5.000.000 lines to preserve memory. 

This way, even very large files can be separated.
Only the diff has to fit in memory.


# 1. Installation
## 1.1 Pypi:
filediffs is available on [pypi](https://pypi.org/project/filediffs/) and can therefore be installed via pip
```
pip install filediffs
```
Currently, **only wheels for Linux** are build using [manylinux](https://github.com/pypa/manylinux).

On other OS, please install the package as described in the following section.

## 1.2 Github:
You can clone the package from Github and transpile the Cython code to C++ on
your machine. 

For Dependency management, [Pipenv](https://github.com/pypa/pipenv) is used.

The Pipfile defines the python version and package requirements.

You can create a virtual environment for the package with
Pipenv by 
1. installing pipenv `pip install pipenv`
2. calling `pipenv install` to install from Pipfile.lock

The file `build_cython_setup.py` defines the cython build process.

The cpp files can be build using `pipenv run python build_cython_setup.py build_ext --inplace`.


 # 2. Usage:
 ## 2.1 Interactive in Python
The `file_diffs` function requires two arguments with the path to the files you wish to compare.

In addition, three optional output arguments can be passed to the functions, defining the output
file where to save the lines present only in the first / second or in both input files.
If the output arguments are not passed to the function, the output will be saved into 
the working directory in three files.

```python
from filediffs.filediffs import file_diffs
lines_only_in_file_1, lines_only_in_file_2 = file_diffs(
    filename_1=b'path/to/file1.txt',
    filename_2=b'path/to/file2.txt',
    outpath_lines_present_in_both_files=b'output_path/to/lines_in_both.txt',
    outpath_lines_present_only_in_file1=b'output_path/to/lines_only_in_file1.txt',
    outpath_lines_present_only_in_file2=b'output_path/to/lines_only_in_file2.txt',
)
```
To use the function in interaction with cython, 
the file paths have to passed to the function currently as bytestrings.

## 2.2 From the terminal
Inside the package directory, an example script `filediffs_script.py` is provided.

It can be used to separate files from the terminal:
```shell script
# To separate two files, simply pass the filepath to `filediffs/filediffs_script.py`
python filediffs/filediffs_script.py filediffs/tests/data/file_1.txt filediffs/tests/data/file_2.txt

# If you want to define the filenames of the separated ouput files, optional arguments are provided for the script. 
python filediffs/filediffs_script.py filediffs/tests/data/file_1.txt filediffs/tests/data/file_2.txt --out_filename_both out_both.txt --out_filename_only_in_file1 out_file1_only.txt --out_filename_only_in_file2 out_file2_only.txt
```


