# srt-core
SolidRusT Core Libraries
## Overview
`srt-core` provides essential configuration management utilities for SolidRusT projects. This package helps load configurations from YAML files and environment variables, and it supports multiple language model providers.
## Installation
To install the package, use pip:
```sh
pip install srt-core
```
## Usage
Here is an example of how to use the `Config` class in your project:
```python
from srt_core.config import Config
config = Config()
# Access configuration variables
print(config.server_name)
print(config.default_llm_name)
```
Ensure you have a `config.yaml` file in the root of your project and necessary environment variables set:
```yaml
debug: true
llms:
default:
type: 'some_type'
filename: 'some_filename'
huggingface: 'some_model'
url: 'some_url'
agent_provider: 'some_provider'
# Add other LLM configurations here
personas:
Default:
theme: 'dark'
name: 'Default User'
title: 'User Title'
avatar: 'avatar.png'
description: 'Default user description'
system_message: 'System message for Default user'
persona: 'Persona message for Default user'
topic_examples: 'Topic examples for Default user'
temperature: 0.5
preferences: 'User preferences'
tokens_per_summary: 100
tokens_search_results: 50
number_of_search_results: 5
logs_path: './logs'
```
Set the environment variables:
```sh
export PERSONA='Default'
export PORT=8650
export SERVER_NAME='0.0.0.0'
```
## Contributing
We welcome contributions! Please follow these steps:
1. Fork the repository.
2. Create a new branch.
3. Make your changes.
4. Submit a pull request.
## License
This project is licensed under the MIT License. See the [LICENSE](LICENSE) file for details.
## Contact
For any inquiries or support, please contact [Your Name](mailto:suparious@solidrust.net).
Raw data
{
"_id": null,
"home_page": "https://github.com/SolidRusT/srt-core",
"name": "my-config-package",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.11",
"maintainer_email": null,
"keywords": null,
"author": "Your Name",
"author_email": "suparious@solidrust.net",
"download_url": "https://files.pythonhosted.org/packages/f4/90/a6eaeee88ebc72d0aa8f576d406f7b77f5f6b80e23b03111af51c7185c68/my_config_package-0.1.0.tar.gz",
"platform": null,
"description": "# srt-core\n\nSolidRusT Core Libraries\n\n## Overview\n\n`srt-core` provides essential configuration management utilities for SolidRusT projects. This package helps load configurations from YAML files and environment variables, and it supports multiple language model providers.\n\n## Installation\n\nTo install the package, use pip:\n\n```sh\npip install srt-core\n```\n\n## Usage\n\nHere is an example of how to use the `Config` class in your project:\n\n```python\nfrom srt_core.config import Config\n\nconfig = Config()\n\n# Access configuration variables\nprint(config.server_name)\nprint(config.default_llm_name)\n```\n\nEnsure you have a `config.yaml` file in the root of your project and necessary environment variables set:\n\n```yaml\ndebug: true\nllms:\n default:\n type: 'some_type'\n filename: 'some_filename'\n huggingface: 'some_model'\n url: 'some_url'\n agent_provider: 'some_provider'\n # Add other LLM configurations here\npersonas:\n Default:\n theme: 'dark'\n name: 'Default User'\n title: 'User Title'\n avatar: 'avatar.png'\n description: 'Default user description'\n system_message: 'System message for Default user'\n persona: 'Persona message for Default user'\n topic_examples: 'Topic examples for Default user'\n temperature: 0.5\n preferences: 'User preferences'\ntokens_per_summary: 100\ntokens_search_results: 50\nnumber_of_search_results: 5\nlogs_path: './logs'\n```\n\nSet the environment variables:\n\n```sh\nexport PERSONA='Default'\nexport PORT=8650\nexport SERVER_NAME='0.0.0.0'\n```\n\n## Contributing\n\nWe welcome contributions! Please follow these steps:\n\n1. Fork the repository.\n2. Create a new branch.\n3. Make your changes.\n4. Submit a pull request.\n\n## License\n\nThis project is licensed under the MIT License. See the [LICENSE](LICENSE) file for details.\n\n## Contact\n\nFor any inquiries or support, please contact [Your Name](mailto:suparious@solidrust.net).\n",
"bugtrack_url": null,
"license": null,
"summary": "SolidRusT Core Libraries",
"version": "0.1.0",
"project_urls": {
"Homepage": "https://github.com/SolidRusT/srt-core"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "b9958eb3846ceb2ea0127a18571b84e9c8fbe526c7028816d01dd52fdd5a5233",
"md5": "bdbc486c5f8dff1ec568a0d3063c2839",
"sha256": "1d82e06947b91c2576001d5248c316eea60a37354d9b4aa71f45ca29cdccf957"
},
"downloads": -1,
"filename": "my_config_package-0.1.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "bdbc486c5f8dff1ec568a0d3063c2839",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.11",
"size": 5293,
"upload_time": "2024-06-03T19:18:24",
"upload_time_iso_8601": "2024-06-03T19:18:24.653506Z",
"url": "https://files.pythonhosted.org/packages/b9/95/8eb3846ceb2ea0127a18571b84e9c8fbe526c7028816d01dd52fdd5a5233/my_config_package-0.1.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "f490a6eaeee88ebc72d0aa8f576d406f7b77f5f6b80e23b03111af51c7185c68",
"md5": "22e63ca44de89673a9eccddc84b1717d",
"sha256": "ef9d789d045e0ff1b341883d561bdae76bcad8565f76557c8e0d47b0cc118bcd"
},
"downloads": -1,
"filename": "my_config_package-0.1.0.tar.gz",
"has_sig": false,
"md5_digest": "22e63ca44de89673a9eccddc84b1717d",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.11",
"size": 4720,
"upload_time": "2024-06-03T19:18:26",
"upload_time_iso_8601": "2024-06-03T19:18:26.626599Z",
"url": "https://files.pythonhosted.org/packages/f4/90/a6eaeee88ebc72d0aa8f576d406f7b77f5f6b80e23b03111af51c7185c68/my_config_package-0.1.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-06-03 19:18:26",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "SolidRusT",
"github_project": "srt-core",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"requirements": [],
"lcname": "my-config-package"
}
JSON
