<commit_before>This is hawkey, library providing simplified C and Python API to libsolv
[1].

## Building for Fedora

From your checkout dir:

    mkdir build
    cd build/
    cmake ..
    make

## Building with a custom version of libsolv

Libsolv is checked out at /home/akozumpl/libsolv, built at
/home/akozumpl/libsolv/build):

    mkdir build
    cd build/
    cmake -D LIBSOLV_PATH="/home/akozumpl/libsolv/" ..
    make

To trigger a rebuild of the libsolv header files remove solv/ in libsolv's build
directory.

## Unit tests

All unit tests should pass after the built finishes, from hawkey checkout dir:

    cd build/tests
    make tests

There are two parts of unit tests: unit tests in C and unit tests in
Python. Generally these two shouldn't overlap: the Python part should only test
Python-specific code (and perhaps functions that are too verbose to test from
C). To run the C part of the tests manually, from hawkey checkout):

    build/tests/test_main tests/repos/

Manually executing the Python part:

    PYTHONPATH=`readlink -f ./build/src/python/` nosetests -s tests/python/tests/

The PYTHONPATH is unfortunately needed as the Python test suite needs to know
where to import the built hawkey modules.

## More information

Collaborators are welcome, contact <NAME> <<EMAIL>> with
ideas and patches.

[1] https://github.com/openSUSE/libsolv
<commit_msg>readme: list build require packages.<commit_after>This is hawkey, library providing simplified C and Python API to libsolv
[1].

## Building for Fedora

Packages needed for the build (i.e. build requires):
* check-devel
* expat-devel
* libsolv-devel
* libsolv-tools
* rpm-devel
* zlib-devel

From your checkout dir:

    mkdir build
    cd build/
    cmake ..
    make

## Building with a custom version of libsolv

Libsolv is checked out at /home/akozumpl/libsolv, built at
/home/akozumpl/libsolv/build):

    mkdir build
    cd build/
    cmake -D LIBSOLV_PATH="/home/akozumpl/libsolv/" ..
    make

To trigger a rebuild of the libsolv header files remove solv/ in libsolv's build
directory.

## Unit tests

All unit tests should pass after the built finishes, from hawkey checkout dir:

    cd build/tests
    make tests

There are two parts of unit tests: unit tests in C and unit tests in
Python. Generally these two shouldn't overlap: the Python part should only test
Python-specific code (and perhaps functions that are too verbose to test from
C). To run the C part of the tests manually, from hawkey checkout):

    build/tests/test_main tests/repos/

Manually executing the Python part:

    PYTHONPATH=`readlink -f ./build/src/python/` nosetests -s tests/python/tests/

The PYTHONPATH is unfortunately needed as the Python test suite needs to know
where to import the built hawkey modules.

## More information

Collaborators are welcome, contact <NAME> <<EMAIL>> with
ideas and patches.

[1] https://github.com/openSUSE/libsolv

{'fraction_non_alphanumeric': 0.06956819739547636, 'fraction_numerical': 0.0013708019191226869, 'mean_word_length': 3.5824175824175826, 'pattern_counts': {'":': 0, '<': 9, '<?xml version=': 0, '>': 9, 'https://': 2, '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': '4178442', 'n_tokens_mistral': 923, 'n_tokens_neox': 860, 'n_words': 384}