# RoShareService
   
## 介绍
+ RoShareService是一个数据服务包，主要功能是为底层数据向外提供了一个接口服务,可实现用户权限验证和流量限制。roShareService采用Client-Server架构设计，服务端使用HTTP协议构建数据服务的OpenAPI,暂时采用GET-method；用户权限采用token机制。
## 安装
roShareService采用Python开发，得益于Python良好的社区环境，安装支持Pythonic风格的各种管理器。
```bash
$ pip install roshareservice-0.1.1-xxxxxxxxxxxx.whl
```
## 快速指南
### 服务端使用
+ 对于服务端数据服务启动，首先使用roShareService命令行进行元数据库初始化,然后再启动服务端服务。以下是roshareservicectl命令行示例：
```bash
$ roshareservicectl set-metadb
$ roshareservicectl start-service
```
## 设计
+ 采用Client-Server架构设计
+ 服务端使用HTTP协议构建数据服务的OpenAPI
+ 用户权限采用token机制
+ 用户流量限制
### 技术列表
+ 微服务-FastAPI
+ 加密验证-Token-JWT技术
+ 数据库-SQLite3
### 设计UML图
以下是设计的UML图：
Raw data
{
"_id": null,
"home_page": "https://github.com/redblue0216/RoShareService",
"name": "shihua-roshareservice",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.9.13",
"maintainer_email": "",
"keywords": "",
"author": "shihua",
"author_email": "15021408795@163.com",
"download_url": "https://files.pythonhosted.org/packages/2a/a1/25043468da4120331b1f141c0372943fdda1b68a9b11d1bd401d4e47e38b/shihua-roshareservice-0.1.1.tar.gz",
"platform": null,
"description": "# RoShareService\n\n   \n\n\n\n\n## \u4ecb\u7ecd\n+ RoShareService\u662f\u4e00\u4e2a\u6570\u636e\u670d\u52a1\u5305\uff0c\u4e3b\u8981\u529f\u80fd\u662f\u4e3a\u5e95\u5c42\u6570\u636e\u5411\u5916\u63d0\u4f9b\u4e86\u4e00\u4e2a\u63a5\u53e3\u670d\u52a1,\u53ef\u5b9e\u73b0\u7528\u6237\u6743\u9650\u9a8c\u8bc1\u548c\u6d41\u91cf\u9650\u5236\u3002roShareService\u91c7\u7528Client-Server\u67b6\u6784\u8bbe\u8ba1\uff0c\u670d\u52a1\u7aef\u4f7f\u7528HTTP\u534f\u8bae\u6784\u5efa\u6570\u636e\u670d\u52a1\u7684OpenAPI,\u6682\u65f6\u91c7\u7528GET-method\uff1b\u7528\u6237\u6743\u9650\u91c7\u7528token\u673a\u5236\u3002\n\n\n## \u5b89\u88c5\nroShareService\u91c7\u7528Python\u5f00\u53d1\uff0c\u5f97\u76ca\u4e8ePython\u826f\u597d\u7684\u793e\u533a\u73af\u5883\uff0c\u5b89\u88c5\u652f\u6301Pythonic\u98ce\u683c\u7684\u5404\u79cd\u7ba1\u7406\u5668\u3002\n\n```bash\n\t$ pip install roshareservice-0.1.1-xxxxxxxxxxxx.whl\n```\n\n\n## \u5feb\u901f\u6307\u5357\n### \u670d\u52a1\u7aef\u4f7f\u7528\n+ \u5bf9\u4e8e\u670d\u52a1\u7aef\u6570\u636e\u670d\u52a1\u542f\u52a8\uff0c\u9996\u5148\u4f7f\u7528roShareService\u547d\u4ee4\u884c\u8fdb\u884c\u5143\u6570\u636e\u5e93\u521d\u59cb\u5316,\u7136\u540e\u518d\u542f\u52a8\u670d\u52a1\u7aef\u670d\u52a1\u3002\u4ee5\u4e0b\u662froshareservicectl\u547d\u4ee4\u884c\u793a\u4f8b\uff1a\n\n```bash\n\t$ roshareservicectl set-metadb\n\n\t$ roshareservicectl start-service \n```\n\n\n## \u8bbe\u8ba1\n+ \u91c7\u7528Client-Server\u67b6\u6784\u8bbe\u8ba1\n+ \u670d\u52a1\u7aef\u4f7f\u7528HTTP\u534f\u8bae\u6784\u5efa\u6570\u636e\u670d\u52a1\u7684OpenAPI\n+ \u7528\u6237\u6743\u9650\u91c7\u7528token\u673a\u5236\n+ \u7528\u6237\u6d41\u91cf\u9650\u5236\n\n\n### \u6280\u672f\u5217\u8868\n+ \u5fae\u670d\u52a1-FastAPI\n+ \u52a0\u5bc6\u9a8c\u8bc1-Token-JWT\u6280\u672f\n+ \u6570\u636e\u5e93-SQLite3\n\n\n### \u8bbe\u8ba1UML\u56fe\n\u4ee5\u4e0b\u662f\u8bbe\u8ba1\u7684UML\u56fe\uff1a\n\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "roshareservice is a python sdk with chinese stock data service.",
"version": "0.1.1",
"project_urls": {
"Homepage": "https://github.com/redblue0216/RoShareService"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "2ee18c521e28583de181f1e9facd4e0096d1961109526de2adcfe9770ea57f93",
"md5": "1651b7cb171a90ef637f570750a456b6",
"sha256": "b6683fd57fe2b1c68d4cd7b11fa13c157a1602ea8a3ec6b6aa4319676c1da420"
},
"downloads": -1,
"filename": "shihua_roshareservice-0.1.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "1651b7cb171a90ef637f570750a456b6",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.9.13",
"size": 19840,
"upload_time": "2023-06-11T08:06:53",
"upload_time_iso_8601": "2023-06-11T08:06:53.487371Z",
"url": "https://files.pythonhosted.org/packages/2e/e1/8c521e28583de181f1e9facd4e0096d1961109526de2adcfe9770ea57f93/shihua_roshareservice-0.1.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "2aa125043468da4120331b1f141c0372943fdda1b68a9b11d1bd401d4e47e38b",
"md5": "4bf41fa3b5dd5b096d1793347ade688d",
"sha256": "55da11ff0a56ac6924cecf7761b85670ecc71bf414e6ffe6529056778ca8b331"
},
"downloads": -1,
"filename": "shihua-roshareservice-0.1.1.tar.gz",
"has_sig": false,
"md5_digest": "4bf41fa3b5dd5b096d1793347ade688d",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.9.13",
"size": 13851,
"upload_time": "2023-06-11T08:06:55",
"upload_time_iso_8601": "2023-06-11T08:06:55.435276Z",
"url": "https://files.pythonhosted.org/packages/2a/a1/25043468da4120331b1f141c0372943fdda1b68a9b11d1bd401d4e47e38b/shihua-roshareservice-0.1.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-06-11 08:06:55",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "redblue0216",
"github_project": "RoShareService",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"lcname": "shihua-roshareservice"
}
JSON
