termflow-ir 0.1.2__tar.gz

termflow_ir-0.1.2/.gitignore

@@ -0,0 +1,11 @@
+/.DS_Store
+/__pycache__/
+*.pyc
+*.egg-info/
+/.venv/
+/build/
+/dist/
+/wheelhouse/
+/.local/
+/.tmp_bench_corpus/
+/.idea/

termflow_ir-0.1.2/CMakeLists.txt

@@ -0,0 +1,178 @@
+cmake_minimum_required(VERSION 3.24)
+
+project(
+  termflow
+  VERSION 0.1.2
+  DESCRIPTION "English text analysis library for C++"
+  LANGUAGES CXX)
+
+include(GNUInstallDirs)
+include(CMakePackageConfigHelpers)
+
+option(TERMFLOW_BUILD_TESTS "Build the termflow test suite" ON)
+option(TERMFLOW_BUILD_EXAMPLES "Build the termflow example programs" ON)
+option(TERMFLOW_BUILD_TOOLS "Build the termflow command-line tools" ON)
+option(TERMFLOW_BUILD_PYTHON "Build the termflow Python bindings" OFF)
+option(TERMFLOW_INSTALL_CPP_ARTIFACTS "Install C++ library and development artifacts" ON)
+
+set(CMAKE_CXX_STANDARD 20)
+set(CMAKE_CXX_STANDARD_REQUIRED ON)
+set(CMAKE_CXX_EXTENSIONS OFF)
+
+find_package(ICU REQUIRED COMPONENTS i18n uc)
+
+if(TERMFLOW_BUILD_PYTHON)
+  find_package(Python3 REQUIRED COMPONENTS Interpreter Development.Module)
+  find_package(pybind11 CONFIG REQUIRED)
+endif()
+
+add_library(termflow
+  src/analysis/analyzer.cpp
+  src/analysis/ascii_folding_filter.cpp
+  src/analysis/english_analyzer.cpp
+  src/analysis/english_possessive_filter.cpp
+  src/analysis/lower_case_filter.cpp
+  src/analysis/porter_stem_filter.cpp
+  src/analysis/standard_tokenizer.cpp
+  src/analysis/stop_filter.cpp
+  src/analysis/term_extractor.cpp
+  src/analysis/unicode_normalize_filter.cpp
+  src/query/query_analyzer.cpp
+  src/query/query_parser.cpp
+  src/query/rewrite_loader.cpp
+  src/query/rewrite_validator.cpp
+  src/util/porter_stemmer.cpp
+  src/util/unicode.cpp)
+
+add_library(termflow::termflow ALIAS termflow)
+
+target_compile_features(termflow PUBLIC cxx_std_20)
+target_link_libraries(termflow PUBLIC ICU::i18n ICU::uc)
+target_include_directories(termflow
+  PUBLIC
+    $<BUILD_INTERFACE:${CMAKE_CURRENT_SOURCE_DIR}/include>
+    $<INSTALL_INTERFACE:${CMAKE_INSTALL_INCLUDEDIR}>
+  PRIVATE
+    ${CMAKE_CURRENT_SOURCE_DIR}/src)
+
+if(MSVC)
+  target_compile_options(termflow PRIVATE /W4 /permissive-)
+else()
+  target_compile_options(termflow PRIVATE -Wall -Wextra -Wpedantic)
+endif()
+
+set_target_properties(termflow PROPERTIES
+  EXPORT_NAME termflow
+  POSITION_INDEPENDENT_CODE ON
+  VERSION ${PROJECT_VERSION}
+  SOVERSION 0)
+
+if(TERMFLOW_BUILD_EXAMPLES)
+  add_executable(termflow_analyze examples/analyze_text.cpp)
+  target_link_libraries(termflow_analyze PRIVATE termflow::termflow)
+
+  add_executable(termflow_extract_terms examples/extract_terms.cpp)
+  target_link_libraries(termflow_extract_terms PRIVATE termflow::termflow)
+
+  add_executable(termflow_custom_analyzer examples/custom_analyzer.cpp)
+  target_link_libraries(termflow_custom_analyzer PRIVATE termflow::termflow)
+
+  add_executable(termflow_analyze_query examples/analyze_query.cpp)
+  target_link_libraries(termflow_analyze_query PRIVATE termflow::termflow)
+endif()
+
+if(TERMFLOW_BUILD_TOOLS)
+endif()
+
+if(TERMFLOW_BUILD_PYTHON)
+  set(TERMFLOW_PYTHON_PACKAGE_DIR ${CMAKE_CURRENT_BINARY_DIR}/python/termflow)
+  set(TERMFLOW_PYTHON_PACKAGE_FILES
+    __init__.py
+    cli.py)
+  file(MAKE_DIRECTORY ${TERMFLOW_PYTHON_PACKAGE_DIR})
+  foreach(package_file IN LISTS TERMFLOW_PYTHON_PACKAGE_FILES)
+    configure_file(
+      ${CMAKE_CURRENT_SOURCE_DIR}/python/termflow/${package_file}
+      ${TERMFLOW_PYTHON_PACKAGE_DIR}/${package_file}
+      COPYONLY)
+  endforeach()
+
+  pybind11_add_module(termflow_python MODULE bindings/python/module.cpp)
+  target_link_libraries(termflow_python PRIVATE termflow::termflow)
+  set_target_properties(termflow_python PROPERTIES
+    OUTPUT_NAME _termflow
+    LIBRARY_OUTPUT_DIRECTORY ${TERMFLOW_PYTHON_PACKAGE_DIR}
+    RUNTIME_OUTPUT_DIRECTORY ${TERMFLOW_PYTHON_PACKAGE_DIR})
+
+  install(
+    TARGETS termflow_python
+    LIBRARY DESTINATION termflow
+    RUNTIME DESTINATION termflow)
+
+  install(
+    FILES
+      python/termflow/__init__.py
+      python/termflow/cli.py
+    DESTINATION termflow)
+endif()
+
+if(TERMFLOW_BUILD_TESTS)
+  enable_testing()
+
+  add_executable(termflow_tests
+    tests/english_analyzer_tests.cpp
+    tests/filter_tests.cpp
+    tests/query_tests.cpp
+    tests/standard_tokenizer_tests.cpp
+    tests/term_extractor_tests.cpp
+    tests/test_framework.cpp
+    tests/test_main.cpp
+    tests/test_helpers.hpp)
+
+  target_link_libraries(termflow_tests PRIVATE termflow::termflow)
+
+  add_test(NAME termflow_tests COMMAND termflow_tests)
+
+  if(TERMFLOW_BUILD_PYTHON)
+    add_test(
+      NAME termflow_python_smoke
+      COMMAND ${Python3_EXECUTABLE} ${CMAKE_CURRENT_SOURCE_DIR}/tests/python_smoke_test.py)
+    set_tests_properties(
+      termflow_python_smoke
+      PROPERTIES ENVIRONMENT "PYTHONPATH=${CMAKE_CURRENT_BINARY_DIR}/python")
+  endif()
+endif()
+if(TERMFLOW_INSTALL_CPP_ARTIFACTS)
+  install(
+    TARGETS termflow
+    EXPORT termflowTargets
+    ARCHIVE DESTINATION ${CMAKE_INSTALL_LIBDIR}
+    LIBRARY DESTINATION ${CMAKE_INSTALL_LIBDIR}
+    RUNTIME DESTINATION ${CMAKE_INSTALL_BINDIR})
+
+  install(
+    DIRECTORY include/
+    DESTINATION ${CMAKE_INSTALL_INCLUDEDIR})
+
+  install(
+    EXPORT termflowTargets
+    FILE termflowTargets.cmake
+    NAMESPACE termflow::
+    DESTINATION ${CMAKE_INSTALL_LIBDIR}/cmake/termflow)
+
+  write_basic_package_version_file(
+    ${CMAKE_CURRENT_BINARY_DIR}/termflowConfigVersion.cmake
+    VERSION ${PROJECT_VERSION}
+    COMPATIBILITY SameMajorVersion)
+
+  configure_package_config_file(
+    ${CMAKE_CURRENT_SOURCE_DIR}/cmake/termflowConfig.cmake.in
+    ${CMAKE_CURRENT_BINARY_DIR}/termflowConfig.cmake
+    INSTALL_DESTINATION ${CMAKE_INSTALL_LIBDIR}/cmake/termflow)
+
+  install(
+    FILES
+      ${CMAKE_CURRENT_BINARY_DIR}/termflowConfig.cmake
+      ${CMAKE_CURRENT_BINARY_DIR}/termflowConfigVersion.cmake
+    DESTINATION ${CMAKE_INSTALL_LIBDIR}/cmake/termflow)
+endif()

termflow_ir-0.1.2/PKG-INFO

@@ -0,0 +1,174 @@
+Metadata-Version: 2.2
+Name: termflow-ir
+Version: 0.1.2
+Summary: English text analysis for information retrieval
+Keywords: text-analysis,information-retrieval,tokenization,stemming,search
+Author: Mustafa Abualsaud
+Classifier: Development Status :: 3 - Alpha
+Classifier: Intended Audience :: Developers
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3 :: Only
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: C++
+Classifier: Topic :: Text Processing :: Linguistic
+Project-URL: Homepage, https://github.com/gathera/termflow
+Project-URL: Documentation, https://github.com/gathera/termflow/blob/main/docs/installation.md
+Project-URL: Repository, https://github.com/gathera/termflow
+Project-URL: Issues, https://github.com/gathera/termflow/issues
+Project-URL: Releases, https://github.com/gathera/termflow/releases
+Requires-Python: >=3.10
+Description-Content-Type: text/markdown
+
+# termflow
+
+English text analysis for information retrieval workloads in C++ and Python.
+
+[![PyPI](https://img.shields.io/pypi/v/termflow-ir.svg)](https://pypi.org/project/termflow-ir/)
+[![Python Versions](https://img.shields.io/pypi/pyversions/termflow-ir.svg)](https://pypi.org/project/termflow-ir/)
+[![Python Package](https://github.com/gathera/termflow/actions/workflows/python-package.yml/badge.svg)](https://github.com/gathera/termflow/actions/workflows/python-package.yml)
+
+`termflow` is a library-first analysis stack for search, indexing, tagging, and query normalization. It provides a built-in English analyzer, term extraction helpers, and a lightweight query rewrite layer without trying to be a full search engine.
+
+## Why termflow
+
+- C++20 core library with optional Python bindings
+- English analyzer with configurable stemming, stop words, possessive handling, and ASCII folding
+- Term extraction API for finalized search/index terms
+- Query parser and rewrite support for canonicalization, equivalents, and expansions
+- Installable Python wheels for Linux and macOS
+- CMake install flow for downstream C++ consumers
+
+## Install
+
+Python package:
+
+```bash
+pip install termflow-ir
+```
+
+Python import:
+
+```python
+import termflow
+```
+
+CLI quick check:
+
+```bash
+termflow analyze "The Running Cars"
+```
+
+For C++ installation and `find_package(termflow)` usage, see [docs/installation.md](docs/installation.md).
+
+## Quick Start
+
+Python:
+
+```python
+import termflow
+
+analyzer = termflow.EnglishAnalyzer()
+terms = analyzer.analyze_terms("The Running Cars")
+normalized = analyzer.normalize("Running Café")
+
+print(terms)  # ['run', 'car']
+print(normalized)  # 'running café'
+```
+
+C++:
+
+```cpp
+#include <iostream>
+#include "termflow/analysis/english_analyzer.hpp"
+
+int main() {
+  termflow::EnglishAnalyzer analyzer;
+  const auto terms = analyzer.analyze_terms("The Running Cars");
+
+  for (const auto& term : terms) {
+    std::cout << term << "\n";
+  }
+}
+```
+
+## Features
+
+| Area | What it includes |
+| --- | --- |
+| Analysis | `EnglishAnalyzer`, token analysis, normalization, stemming, stop words, ASCII folding |
+| Term extraction | `TermExtractor` with length, numeric, and character-policy filtering |
+| Query processing | clause parsing, analyzed query terms, rewrite loading, validation, and alternatives |
+| Python bindings | built-in analyzer, term extractor, and query module under `termflow.query` |
+| CLI | `termflow analyze`, `termflow extract`, and `termflow analyze-query` for quick validation |
+| C++ consumption | installable CMake package and external `find_package` example |
+
+## Documentation
+
+- [docs/usage.md](docs/usage.md) for day-to-day analyzer, term extraction, query, and Python usage
+- [docs/customization.md](docs/customization.md) for pipeline tuning, query rewrites, and custom analyzers in C++
+- [docs/installation.md](docs/installation.md) for Python and C++ installation paths
+- [docs/installation-roadmap.md](docs/installation-roadmap.md) for packaging and distribution priorities
+
+Runnable examples:
+
+- [examples/analyze_text.cpp](examples/analyze_text.cpp)
+- [examples/extract_terms.cpp](examples/extract_terms.cpp)
+- [examples/custom_analyzer.cpp](examples/custom_analyzer.cpp)
+- [examples/analyze_query.cpp](examples/analyze_query.cpp)
+- [examples/find_package_consumer/CMakeLists.txt](examples/find_package_consumer/CMakeLists.txt)
+
+## Scope
+
+`termflow` currently focuses on:
+
+- English text analysis
+- Batch-oriented APIs
+- Query parsing and rewrite preparation
+- Reusable components for embedding in larger applications
+
+`termflow` does not currently provide:
+
+- indexing or retrieval
+- ranking or scoring
+- token graphs
+- phrase execution logic
+- multilingual analyzers
+
+## Build From Source
+
+Local build:
+
+```bash
+cmake -S . -B build -G Ninja
+cmake --build build
+ctest --test-dir build --output-on-failure
+```
+
+Build Python bindings from source:
+
+```bash
+cmake -S . -B build -G Ninja -DTERMFLOW_BUILD_PYTHON=ON
+cmake --build build
+PYTHONPATH=build/python python3 -c 'import termflow; print(termflow.EnglishAnalyzer().analyze_terms("Running Cars"))'
+```
+
+Build Python distributions:
+
+```bash
+python3 -m build --sdist --wheel
+python3 -m twine check dist/*
+```
+
+## Project Status
+
+`termflow` is early-stage and intentionally narrow in scope. The current focus is making the built-in English analysis and packaging story solid before expanding into more languages or broader IR features.
+
+## Contributing
+
+Issues and pull requests are welcome. If you want to make a larger API or packaging change, open an issue first so the direction is clear before implementation work starts.
+
+## License
+
+This repository does not yet include a `LICENSE` file. Until that is added, do not assume open source usage terms.

termflow_ir-0.1.2/README.md

@@ -0,0 +1,151 @@
+# termflow
+
+English text analysis for information retrieval workloads in C++ and Python.
+
+[![PyPI](https://img.shields.io/pypi/v/termflow-ir.svg)](https://pypi.org/project/termflow-ir/)
+[![Python Versions](https://img.shields.io/pypi/pyversions/termflow-ir.svg)](https://pypi.org/project/termflow-ir/)
+[![Python Package](https://github.com/gathera/termflow/actions/workflows/python-package.yml/badge.svg)](https://github.com/gathera/termflow/actions/workflows/python-package.yml)
+
+`termflow` is a library-first analysis stack for search, indexing, tagging, and query normalization. It provides a built-in English analyzer, term extraction helpers, and a lightweight query rewrite layer without trying to be a full search engine.
+
+## Why termflow
+
+- C++20 core library with optional Python bindings
+- English analyzer with configurable stemming, stop words, possessive handling, and ASCII folding
+- Term extraction API for finalized search/index terms
+- Query parser and rewrite support for canonicalization, equivalents, and expansions
+- Installable Python wheels for Linux and macOS
+- CMake install flow for downstream C++ consumers
+
+## Install
+
+Python package:
+
+```bash
+pip install termflow-ir
+```
+
+Python import:
+
+```python
+import termflow
+```
+
+CLI quick check:
+
+```bash
+termflow analyze "The Running Cars"
+```
+
+For C++ installation and `find_package(termflow)` usage, see [docs/installation.md](docs/installation.md).
+
+## Quick Start
+
+Python:
+
+```python
+import termflow
+
+analyzer = termflow.EnglishAnalyzer()
+terms = analyzer.analyze_terms("The Running Cars")
+normalized = analyzer.normalize("Running Café")
+
+print(terms)  # ['run', 'car']
+print(normalized)  # 'running café'
+```
+
+C++:
+
+```cpp
+#include <iostream>
+#include "termflow/analysis/english_analyzer.hpp"
+
+int main() {
+  termflow::EnglishAnalyzer analyzer;
+  const auto terms = analyzer.analyze_terms("The Running Cars");
+
+  for (const auto& term : terms) {
+    std::cout << term << "\n";
+  }
+}
+```
+
+## Features
+
+| Area | What it includes |
+| --- | --- |
+| Analysis | `EnglishAnalyzer`, token analysis, normalization, stemming, stop words, ASCII folding |
+| Term extraction | `TermExtractor` with length, numeric, and character-policy filtering |
+| Query processing | clause parsing, analyzed query terms, rewrite loading, validation, and alternatives |
+| Python bindings | built-in analyzer, term extractor, and query module under `termflow.query` |
+| CLI | `termflow analyze`, `termflow extract`, and `termflow analyze-query` for quick validation |
+| C++ consumption | installable CMake package and external `find_package` example |
+
+## Documentation
+
+- [docs/usage.md](docs/usage.md) for day-to-day analyzer, term extraction, query, and Python usage
+- [docs/customization.md](docs/customization.md) for pipeline tuning, query rewrites, and custom analyzers in C++
+- [docs/installation.md](docs/installation.md) for Python and C++ installation paths
+- [docs/installation-roadmap.md](docs/installation-roadmap.md) for packaging and distribution priorities
+
+Runnable examples:
+
+- [examples/analyze_text.cpp](examples/analyze_text.cpp)
+- [examples/extract_terms.cpp](examples/extract_terms.cpp)
+- [examples/custom_analyzer.cpp](examples/custom_analyzer.cpp)
+- [examples/analyze_query.cpp](examples/analyze_query.cpp)
+- [examples/find_package_consumer/CMakeLists.txt](examples/find_package_consumer/CMakeLists.txt)
+
+## Scope
+
+`termflow` currently focuses on:
+
+- English text analysis
+- Batch-oriented APIs
+- Query parsing and rewrite preparation
+- Reusable components for embedding in larger applications
+
+`termflow` does not currently provide:
+
+- indexing or retrieval
+- ranking or scoring
+- token graphs
+- phrase execution logic
+- multilingual analyzers
+
+## Build From Source
+
+Local build:
+
+```bash
+cmake -S . -B build -G Ninja
+cmake --build build
+ctest --test-dir build --output-on-failure
+```
+
+Build Python bindings from source:
+
+```bash
+cmake -S . -B build -G Ninja -DTERMFLOW_BUILD_PYTHON=ON
+cmake --build build
+PYTHONPATH=build/python python3 -c 'import termflow; print(termflow.EnglishAnalyzer().analyze_terms("Running Cars"))'
+```
+
+Build Python distributions:
+
+```bash
+python3 -m build --sdist --wheel
+python3 -m twine check dist/*
+```
+
+## Project Status
+
+`termflow` is early-stage and intentionally narrow in scope. The current focus is making the built-in English analysis and packaging story solid before expanding into more languages or broader IR features.
+
+## Contributing
+
+Issues and pull requests are welcome. If you want to make a larger API or packaging change, open an issue first so the direction is clear before implementation work starts.
+
+## License
+
+This repository does not yet include a `LICENSE` file. Until that is added, do not assume open source usage terms.