Merge pull request #1 from pyscal/copilot/add-knowledge-dictionary-package

Add knowledge_dictionary package structure with empty Python files

Author: srmnitc

README.md

@@ -1,2 +1,68 @@
 # knowledge_dictionary
-A python dictionary template for storing serialisable metadata
+
+A Python dictionary template for storing serializable metadata.
+
+## Installation
+
+Install from source:
+
+```bash
+pip install -e .
+```
+
+## Usage
+
+### Using Templates
+
+Import and use predefined dictionary templates:
+
+```python
+from knowledge_dictionary import KNOWLEDGE_TEMPLATE, MINIMAL_TEMPLATE, EXTENDED_TEMPLATE
+
+# Use a template directly
+my_data = KNOWLEDGE_TEMPLATE.copy()
+my_data['metadata']['author'] = 'John Doe'
+my_data['content']['title'] = 'My Knowledge'
+```
+
+### Using KnowledgeDict Class
+
+Work with knowledge dictionaries using the KnowledgeDict class:
+
+```python
+from knowledge_dictionary import KnowledgeDict
+
+# Create a new knowledge dictionary
+kd = KnowledgeDict(template="knowledge")
+
+# Set values using dot notation
+kd.set("metadata.author", "John Doe")
+kd.set("content.title", "My Knowledge")
+kd.set("content.description", "A collection of important information")
+
+# Get values
+author = kd.get("metadata.author")
+title = kd.get("content.title")
+
+# Convert to standard dictionary
+data = kd.to_dict()
+
+# Serialize to JSON
+json_str = kd.to_json(indent=2)
+
+# Save to file
+kd.save("my_knowledge.json")
+
+# Load from file
+kd_loaded = KnowledgeDict.load("my_knowledge.json")
+```
+
+## Available Templates
+
+- **KNOWLEDGE_TEMPLATE**: Standard template with metadata, content, and schema sections
+- **MINIMAL_TEMPLATE**: Minimal template with just title, description, and data
+- **EXTENDED_TEMPLATE**: Extended template with additional provenance tracking
+
+## License
+
+MIT License

knowledge_dictionary/__init__.py

@@ -0,0 +1 @@
+

knowledge_dictionary/knowledgedict.py

@@ -0,0 +1 @@
+

knowledge_dictionary/templates.py

@@ -0,0 +1 @@
+

pyproject.toml

@@ -0,0 +1,34 @@
+[build-system]
+requires = ["setuptools>=61.0", "wheel"]
+build-backend = "setuptools.build_meta"
+
+[project]
+name = "knowledge-dictionary"
+version = "0.1.0"
+description = "A Python dictionary template for storing serializable metadata"
+readme = "README.md"
+requires-python = ">=3.7"
+license = {file = "LICENSE"}
+authors = [
+    {name = "pyscal"},
+]
+classifiers = [
+    "Development Status :: 3 - Alpha",
+    "Intended Audience :: Developers",
+    "License :: OSI Approved :: MIT License",
+    "Programming Language :: Python :: 3",
+    "Programming Language :: Python :: 3.7",
+    "Programming Language :: Python :: 3.8",
+    "Programming Language :: Python :: 3.9",
+    "Programming Language :: Python :: 3.10",
+    "Programming Language :: Python :: 3.11",
+    "Programming Language :: Python :: 3.12",
+]
+keywords = ["dictionary", "metadata", "serialization", "knowledge"]
+
+[project.urls]
+"Homepage" = "https://github.com/pyscal/knowledge_dictionary"
+"Bug Tracker" = "https://github.com/pyscal/knowledge_dictionary/issues"
+
+[tool.setuptools]
+packages = ["knowledge_dictionary"]