cbrkit 0.20.2__tar.gz → 0.20.4__tar.gz

{cbrkit-0.20.2/src/cbrkit.egg-info → cbrkit-0.20.4}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: cbrkit
-Version: 0.20.2
+Version: 0.20.4
 Summary: Customizable Case-Based Reasoning (CBR) toolkit for Python with a built-in API and CLI
 Author-email: Mirko Lenz <mirko@mirkolenz.com>
 Project-URL: Repository, https://github.com/wi2trier/cbrkit
@@ -76,23 +76,22 @@ Requires-Dist: torch<3,>=2.5; sys_platform == "linux" and extra == "transformers
 Requires-Dist: transformers<5,>=4; extra == "transformers"
 
 <!-- markdownlint-disable MD033 MD041 -->
-<h2><p align="center">CBRkit</p></h2>
+<h1><p align="center">CBRkit</p></h1>
+
 <p align="center">
   <img width="256px" alt="cbrkit logo" src="https://raw.githubusercontent.com/wi2trier/cbrkit/main/assets/logo.png" />
 </p>
+
 <p align="center">
   <a href="https://pypi.org/project/cbrkit/">PyPI</a> |
   <a href="https://wi2trier.github.io/cbrkit/">Docs</a> |
   <a href="https://github.com/wi2trier/cbrkit/tree/main/tests/test_retrieve.py">Example</a>
 </p>
+
 <p align="center">
   Customizable Case-Based Reasoning (CBR) toolkit for Python with a built-in API and CLI.
 </p>
-<!-- <p align="center">
-  <a href="https://youtu.be/27dG4MagDhE">
-    <img width="256px" alt="cbrkit presentation" src="https://img.youtube.com/vi/27dG4MagDhE/0.jpg" />
-  </a>
-</p> -->
+
 <p align="center">
   <a href="https://youtu.be/27dG4MagDhE">CBRkit Presentation</a>
   <br/>
@@ -101,7 +100,7 @@ Requires-Dist: transformers<5,>=4; extra == "transformers"
 
 ---
 
-# CBRkit
+<!-- PDOC_START -->
 
 CBRkit is a customizable and modular toolkit for Case-Based Reasoning (CBR) in Python.
 It provides a set of tools for loading cases and queries, defining similarity measures, and retrieving cases based on a query.
@@ -340,7 +339,7 @@ Coming soon...
 
 ## REST API and CLI
 
-In order to use the built-in API and CLI, you need to define a retriever in a Python module using the function `cbrkit.retrieval.build()`.
+In order to use the built-in API and CLI, you need to define a retriever/reuser in a Python module using the function `cbrkit.retrieval.build()` and/or `cbrkit.reuse.build()`.
 For example, the file `./retriever_module.py` could contain the following code:
 
 ```python
@@ -356,35 +355,20 @@ Our custom retriever can then be specified for the API/CLI using standard Python
 
 ### CLI
 
-When installing with the `cli` extra, CBRkit provides a command line interface that can be started with the following command:
+When installing with the `cli` extra, CBRkit provides a command line interface:
 
 ```shell
-cbrkit retrieve PATH_TO_CASEBASE PATH_TO_QUERY retriever_module:custom_retriever
+cbrkit --help
 ```
 
-It will then print the retrieval results to the console, so you could pipe the output to a file or another command.
+Please visit the [documentation](https://wi2trier.github.io/cbrkit/cbrkit/cli.html) for more information on how to use the CLI.
 
 ### API
 
-When installing with the `api` extra, CBRkit provides a REST API server that can be started with the following command:
+When installing with the `api` extra, CBRkit provides a REST API server:
 
 ```shell
-cbrkit serve retriever_module:custom_retriever
-```
-
-It offers a single endpoint `/retrieve` that accepts POST requests with a JSON body with the following structure:
-
-```json
-{
-  "casebase": {
-    "case1": ...,
-    "case2": ...
-  },
-  "queries": {
-    "query1": ...,
-    "query2": ...
-  }
-}
+cbrkit serve --help
 ```
 
-The server will return a JSON object containing the retrieval results for each query.
+After starting the server, you can access the API documentation at `http://localhost:8000/docs`.

{cbrkit-0.20.2 → cbrkit-0.20.4}/README.md

@@ -1,21 +1,20 @@
 <!-- markdownlint-disable MD033 MD041 -->
-<h2><p align="center">CBRkit</p></h2>
+<h1><p align="center">CBRkit</p></h1>
+
 <p align="center">
   <img width="256px" alt="cbrkit logo" src="https://raw.githubusercontent.com/wi2trier/cbrkit/main/assets/logo.png" />
 </p>
+
 <p align="center">
   <a href="https://pypi.org/project/cbrkit/">PyPI</a> |
   <a href="https://wi2trier.github.io/cbrkit/">Docs</a> |
   <a href="https://github.com/wi2trier/cbrkit/tree/main/tests/test_retrieve.py">Example</a>
 </p>
+
 <p align="center">
   Customizable Case-Based Reasoning (CBR) toolkit for Python with a built-in API and CLI.
 </p>
-<!-- <p align="center">
-  <a href="https://youtu.be/27dG4MagDhE">
-    <img width="256px" alt="cbrkit presentation" src="https://img.youtube.com/vi/27dG4MagDhE/0.jpg" />
-  </a>
-</p> -->
+
 <p align="center">
   <a href="https://youtu.be/27dG4MagDhE">CBRkit Presentation</a>
   <br/>
@@ -24,7 +23,7 @@
 
 ---
 
-# CBRkit
+<!-- PDOC_START -->
 
 CBRkit is a customizable and modular toolkit for Case-Based Reasoning (CBR) in Python.
 It provides a set of tools for loading cases and queries, defining similarity measures, and retrieving cases based on a query.
@@ -263,7 +262,7 @@ Coming soon...
 
 ## REST API and CLI
 
-In order to use the built-in API and CLI, you need to define a retriever in a Python module using the function `cbrkit.retrieval.build()`.
+In order to use the built-in API and CLI, you need to define a retriever/reuser in a Python module using the function `cbrkit.retrieval.build()` and/or `cbrkit.reuse.build()`.
 For example, the file `./retriever_module.py` could contain the following code:
 
 ```python
@@ -279,35 +278,20 @@ Our custom retriever can then be specified for the API/CLI using standard Python
 
 ### CLI
 
-When installing with the `cli` extra, CBRkit provides a command line interface that can be started with the following command:
+When installing with the `cli` extra, CBRkit provides a command line interface:
 
 ```shell
-cbrkit retrieve PATH_TO_CASEBASE PATH_TO_QUERY retriever_module:custom_retriever
+cbrkit --help
 ```
 
-It will then print the retrieval results to the console, so you could pipe the output to a file or another command.
+Please visit the [documentation](https://wi2trier.github.io/cbrkit/cbrkit/cli.html) for more information on how to use the CLI.
 
 ### API
 
-When installing with the `api` extra, CBRkit provides a REST API server that can be started with the following command:
+When installing with the `api` extra, CBRkit provides a REST API server:
 
 ```shell
-cbrkit serve retriever_module:custom_retriever
-```
-
-It offers a single endpoint `/retrieve` that accepts POST requests with a JSON body with the following structure:
-
-```json
-{
-  "casebase": {
-    "case1": ...,
-    "case2": ...
-  },
-  "queries": {
-    "query1": ...,
-    "query2": ...
-  }
-}
+cbrkit serve --help
 ```
 
-The server will return a JSON object containing the retrieval results for each query.
+After starting the server, you can access the API documentation at `http://localhost:8000/docs`.

{cbrkit-0.20.2 → cbrkit-0.20.4}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "cbrkit"
-version = "0.20.2"
+version = "0.20.4"
 description = "Customizable Case-Based Reasoning (CBR) toolkit for Python with a built-in API and CLI"
 authors = [{ name = "Mirko Lenz", email = "mirko@mirkolenz.com" }]
 readme = "README.md"

{cbrkit-0.20.2 → cbrkit-0.20.4}/src/cbrkit/__init__.py

@@ -2,7 +2,7 @@
 **[🌟 GitHub Project 🌟](https://github.com/wi2trier/cbrkit)**
 
 .. include:: ../../README.md
-   :start-after: # CBRkit
+   :start-after: <!-- PDOC_START -->
 
 """
 

{cbrkit-0.20.2 → cbrkit-0.20.4}/src/cbrkit/cli.py

@@ -1,3 +1,7 @@
+"""
+.. include:: ../../cli.md
+"""
+
 import json
 import os
 import sys
@@ -14,6 +18,8 @@ except ModuleNotFoundError:
 
 import cbrkit
 
+__all__ = ["app"]
+
 app = typer.Typer()
 
 

{cbrkit-0.20.2 → cbrkit-0.20.4/src/cbrkit.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: cbrkit
-Version: 0.20.2
+Version: 0.20.4
 Summary: Customizable Case-Based Reasoning (CBR) toolkit for Python with a built-in API and CLI
 Author-email: Mirko Lenz <mirko@mirkolenz.com>
 Project-URL: Repository, https://github.com/wi2trier/cbrkit
@@ -76,23 +76,22 @@ Requires-Dist: torch<3,>=2.5; sys_platform == "linux" and extra == "transformers
 Requires-Dist: transformers<5,>=4; extra == "transformers"
 
 <!-- markdownlint-disable MD033 MD041 -->
-<h2><p align="center">CBRkit</p></h2>
+<h1><p align="center">CBRkit</p></h1>
+
 <p align="center">
   <img width="256px" alt="cbrkit logo" src="https://raw.githubusercontent.com/wi2trier/cbrkit/main/assets/logo.png" />
 </p>
+
 <p align="center">
   <a href="https://pypi.org/project/cbrkit/">PyPI</a> |
   <a href="https://wi2trier.github.io/cbrkit/">Docs</a> |
   <a href="https://github.com/wi2trier/cbrkit/tree/main/tests/test_retrieve.py">Example</a>
 </p>
+
 <p align="center">
   Customizable Case-Based Reasoning (CBR) toolkit for Python with a built-in API and CLI.
 </p>
-<!-- <p align="center">
-  <a href="https://youtu.be/27dG4MagDhE">
-    <img width="256px" alt="cbrkit presentation" src="https://img.youtube.com/vi/27dG4MagDhE/0.jpg" />
-  </a>
-</p> -->
+
 <p align="center">
   <a href="https://youtu.be/27dG4MagDhE">CBRkit Presentation</a>
   <br/>
@@ -101,7 +100,7 @@ Requires-Dist: transformers<5,>=4; extra == "transformers"
 
 ---
 
-# CBRkit
+<!-- PDOC_START -->
 
 CBRkit is a customizable and modular toolkit for Case-Based Reasoning (CBR) in Python.
 It provides a set of tools for loading cases and queries, defining similarity measures, and retrieving cases based on a query.
@@ -340,7 +339,7 @@ Coming soon...
 
 ## REST API and CLI
 
-In order to use the built-in API and CLI, you need to define a retriever in a Python module using the function `cbrkit.retrieval.build()`.
+In order to use the built-in API and CLI, you need to define a retriever/reuser in a Python module using the function `cbrkit.retrieval.build()` and/or `cbrkit.reuse.build()`.
 For example, the file `./retriever_module.py` could contain the following code:
 
 ```python
@@ -356,35 +355,20 @@ Our custom retriever can then be specified for the API/CLI using standard Python
 
 ### CLI
 
-When installing with the `cli` extra, CBRkit provides a command line interface that can be started with the following command:
+When installing with the `cli` extra, CBRkit provides a command line interface:
 
 ```shell
-cbrkit retrieve PATH_TO_CASEBASE PATH_TO_QUERY retriever_module:custom_retriever
+cbrkit --help
 ```
 
-It will then print the retrieval results to the console, so you could pipe the output to a file or another command.
+Please visit the [documentation](https://wi2trier.github.io/cbrkit/cbrkit/cli.html) for more information on how to use the CLI.
 
 ### API
 
-When installing with the `api` extra, CBRkit provides a REST API server that can be started with the following command:
+When installing with the `api` extra, CBRkit provides a REST API server:
 
 ```shell
-cbrkit serve retriever_module:custom_retriever
-```
-
-It offers a single endpoint `/retrieve` that accepts POST requests with a JSON body with the following structure:
-
-```json
-{
-  "casebase": {
-    "case1": ...,
-    "case2": ...
-  },
-  "queries": {
-    "query1": ...,
-    "query2": ...
-  }
-}
+cbrkit serve --help
 ```
 
-The server will return a JSON object containing the retrieval results for each query.
+After starting the server, you can access the API documentation at `http://localhost:8000/docs`.