arkadia-data 0.1.7__tar.gz

arkadia_data-0.1.7/.gitignore

@@ -0,0 +1,210 @@
+.vscode
+.github
+
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[codz]
+*$py.class
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+share/python-wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+MANIFEST
+
+# PyInstaller
+#  Usually these files are written by a python script from a template
+#  before PyInstaller builds the exe, so as to inject date/other infos into it.
+*.manifest
+*.spec
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.nox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*.cover
+*.py.cover
+.hypothesis/
+.pytest_cache/
+cover/
+
+# Translations
+*.mo
+*.pot
+
+# Django stuff:
+*.log
+local_settings.py
+db.sqlite3
+db.sqlite3-journal
+
+# Flask stuff:
+instance/
+.webassets-cache
+
+# Scrapy stuff:
+.scrapy
+
+# Sphinx documentation
+docs/_build/
+
+# PyBuilder
+.pybuilder/
+target/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# IPython
+profile_default/
+ipython_config.py
+
+# pyenv
+#   For a library or package, you might want to ignore these files since the code is
+#   intended to run in multiple environments; otherwise, check them in:
+# .python-version
+
+# pipenv
+#   According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
+#   However, in case of collaboration, if having platform-specific dependencies or dependencies
+#   having no cross-platform support, pipenv may install dependencies that don't work, or not
+#   install all needed dependencies.
+#Pipfile.lock
+
+# UV
+#   Similar to Pipfile.lock, it is generally recommended to include uv.lock in version control.
+#   This is especially recommended for binary packages to ensure reproducibility, and is more
+#   commonly ignored for libraries.
+#uv.lock
+
+# poetry
+#   Similar to Pipfile.lock, it is generally recommended to include poetry.lock in version control.
+#   This is especially recommended for binary packages to ensure reproducibility, and is more
+#   commonly ignored for libraries.
+#   https://python-poetry.org/docs/basic-usage/#commit-your-poetrylock-file-to-version-control
+#poetry.lock
+#poetry.toml
+
+# pdm
+#   Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control.
+#   pdm recommends including project-wide configuration in pdm.toml, but excluding .pdm-python.
+#   https://pdm-project.org/en/latest/usage/project/#working-with-version-control
+#pdm.lock
+#pdm.toml
+.pdm-python
+.pdm-build/
+
+# pixi
+#   Similar to Pipfile.lock, it is generally recommended to include pixi.lock in version control.
+#pixi.lock
+#   Pixi creates a virtual environment in the .pixi directory, just like venv module creates one
+#   in the .venv directory. It is recommended not to include this directory in version control.
+.pixi
+
+# PEP 582; used by e.g. github.com/David-OConnor/pyflow and github.com/pdm-project/pdm
+__pypackages__/
+
+# Celery stuff
+celerybeat-schedule
+celerybeat.pid
+
+# SageMath parsed files
+*.sage.py
+
+# Environments
+.env
+.envrc
+.venv
+env/
+venv/
+ENV/
+env.bak/
+venv.bak/
+
+# Spyder project settings
+.spyderproject
+.spyproject
+
+# Rope project settings
+.ropeproject
+
+# mkdocs documentation
+/site
+
+# mypy
+.mypy_cache/
+.dmypy.json
+dmypy.json
+
+# Pyre type checker
+.pyre/
+
+# pytype static type analyzer
+.pytype/
+
+# Cython debug symbols
+cython_debug/
+
+# PyCharm
+#  JetBrains specific template is maintained in a separate JetBrains.gitignore that can
+#  be found at https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore
+#  and can be added to the global gitignore or merged into this file.  For a more nuclear
+#  option (not recommended) you can uncomment the following to ignore the entire idea folder.
+#.idea/
+
+# Abstra
+# Abstra is an AI-powered process automation framework.
+# Ignore directories containing user credentials, local state, and settings.
+# Learn more at https://abstra.io/docs
+.abstra/
+
+# Visual Studio Code
+#  Visual Studio Code specific template is maintained in a separate VisualStudioCode.gitignore 
+#  that can be found at https://github.com/github/gitignore/blob/main/Global/VisualStudioCode.gitignore
+#  and can be added to the global gitignore or merged into this file. However, if you prefer, 
+#  you could uncomment the following to ignore the entire vscode folder
+# .vscode/
+
+# Ruff stuff:
+.ruff_cache/
+
+# PyPI configuration file
+.pypirc
+
+# Cursor
+#  Cursor is an AI-powered code editor. `.cursorignore` specifies files/directories to
+#  exclude from AI features like autocomplete and code analysis. Recommended for sensitive data
+#  refer to https://docs.cursor.com/context/ignore-files
+.cursorignore
+.cursorindexingignore
+
+# Marimo
+marimo/_static/
+marimo/_lsp/
+__marimo__/

arkadia_data-0.1.7/LICENCE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Arkadia Solutions
+
+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.

arkadia_data-0.1.7/PKG-INFO

@@ -0,0 +1,261 @@
+Metadata-Version: 2.4
+Name: arkadia-data
+Version: 0.1.7
+Summary: Arkadia Data Format (AK-DATA) - A versatile data serialization format optimized for AI applications.
+Author-email: Arkadia Solutions <contact@arkadia.solutions>
+License-File: LICENCE
+Requires-Python: >=3.10
+Requires-Dist: dotenv>=0.9.9
+Requires-Dist: openai>=2.14.0
+Requires-Dist: pytest>=9.0.2
+Requires-Dist: tiktoken>=0.12.0
+Requires-Dist: toon-format
+Description-Content-Type: text/markdown
+
+# ARKADIA DATA
+
+```text
+                                   ; i  :J                                      
+                               U, .j..fraaM.  nl                                
+                            b h.obWMkkWWMMWMCdkvz,k                             
+                         ! .mQWM:o hiMoMW v.uaXMdohbi                           
+                        hI,MMmaIao.Wo .IMkoh FCMwqoXa                           
+                      ,.c.aWdM. d,aToW  .    Mb!. MopfQ.L                       
+                       jhj.xoM :k    aCu F: w MpmqMvMMI,I                       
+                      bzMhz:W    .Mw . o lYh ai M iMa pM.j                      
+                     hzqWWM;    M;o.WMWWMkMX f.a aa bModpo.                     
+                     ;tMbbv   xp oJMMWWWWMMMM iv  dLMXakM:T                     
+                       mdh        MMWWWWWWWbQLCzurjktvMor                       
+                      ,QFw ;M,b .MWWWWWWWMWMWd  xz   M,kd X                     
+                      qjMIo IMTW.WWWWWMWWWM.o.I   rpULaMdi.                     
+                       .mMM  uoWWWMWWWWWWp qM,,M l M;mMbrI                      
+                        f nm  MMW MWWjMuMj  I  o   LbMac                        
+                              WWdMWWWW Mv a.b..aauMhMwQf                        
+                              MoWWW,WWtjonJMWtoMdoaoMI                          
+                              MMMM Mi    xd:Mm tMwo Cr,                         
+                             xMMc .otqokWMMMao:oio.                             
+                             MW    .   C..MkTIo                                 
+                            WW                                                  
+                           QWM                                                  
+                           WW                                                   
+                          uMW                                                   
+                          WW                                                    
+                          MW
+```
+
+---
+
+> **The High-Density, Token-Efficient Data Protocol for Large Language Models.**
+> Stop wasting context window on JSON braces. `AK-DATA` is a unified, schema-first data format designed specifically for AI understanding. It offers up to **25% token savings**, faster parsing, and human-readable structure that LLMs love.
+
+---
+
+## 📦 Installation
+
+Get started immediately with pip:
+
+```bash
+pip install arkadia-data
+```
+
+## 🚀 Fast Example
+
+**Encoding to AK-DATA:**
+
+```bash
+echo '{ "data": 2}' | akd enc - -c
+# Output: <data:number>(2)
+
+```
+
+**Decoding back to JSON:**
+
+```bash
+echo '<data:number>(2)' | akd dec - -f json
+# Output: { "data": 2 }
+
+```
+
+---
+
+## ⚡ Performance & Token Savings
+
+Why switch? Because every token counts. `AKCD` (Arkadia Compressed Data) consistently outperforms standard formats in both token efficiency.
+
+```text
+BENCHMARK SUMMARY:
+
+
+   JSON  █████████████████████░░░░     6921 tok   ░░░░░░░░░░░░░░░░░░░░░░░░░     0.15 ms
+   AKCD  ████████████████░░░░░░░░░     5416 tok   █████████████████████████     4.40 ms
+   AKD   ███████████████████░░░░░░     6488 tok   ████████████████████████░     4.29 ms
+   TOON  █████████████████████████     8198 tok   █████████████░░░░░░░░░░░░     2.36 ms
+
+
+   FORMAT     TOKENS       TIME (Total)    AVG TIME/FILE   VS JSON
+   ----------------------------------------------------------------------
+   AKCD       5416             4.40 ms        0.37 ms    -21.7%
+   AKD        6488             4.29 ms        0.36 ms    -6.3%
+   JSON       6921             0.15 ms        0.01 ms    +0.0%
+   TOON       8198             2.36 ms        0.20 ms    +18.5%
+
+
+CONCLUSION: Switching to AKCD saves 1505 tokens (21.7%) compared to JSON.
+```
+
+---
+
+## 🛠 CLI Usage
+
+The package comes with a powerful CLI tool `akd` for encoding, decoding, and benchmarking.
+
+```text
+   Arkadia DATA TOOL
+   --------------------------------------------------
+   Unified interface for AK Data Format operations.
+
+USAGE:
+   ak-data / akd <command> [flags]
+
+COMMANDS:
+   enc             [ENCODE] Convert JSON/YAML/TOON to AK Data format
+   dec             [DECODE] Parse AK Data format back to JSON
+   benchmark       [BENCHMARK] Run performance and token usage tests
+   ai-benchmark    [AI] Run AI understanding tests (not implemented yet)
+
+GLOBAL OPTIONS:
+   -h, --help       Show this help message
+   -v, --version    Show version info
+
+```
+
+---
+
+## 📖 Syntax Specification (Current Version)
+
+This section describes the **actual, currently implemented** syntax of AI.DATA-FORMAT.
+
+### 1. Type Definition
+
+A type defines a name and an ordered list of fields. Comments are allowed within the definition to assist the LLM.
+
+```akd
+User</comment/ ={(23,"A",3) #tag1 #tag2} %[{ id: 4, b: "a", c: 43}]: id:number,
+b: string , c:number, >
+@Users
+<
+ @list 
+ a: number,
+ b: string
+>
+[
+  @size=5
+  /example list of values/
+
+  (1,`text`,5)
+  (2,`Text can be
+
+multiline
+`,5)
+  {
+    id:3,
+    b: "text"
+  }
+]
+
+```
+
+**Key Rules:**
+
+* The type name (`@Name`) is optional but recommended.
+* The header `<...>` defines field names and their order.
+* Comments (`/ ... /`) are **allowed** in the header.
+
+### 2. Data Structures
+
+The format supports compact positional records and explicit named records.
+
+| Structure | Syntax | Description |
+| --- | --- | --- |
+| **Positional Record** | `(a,b,c)` | Must follow the exact order of fields in the type header. |
+| **Named Record** | `{key:value}` | Keys must match field names. No spaces allowed in keys/values. |
+| **List** | `[ ... ]` | Contains positional or named records. |
+| **Multiline Text** | ``text`` | Ends with a line containing only a backtick. |
+
+### 3. Comments
+
+```akd
+/ this is a comment /
+
+```
+
+* Allowed **only** inside type definitions.
+* Forbidden in raw data blocks to save space.
+
+### 4. General Rules
+
+1. **Data must contain NO spaces.** (Compactness is priority).
+2. Schema/Type definitions **may** contain spaces and comments.
+3. Named fields always use `key:value` without spaces.
+4. Positional order must exactly match the declared order.
+
+### 5. Inline Type Usage
+
+You can declare a type and immediately use it:
+
+```akd
+@User<id:number name:string desc:string>
+
+value:@User(2,"Alice","Hello")
+value2:@User(3,"Bob","World")
+
+```
+
+### 6. Nested Types
+
+Currently, nested types are allowed as structural definitions:
+
+```akd
+@User<
+  id:string
+  name:string
+  profile: < level:number, score:number >
+>
+[
+  ("u1","Aga",{level:5,score:82})
+  ("u2","Marek",{level:7,score:91})
+]
+
+```
+
+---
+
+## 🔮 Futures / Roadmap
+
+The following features are planned for future releases and are **not yet implemented**.
+
+* **Modifiers:**
+* `!required` - field must be included.
+* `?empty` - field must not be empty.
+* `=value` - default value.
+* `N..M` - numeric range validation.
+
+
+* **Binary Data Types:**
+* Hex: `~[hex]1A0F4F~`
+* Base64: `~[b64]ADFKDXKZK...~`
+
+
+* **Pointers/References:**
+* Reference existing objects by ID: `(1, "Alex", *User[2])`
+
+
+## 📄 License
+
+This project is licensed under the [MIT License].
+
+---
+
+<div align="center">
+<sub>Built by <strong>Arkadia Solutions</strong>. Engineering the kernel of distributed intelligence.</sub>
+</div>