ai-microcore 5.0.0__tar.gz → 5.0.0.dev2__tar.gz

{ai_microcore-5.0.0 → ai_microcore-5.0.0.dev2}/LICENSE

@@ -1,20 +1,20 @@
-The MIT License (MIT)
-
-Copyright (c) 2023—2026 Vitalii Stepanenko
-
-Permission is hereby granted, free of charge, to any person obtaining a copy of
-this software and associated documentation files (the "Software"), to deal in
-the Software without restriction, including without limitation the rights to
-use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of
-the Software, and to permit persons to whom the Software is furnished to do so,
-subject to the following conditions:
-
-The above copyright notice and this permission notice shall be included in all
-copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
-FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
-COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
-IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
+The MIT License (MIT)
+
+Copyright (c) 2023—2025 Vitalii Stepanenko
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of
+this software and associated documentation files (the "Software"), to deal in
+the Software without restriction, including without limitation the rights to
+use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of
+the Software, and to permit persons to whom the Software is furnished to do so,
+subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
+FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
+COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
+IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
 CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

{ai_microcore-5.0.0 → ai_microcore-5.0.0.dev2}/PKG-INFO

@@ -1,14 +1,13 @@
 Metadata-Version: 2.4
 Name: ai-microcore
-Version: 5.0.0
+Version: 5.0.0.dev2
 Summary: # Minimalistic Foundation for AI Applications
-Keywords: llm,large language models,ai,similarity search,ai search,gpt,openai,framework,adapter,anthropic,google gemini,google vertex ai
+Keywords: llm,large language models,ai,similarity search,ai search,gpt,openai,framework,adapter
 Author-email: Vitalii Stepanenko <mail@vitaliy.in>
 Maintainer-email: Vitalii Stepanenko <mail@vitaliy.in>
 Requires-Python: >=3.10
 Description-Content-Type: text/markdown
 Classifier: Programming Language :: Python :: 3
-Classifier: Programming Language :: Python :: 3.10
 Classifier: Programming Language :: Python :: 3.11
 Classifier: Programming Language :: Python :: 3.12
 Classifier: Programming Language :: Python :: 3.13
@@ -16,8 +15,6 @@ Classifier: License :: OSI Approved :: MIT License
 Classifier: Operating System :: OS Independent
 Classifier: Intended Audience :: Developers
 Classifier: Topic :: Software Development :: Libraries :: Application Frameworks
-Classifier: Topic :: Scientific/Engineering :: Artificial Intelligence
-Classifier: Development Status :: 5 - Production/Stable
 License-File: LICENSE
 Requires-Dist: openai>=0.28.1,<2
 Requires-Dist: python-dotenv~=1.1.0
@@ -30,22 +27,20 @@ Requires-Dist: mcp>=1.10.1,<2.0
 Requires-Dist: fastmcp>=2.10.2,<3.0
 Requires-Dist: docstring_parser~=0.16.0
 Requires-Dist: httpx~=0.28.1
-Project-URL: Bug Tracker, https://github.com/Nayjest/ai-microcore/issues
 Project-URL: Source Code, https://github.com/Nayjest/ai-microcore
 
-# AI MicroCore: A Minimalistic Foundation for AI Applications
-
-<p align="center"> 
-  <a href="https://pypi.org/project/ai-microcore/" target="_blank"><img src="https://img.shields.io/github/v/release/Nayjest/ai-microcore.svg" alt="Release Notes"></a>
-  <a href="https://app.codacy.com/gh/Nayjest/ai-microcore/dashboard?utm_source=gh&utm_medium=referral&utm_content=&utm_campaign=Badge_grade" target="_blank"><img src="https://app.codacy.com/project/badge/Grade/441d03416bc048828c649129530dcbc3" alt="Code Quality"></a>
-  <a href="https://github.com/Nayjest/ai-microcore/actions/workflows/pylint.yml" target="_blank"><img src="https://github.com/Nayjest/ai-microcore/actions/workflows/pylint.yml/badge.svg" alt="Pylint"></a>
-  <a href="https://github.com/Nayjest/ai-microcore/actions/workflows/tests.yml" target="_blank"><img src="https://github.com/Nayjest/ai-microcore/actions/workflows/tests.yml/badge.svg" alt="Tests"></a>
-  <img src="https://raw.githubusercontent.com/Nayjest/ai-microcore/main/coverage.svg" alt="Code Coverage">
-  <a href="https://github.com/vshymanskyy/StandWithUkraine/blob/main/README.md" target="_blank"><img src="https://raw.githubusercontent.com/vshymanskyy/StandWithUkraine/refs/heads/main/badges/StandWithUkraine.svg" alt="Stand With Ukraine"></a>
-  <a href="https://github.com/Nayjest/ai-microcore/blob/main/LICENSE" target="_blank"><img src="https://img.shields.io/static/v1?label=license&message=MIT&color=d08aff" alt="License"></a>
+<p align="right"> 
+    <a href="https://github.com/Nayjest/ai-microcore/releases" target="_blank"><img src="https://img.shields.io/github/v/release/Nayjest/ai-microcore.svg" alt="Release Notes"></a>
+    <a href="https://app.codacy.com/gh/Nayjest/ai-microcore/dashboard?utm_source=gh&utm_medium=referral&utm_content=&utm_campaign=Badge_grade" target="_blank"><img src="https://app.codacy.com/project/badge/Grade/441d03416bc048828c649129530dcbc3" alt="Code Quality"></a>
+    <a href="https://github.com/Nayjest/ai-microcore/actions/workflows/pylint.yml" target="_blank"><img src="https://github.com/Nayjest/ai-microcore/actions/workflows/pylint.yml/badge.svg" alt="Pylint"></a>
+    <img src="https://raw.githubusercontent.com/Nayjest/ai-microcore/main/coverage.svg" alt="Code Coverage">
+    <a href="https://github.com/Nayjest/ai-microcore/actions/workflows/tests.yml" target="_blank"><img src="https://github.com/Nayjest/ai-microcore/actions/workflows/tests.yml/badge.svg" alt="Tests"></a>
+    <a href="https://github.com/Nayjest/ai-microcore/blob/main/LICENSE" target="_blank"><img src="https://img.shields.io/static/v1?label=license&message=MIT&color=d08aff" alt="License"></a>
 </p>
 
 
+# AI MicroCore: A Minimalistic Foundation for AI Applications
+
 **MicroCore** is a collection of python adapters for Large Language Models
 and Vector Databases / Semantic Search APIs allowing to 
 communicate with these services in a convenient way, make them easily switchable 
@@ -55,7 +50,7 @@ It defines interfaces for features typically used in AI applications,
 which allows you to keep your application as simple as possible and try various models & services
 without need to change your application code.
 
-You can even switch between text completion and chat completion models only using configuration.
+You even can switch between text completion and chat completion models only using configuration.
 
 Thanks to LLM-agnostic MCP integration,
 **MicroCore** connects MCP tools to any language models easily,
@@ -107,7 +102,7 @@ Similarity search features will work out of the box if you have the `chromadb` p
 There are a few options available for configuring microcore:
 
 -   Use `microcore.configure(**params)`
-    <br>💡 <small>All configuration options appear in IDE autocompletion tooltips</small>
+    <br>💡 <small>All configuration options should be available in IDE autocompletion tooltips</small>
 -   Create a `.env` file in your project root; examples: [basic.env](https://github.com/Nayjest/ai-microcore/blob/main/.env.example), [Mistral Large.env](https://github.com/Nayjest/ai-microcore/blob/main/.env.mistral.example), [Anthropic Claude 3 Opus.env](https://github.com/Nayjest/ai-microcore/blob/main/.env.anthropic.example), [Gemini on Vertex AI.env](https://github.com/Nayjest/ai-microcore/blob/main/.env.google-vertex-gemini.example), [Gemini on AI Studio.env](https://github.com/Nayjest/ai-microcore/blob/main/.env.gemini.example)
 -   Use a custom configuration file: `mc.configure(DOT_ENV_FILE='dev-config.ini')`
 -   Define OS environment variables
@@ -115,20 +110,26 @@ There are a few options available for configuring microcore:
 For the full list of available configuration options, you may also check [`microcore/config.py`](https://github.com/Nayjest/ai-microcore/blob/main/microcore/configuration.py#L175).
 
 ### Installing vendor-specific packages
-For models working not via OpenAI API, you may need to install additional packages:
-#### Anthropic Claude
+For the models working not via OpenAI API, you may need to install additional packages:
+#### Anthropic Claude 3
 ```bash
 pip install anthropic
 ```
-#### Google Gemini via AI Studio or Vertex AI
+#### Google Gemini via AI Studio
+```bash
+pip install google-generativeai
+```
+#### Google Gemini via Vertex AI
 ```bash
-pip install google-genai
+pip install vertexai
 ```
+📌Additonaly for working through [Vertex AI](https://cloud.google.com/vertex-ai) you need to
+[install the Google Cloud CLI](https://cloud.google.com/sdk/docs/install)
+and [configure the authorization](https://cloud.google.com/sdk/docs/authorizing).
 
 #### Local language models via Hugging Face Transformers
 
-You will need to install transformers and a deep learning library of your choice
-(PyTorch, TensorFlow, Flax, etc).
+You will need to install transformers and deep learning library of your choice (PyTorch, TensorFlow, Flax, etc).
 
 See [transformers installation](https://huggingface.co/docs/transformers/installation).
 
@@ -144,13 +145,13 @@ See [transformers installation](https://huggingface.co/docs/transformers/install
 Vector database functions are available via `microcore.texts`.
 
 #### ChromaDB
-The default vector database is [Chroma](https://www.trychroma.com/).
+Default vector database is [Chroma](https://www.trychroma.com/).
 In order to use vector database functions with ChromaDB, you need to install the `chromadb` package:
 ```bash
 pip install chromadb
 ```
-By default, MicroCore will use ChromaDB PersistentClient (if the corresponding package is installed).
-Alternatively, you can run Chroma as a separate service and configure MicroCore to use HttpClient:
+By default, MicroCore will use ChromaDB PersistentClient (if corresponding package is installed).
+Alternatively, you can run Chroma as separate service and configure MicroCore to use HttpClient:
 
 ```python
 from microcore import configure
@@ -173,7 +174,7 @@ configure(
     EMBEDDING_DB_TYPE=EmbeddingDbType.QDRANT,
     EMBEDDING_DB_HOST="localhost",
     EMBEDDING_DB_PORT="6333",
-    EMBEDDING_DB_SIZE=384,  # number of dimensions in the SentenceTransformer model
+    EMBEDDING_DB_SIZE=384,  # dimentions quantity in used SentenceTransformer model
     EMBEDDING_DB_FUNCTION=SentenceTransformer("paraphrase-multilingual-MiniLM-L12-v2"),
 )
 ```
@@ -196,11 +197,11 @@ use_logging()
 # Basic usage
 ai_response = llm('What is your model name?')
 
-# You may also pass a list of strings as prompt
+# You also may pass a list of strings as prompt
 # - For chat completion models elements are treated as separate messages
 # - For completion LLMs elements are treated as text lines
 llm(['1+2', '='])
-llm('1+2=', model='gpt-5.2')
+llm('1+2=', model='gpt-4')
 
 # To specify a message role, you can use dictionary or classes
 llm(dict(role='system', content='1+2='))
@@ -289,12 +290,12 @@ LLM Microcore supports all models & API providers having OpenAI API.
 ## 🖼️ Examples
 
 #### [Code review tool](https://github.com/llm-microcore/microcore/blob/main/examples/code-review-tool)
-Performs a code review by LLM for changes in git .patch files in any programming languages.
+Performs code review by LLM for changes in git .patch files in any programming languages.
 
 #### [Image analysis](https://colab.research.google.com/drive/1qTJ51wxCv3VlyqLt3M8OZ7183YXPFpic) (Google Colab)
 Determine the number of petals and the color of the flower from a photo (gpt-4-turbo)
 
-#### [Benchmark LLMs on math problems](https://www.kaggle.com/code/nayjest/gigabenchmark-llm-accuracy-math-problems) (Kaggle Notebook)
+#### [Banchmark LLMs on math problems](https://www.kaggle.com/code/nayjest/gigabenchmark-llm-accuracy-math-problems) (Kaggle Notebook)
 Benchmark accuracy of 20+ state of the art models on solving olympiad math problems. Inferencing local language models via HuggingFace Transformers, parallel inference.
 
 #### [Generate meme image](https://github.com/Nayjest/ai-microcore/blob/main/examples/generate_meme_image.py)
@@ -302,61 +303,16 @@ Simple example demonstrating image generation using [OpenAI GPT Image](https://p
 
 
 #### [Local inference with PyTorch / Transformers](https://github.com/Nayjest/ai-microcore/blob/main/examples/pytorch_transformers.py)
-Text generation using HF/Transformers model locally (example with Qwen 3 0.6B).
+Text generation using HF/Transformers model locally (example withQwen 3 0.6B).
  
 #### [Other examples](https://github.com/llm-microcore/microcore/tree/main/examples)
 
 ## Python functions as AI tools
-*Usage Example*:
-```python
-from microcore.ai_func import ai_func
-
-@ai_func
-def search_products(
-    query: str,
-    category: str = "all",
-    max_results: int = 10,
-    in_stock_only: bool = False
-):
-    """
-    Search for products in the catalog.
-
-    Args:
-        query: Search terms to find matching products
-        category: Product category to filter by (e.g., "electronics", "clothing")
-        max_results: Maximum number of results to return
-        in_stock_only: If True, only return products currently in stock
-
-    Returns:
-        List of matching products with name, price, and availability
-    """
-    # Implementation would go here
-    pass
-```
-*Output*:
-```
-# Search for products in the catalog.
-
-Args:
-    query: Search terms to find matching products
-    category: Product category to filter by (e.g., "electronics", "clothing")
-    max_results: Maximum number of results to return
-    in_stock_only: If True, only return products currently in stock
-
-Returns:
-    List of matching products with name, price, and availability
-{
-  "call": "search_products",
-  "query": <str>,
-  "category": <str> (default = "all"),
-  "max_results": <int> (default = 10),
-  "in_stock_only": <bool> (default = False)
-}
 
-```
+@TODO
 
 ## 🤖 AI Modules
-**This is an experimental feature.**
+**This is experimental feature.**
 
 Tweaks the Python import system to provide automatic setup of MicroCore environment
 based on metadata in module docstrings.
@@ -376,5 +332,5 @@ Please see [CONTRIBUTING](https://github.com/Nayjest/ai-microcore/blob/main/CONT
 ## 📝 License
 
 Licensed under the [MIT License](https://github.com/Nayjest/ai-microcore/blob/main/LICENSE)
-© 2023–2026 [Vitalii Stepanenko](mailto:mail@vitaliy.in)
+© 2023 [Vitalii Stepanenko](mailto:mail@vitaliy.in)