{"id":20493231,"url":"https://github.com/exios66/literary-vault","last_synced_at":"2025-07-01T14:06:18.742Z","repository":{"id":259678208,"uuid":"879167783","full_name":"Exios66/Literary-Vault","owner":"Exios66","description":"Active Catalog of the Documentation, Backend, and Infrastructure for Neuroscience Research Expansion. || [https://github.com/Exios66/truth-deception-architecture]","archived":false,"fork":false,"pushed_at":"2025-01-17T06:07:51.000Z","size":29409,"stargazers_count":4,"open_issues_count":15,"forks_count":3,"subscribers_count":2,"default_branch":"main","last_synced_at":"2025-03-05T17:47:57.712Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"https://morningstar-developments.gitbook.io/morningstar-docs-storage/","language":"HTML","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"other","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/Exios66.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null}},"created_at":"2024-10-27T07:13:50.000Z","updated_at":"2025-01-12T18:28:59.000Z","dependencies_parsed_at":"2024-10-27T09:39:50.347Z","dependency_job_id":"36be6870-7e32-4ddf-91f1-63c257fdb5db","html_url":"https://github.com/Exios66/Literary-Vault","commit_stats":null,"previous_names":["exios66/literary-vault"],"tags_count":4,"template":false,"template_full_name":null,"purl":"pkg:github/Exios66/Literary-Vault","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Exios66%2FLiterary-Vault","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Exios66%2FLiterary-Vault/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Exios66%2FLiterary-Vault/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Exios66%2FLiterary-Vault/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/Exios66","download_url":"https://codeload.github.com/Exios66/Literary-Vault/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Exios66%2FLiterary-Vault/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":262978564,"owners_count":23394008,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-11-15T17:33:57.539Z","updated_at":"2025-07-01T14:06:18.718Z","avatar_url":"https://github.com/Exios66.png","language":"HTML","funding_links":[],"categories":[],"sub_categories":[],"readme":"---\nicon: square-terminal\ncover: \u003e-\n  https://images.unsplash.com/photo-1505664194779-8beaceb93744?crop=entropy\u0026cs=srgb\u0026fm=jpg\u0026ixid=M3wxOTcwMjR8MHwxfHNlYXJjaHw2fHxsaWJyYXJ5fGVufDB8fHx8MTczMDAyMTMyNXww\u0026ixlib=rb-4.0.3\u0026q=85\ncoverY: 0\nlayout:\n  cover:\n    visible: true\n    size: full\n  title:\n    visible: true\n  description:\n    visible: true\n  tableOfContents:\n    visible: true\n  outline:\n    visible: true\n  pagination:\n    visible: true\n---\n\n## Literary Vault Documentation Guide\n\n[![Exios66 - Literary-Vault](https://img.shields.io/static/v1?label=Exios66\u0026message=Literary-Vault\u0026color=blueviolet\u0026logo=github)](https://github.com/Exios66/Literary-Vault \"Go to GitHub repo\")\n[![stars - Literary-Vault](https://img.shields.io/github/stars/Exios66/Literary-Vault?style=social)](https://github.com/Exios66/Literary-Vault)\n[![Docs - GitBook Dox](https://img.shields.io/badge/Docs-GitBook_Dox-brightgreen)](https://morningstar-developments.gitbook.io/morningstar-docs)\n[![Netlify Status](https://api.netlify.com/api/v1/badges/24407b52-da34-4fbb-89b8-781bc6183a32/deploy-status)](https://app.netlify.com/sites/morningstar-dev/deploys)\n![dependency - Python](https://img.shields.io/badge/dependency-Python-blue?logo=python\u0026logoColor=white)\n\n***\n\n# https://morningstar-developments.gitbook.io/morningstar-developments-publishing/\n\n## License\n\nReleased under [MIT](/LICENSE) by [@Exios66](https://github.com/Exios66).\n\n[![License](https://img.shields.io/badge/license-MIT-blue.svg)](LICENSE/)\n[![Commits](https://img.shields.io/github/commit-activity/m/Exios66/Literary-Vault.svg)](https://github.com/Exios66/Literary-Vault/commits/main)\n[![Issues](https://img.shields.io/github/issues/Exios66/Literary-Vault.svg)](https://github.com/Exios66/Literary-Vault/issues)\n[![Contributors](https://img.shields.io/github/contributors/Exios66/Literary-Vault.svg)](https://github.com/Exios66/Literary-Vault/graphs/contributors)\n[![Last Commit](https://img.shields.io/github/last-commit/Exios66/Literary-Vault.svg)](https://github.com/Exios66/Literary-Vault/commits/main)\n\n[![Made with Python](https://img.shields.io/badge/Python-3.8%2B-blue?logo=python\u0026logoColor=white)](https://www.python.org/)\n[![Flask](https://img.shields.io/badge/Flask-2.0+-black?logo=flask)](https://flask.palletsprojects.com/)\n[![HTML5](https://img.shields.io/badge/HTML-5-orange?logo=html5)](https://developer.mozilla.org/en-US/docs/Web/HTML)\n[![CSS3](https://img.shields.io/badge/CSS-3-blue?logo=css3\u0026logoColor=white)](https://developer.mozilla.org/en-US/docs/Web/CSS)\n[![JavaScript](https://img.shields.io/badge/JavaScript-ES6%2B-yellow?logo=javascript)](https://developer.mozilla.org/en-US/docs/Web/JavaScript)\n[![Markdown](https://img.shields.io/badge/Markdown-Documentation-lightgrey?logo=markdown)](https://www.markdownguide.org/)\n[![GitBook](https://img.shields.io/badge/Docs-GitBook-green?logo=gitbook)](https://www.gitbook.com/)\n[![GitHub Actions](https://img.shields.io/badge/CI-GitHub%20Actions-blue?logo=githubactions\u0026logoColor=white)](https://github.com/features/actions)\n[![Netlify](https://img.shields.io/badge/Deployed%20On-Netlify-blue?logo=netlify\u0026logoColor=white)](https://www.netlify.com/)\n\n## 🗂️ Repository Structure\n\n```bash\nliterary-vault/\n├── analysis/              # Detailed analysis of research papers\n│   ├── AI-Research/      # AI-related research analysis\n│   ├── EEG/             # EEG research analysis\n│   └── Manipulation-Deception/ # Studies on manipulation/deception\n├── docs/                 # Repository documentation\n│   ├── Analysis/        # Detailed research analysis\n│   ├── api/            # API documentation and implementation\n│   ├── Integration/    # Integration guides\n│   ├── openai-functions/ # OpenAI function schemas\n│   └── pdfs/           # PDF documentation\n├── external-resources/   # Additional resources\n│   ├── Math-PDFs/      # Mathematics resources\n│   └── questions/      # Question datasets\n├── scripts/             # Utility scripts\n├── CHANGELOG.md         # Project change history\n├── CONTRIBUTING.md      # Contribution guidelines\n├── LICENSE             # MIT License\n└── README.md           # Repository documentation\n```\n# Literary Vault\n\nAn active catalog and toolkit supporting neuroscience research with organized documentation, backend services, and infrastructure for comprehensive analysis and API services.\n\n## Table of Contents\n- [Overview](#overview)\n- [Features](#features)\n  - [Research Analysis](#research-analysis)\n  - [API Services](#api-services)\n  - [External Resources](#external-resources)\n  - [Integration Tools](#integration-tools)\n  - [Utility Scripts](#utility-scripts)\n- [Installation](#installation)\n- [Usage](#usage)\n- [Development](#development)\n- [Contribution Guidelines](#contribution-guidelines)\n- [License](#license)\n\n## Overview\n\nLiterary Vault is structured to support data-driven neuroscience research. It provides categorized research analysis, curated datasets, external resources, and REST APIs for accessing and managing these resources. With detailed integration tools and utility scripts, it is designed for scalable and secure deployment in research and development environments.\n\n## Features\n\n### Research Analysis\nThe repository organizes neuroscience-related research into well-defined categories:\n- **AI Research**: Covers neural networks, the ELIZA program, and neuropsychoanalysis.\n- **EEG Studies**: Includes cognitive load studies, VR integration, and research referenced in the *Oxford Handbook*.\n- **Manipulation/Deception Studies**: Focuses on models of persuasion and cognitive mechanisms behind deception.\n\n### API Services\n\n#### Questions API\nA REST API that allows categorized access to a curated dataset of questions on topics including astronomy, literature, mathematics, and general knowledge.\n- **Endpoints**:\n  - `GET /api/v1/questions/{category}` - Retrieve questions by category.\n  - `GET /api/v1/questions/{category}/random` - Fetch random questions from a specified category.\n  - `GET /api/v1/health` - Health check endpoint for service status.\n\n#### Changelog API\nProgrammatic management of the project's changelog, supporting:\n- Adding new entries\n- Creating releases\n- Querying the change history with schema validation for consistent format.\n\n### External Resources\nThe repository contains additional documentation and datasets to support research:\n- **Mathematics PDFs**: Mathematical references and learning material.\n- **Question Datasets**: Curated question sets in CSV format across various disciplines.\n\n### Integration Tools\nTools to simplify integrations:\n- **OpenAI Function Schemas**: Templates for OpenAI function integration.\n- **API Integration Guides**: Step-by-step guides to integrate with external APIs.\n- **Changelog Automation**: Scripts to automate changelog updates and versioning.\n\n### Utility Scripts\nScripts provided for streamlined repository management, including:\n- **Changelog Management**: Automates updating and versioning for changelog entries.\n- **API Launchers**: Scripts to start API servers.\n- **Documentation Generators**: Helps maintain and organize documentation.\n\n## Installation\n\n1. **Clone the repository**:\n   ```bash\n   git clone https://github.com/Exios66/Literary-Vault.git\n   cd Literary-Vault\n\n2.Install dependencies:\n\n```python\npip install -r requirements.txt\n```\n\n\n## Usage\n\n- Start API Servers\n\nRun API servers for different modules:\n\n# Start Questions API\npython docs/api/questions_api.py\n\n# Start Changelog API\npython docs/api/changelog_api.py\n\nChangelog Management\n\n\tUse the provided scripts to add entries or create releases:\n\n# Add an entry to the changelog\n\tpython scripts/update_changelog.py add \"Added\" \"Description of new feature\"\n\n# Create a release entry\n\tpython scripts/update_changelog.py release \"1.0.0\"\n\n## Access Question Datasets\n\n### The repository includes various question sets in CSV format, accessible either via the API or directly:\n\n\t•\tRefined_Astronomy_Questions.csv\n\t•\tRefined_Literature_Questions.csv\n\t•\tRefined_Mathematics_Questions.csv\n\t•\tRefined_General_Knowledge_Questions.csv\n\nDevelopment\n\n\t•\tPython: Ensure Python 3.x is installed.\n\t•\tFramework: FastAPI powers the API services.\n\t•\tJSON Validation: JSON schema validation is used across APIs.\n\t•\tDocumentation: Markdown format for documentation.\n\t•\tVersion Control: Use Git for tracking changes.\n\nContribution Guidelines\n\nWe welcome contributions to enhance the Literary Vault. Please follow these guidelines:\n\n\t1.\tFork the repository and create a new branch for your feature or bug fix.\n\t2.\tFollow existing naming conventions and structure.\n\t3.\tDocument any new additions or changes.\n\t4.\tSubmit a pull request with a clear description of the updates.\n\nFor more details, see CONTRIBUTING.md.\n\n## 📚 Components\n\n### 1. Analysis Directory\n\nComprehensive research analysis organized by topic:\n\n* AI Research (neural networks, ELIZA program, neuropsychoanalysis)\n* EEG Studies (cognitive load, VR integration, Oxford handbook)\n* Manipulation/Deception (persuasion models, cognitive mechanisms)\n\n### 2. API Services\n\n#### Questions API\n\nREST API for accessing curated question datasets:\n\n* Astronomy questions\n* Literature questions\n* Mathematics questions\n* General Knowledge questions\n\nFeatures:\n\n* Category-based retrieval\n* Random selection\n* Customizable limits\n* OpenAPI documentation\n\nEndpoints:\n\n```bash\nGET /api/v1/questions/{category}\nGET /api/v1/questions/{category}/random\nGET /api/v1/health\n```\n\n#### Changelog API\n\nProgrammatic changelog management:\n\n* Add entries\n* Create releases\n* Query history\n* Schema validation\n\n### 3. External Resources\n\n* Mathematics PDFs\n* Question datasets (CSV format)\n* Reference materials\n* Supplementary documentation\n\n### 4. Integration Tools\n\n* OpenAI function schemas\n* API integration guides\n* Changelog automation\n* Documentation templates\n\n### 5. Scripts\n\nUtility scripts for repository management:\n\n* Changelog management (cl)\n* API servers\n* Documentation generators\n* Integration tools\n\n## 🔧 Usage\n\n### 1. API Services\n\nStart the API servers:\n\n```bash\n# Questions API\npython docs/api/questions_api.py\n\n# Changelog API\npython docs/api/changelog_api.py\n```\n\nAccess documentation:\n\n* Questions API: \u003chttp://localhost:8000/docs\u003e\n* Changelog API: \u003chttp://localhost:8001/docs\u003e\n* Changelog Server API: \u003chttps://exios66.github.io/Literary-Vault/\u003e\n\n### 2. Changelog Management\n\n```bash\n# Add entry\npython scripts/update_changelog.py add \"Added\" \"New feature\"\n\n# Create release\npython scripts/update_changelog.py release \"1.0.0\"\n```\n\n### 3. Question Datasets\n\nAccess structured questions via API or direct CSV files:\n\n* Refined_Astronomy_Questions.csv\n* Refined_Literature_Questions.csv\n* Refined_Mathematics_Questions.csv\n* Refined_General Knowledge_Questions.csv\n\n## 📋 Guidelines\n\n* Follow API documentation\n* Use provided schemas\n* Update changelog\n* Maintain documentation\n* Follow naming conventions\n* Include proper citations\n\n## 🔒 Security\n\n* MIT License compliance\n* API authentication\n* Data validation\n* Error handling\n* Secure endpoints\n\n## 📚 Documentation\n\n* API Documentation (/docs/api/)\n* Integration Guides (/docs/Integration/)\n* OpenAI Schemas (/docs/openai-functions/)\n* Analysis Templates (/docs/Analysis/)\n\n## 🛠️ Development\n\n* Python 3.x required\n* FastAPI for APIs\n* JSON schema validation\n* Markdown documentation\n* Git integration\n\n## 🤝 Contributing\n\nSee [CONTRIBUTING.md](CONTRIBUTING.md) for guidelines.\n\n## 📄 License\n\nReleased under [MIT License](LICENSE).\n\n***\n\n### Last Updated: 2024-10-30\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fexios66%2Fliterary-vault","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fexios66%2Fliterary-vault","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fexios66%2Fliterary-vault/lists"}