Released under MIT by @Exios66.
literary-vault/
├── analysis/ # Detailed analysis of research papers
│ ├── AI-Research/ # AI-related research analysis
│ ├── EEG/ # EEG research analysis
│ └── Manipulation-Deception/ # Studies on manipulation/deception
├── docs/ # Repository documentation
│ ├── Analysis/ # Detailed research analysis
│ ├── api/ # API documentation and implementation
│ ├── Integration/ # Integration guides
│ ├── openai-functions/ # OpenAI function schemas
│ └── pdfs/ # PDF documentation
├── external-resources/ # Additional resources
│ ├── Math-PDFs/ # Mathematics resources
│ └── questions/ # Question datasets
├── scripts/ # Utility scripts
├── CHANGELOG.md # Project change history
├── CONTRIBUTING.md # Contribution guidelines
├── LICENSE # MIT License
└── README.md # Repository documentation
An active catalog and toolkit supporting neuroscience research with organized documentation, backend services, and infrastructure for comprehensive analysis and API services.
Literary 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.
The repository organizes neuroscience-related research into well-defined categories:
A REST API that allows categorized access to a curated dataset of questions on topics including astronomy, literature, mathematics, and general knowledge.
GET /api/v1/questions/{category}
- Retrieve questions by category.GET /api/v1/questions/{category}/random
- Fetch random questions from a specified category.GET /api/v1/health
- Health check endpoint for service status.Programmatic management of the project's changelog, supporting:
The repository contains additional documentation and datasets to support research:
Tools to simplify integrations:
Scripts provided for streamlined repository management, including:
git clone https://github.com/Exios66/Literary-Vault.git
cd Literary-Vault
2.Install dependencies:
pip install -r requirements.txt
Run API servers for different modules:
python docs/api/questions_api.py
python docs/api/changelog_api.py
Changelog Management
Use the provided scripts to add entries or create releases:
python scripts/update_changelog.py add "Added" "Description of new feature"
python scripts/update_changelog.py release "1.0.0"
• Refined_Astronomy_Questions.csv
• Refined_Literature_Questions.csv
• Refined_Mathematics_Questions.csv
• Refined_General_Knowledge_Questions.csv
Development
• Python: Ensure Python 3.x is installed.
• Framework: FastAPI powers the API services.
• JSON Validation: JSON schema validation is used across APIs.
• Documentation: Markdown format for documentation.
• Version Control: Use Git for tracking changes.
Contribution Guidelines
We welcome contributions to enhance the Literary Vault. Please follow these guidelines:
1. Fork the repository and create a new branch for your feature or bug fix.
2. Follow existing naming conventions and structure.
3. Document any new additions or changes.
4. Submit a pull request with a clear description of the updates.
For more details, see CONTRIBUTING.md.
License
This project is licensed under the MIT License. See the LICENSE file for details.
Last updated on October 28, 2024
Comprehensive research analysis organized by topic:
REST API for accessing curated question datasets:
Features:
Endpoints:
GET /api/v1/questions/{category}
GET /api/v1/questions/{category}/random
GET /api/v1/health
Programmatic changelog management:
Utility scripts for repository management:
Start the API servers:
# Questions API
python docs/api/questions_api.py
# Changelog API
python docs/api/changelog_api.py
Access documentation:
# Add entry
python scripts/update_changelog.py add "Added" "New feature"
# Create release
python scripts/update_changelog.py release "1.0.0"
Access structured questions via API or direct CSV files:
See CONTRIBUTING.md for guidelines.
Released under MIT License.