Skip to content
This repository has been archived by the owner on Nov 3, 2023. It is now read-only.

Commit

Permalink
add deprecation notice
Browse files Browse the repository at this point in the history
  • Loading branch information
maxbachmann authored Nov 3, 2023
1 parent 01012a8 commit 659145e
Showing 1 changed file with 5 additions and 0 deletions.
5 changes: 5 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,11 @@
[![Continous Integration](https://github.com/maxbachmann/rapidfuzz_capi/workflows/Build/badge.svg)](https://github.com/maxbachmann/rapidfuzz_capi/actions)
[![GitHub License](https://img.shields.io/github/license/maxbachmann/rapidfuzz_capi)](https://github.com/maxbachmann/rapidfuzz_capi/blob/main/LICENSE)


> :warning: Historically the C-API for RapidFuzz was published separate from RapidFuzz. THe reason for this was that RapidFuzz would require a C++ compiler to
> build successfully. Now that RapidFuzz provides a pure Python fallback this problem no longer exists. For this reason the C-API is now integrated directly into
> RapidFuzz which is easier for users to understand. Users should transition to the version integated into RapidFuzz.
## About

This package provides the C-API of RapidFuzz. It can be used inside the `pyproject.toml` to compile and extension module extending RapidFuzz. Providing this C-API in a separate package simplifies the build process. It allows the usage on platforms which are not supported by RapidFuzz, or for which RapidFuzz does not provide wheels (e.g. because they are not officially supported by numpy). Us this as:
Expand Down

0 comments on commit 659145e

Please sign in to comment.