| Name | dbmaster JSON |
| Version |
0.2.0
JSON |
| download |
| home_page | None |
| Summary | Personal Quant Research Database Manager |
| upload_time | 2024-04-28 22:00:56 |
| maintainer | None |
| docs_url | None |
| author | None |
| requires_python | >=3.12 |
| license | Copyright (c) 2024 You Xie Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. |
| keywords |
quant research
personal database
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
numpy
pandas
pydantic
pydantic-settings
SQLAlchemy
fire
retry
python-binance
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# DBMaster
Personal Quant Research Database Manager
## Setup
Choose one of the below approaches to set up.
### A. Install from Pypi
For most of users, simply `pip install` in a **python3.12** environment: (`py3.10`, `py3.11` might work for now but don't guarantee in the future)
```bash
pip install dbmaster[binance]
```
Note: you can remove vendor-specific extra requirements if you don't need.
### B. Run source code
for developers, contributors, or users who want to have finer control over the code.
1. Clone this repo:
```bash
git clone https://github.com/xyshell/dbmaster
```
2. Create a `py3.12` virtual environment. if using conda:
```bash
conda create -n <name-your-py-env> python=3.12
```
```bash
conda activate <name-your-py-env>
```
3. install dependencies
```bash
pip install -r requirements.txt
```
4. development install
```bash
pip install -e .[dev]
```
### C. Install from github release
Find and download the last released package in https://github.com/xyshell/dbmaster/releases.
```bash
pip install dbmaster-x.y.z-py3-none-any.whl[binance]
```
## Hello World
Find location of site-packages by `pip show dbmaster`
Under `site-packages/dbmaster/`, rename `config_example.toml` to `config.toml` and modify the setting for your case. (or override environment variable `DBMASTER_CONFIG_PATH` to point to your modified `config.toml`)
See available commands by:
```bash
python -m dbmaster -h
```
Download data by:
```bash
python -m dbmaster update kline --vendor=binance --freq=1d --datefrom=2024-04-01 --symbol="['BTCUSDT', 'ETHUSDT']"
```
Check `/exmaple` for more usages.
Raw data
{
"_id": null,
"home_page": null,
"name": "dbmaster",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.12",
"maintainer_email": "You Xie <xyshell@bu.edu>",
"keywords": "quant research, personal database",
"author": null,
"author_email": "You Xie <xyshell@bu.edu>",
"download_url": null,
"platform": null,
"description": "# DBMaster\r\n\r\nPersonal Quant Research Database Manager\r\n\r\n## Setup \r\n\r\nChoose one of the below approaches to set up.\r\n\r\n### A. Install from Pypi\r\n\r\nFor most of users, simply `pip install` in a **python3.12** environment: (`py3.10`, `py3.11` might work for now but don't guarantee in the future)\r\n\r\n```bash\r\npip install dbmaster[binance]\r\n```\r\n\r\nNote: you can remove vendor-specific extra requirements if you don't need.\r\n\r\n\r\n### B. Run source code\r\n\r\nfor developers, contributors, or users who want to have finer control over the code.\r\n\r\n1. Clone this repo:\r\n\r\n```bash\r\ngit clone https://github.com/xyshell/dbmaster\r\n```\r\n\r\n2. Create a `py3.12` virtual environment. if using conda:\r\n\r\n```bash\r\nconda create -n <name-your-py-env> python=3.12\r\n```\r\n\r\n```bash\r\nconda activate <name-your-py-env>\r\n```\r\n\r\n3. install dependencies\r\n\r\n```bash\r\npip install -r requirements.txt\r\n```\r\n\r\n4. development install\r\n\r\n```bash\r\npip install -e .[dev]\r\n```\r\n\r\n### C. Install from github release\r\n\r\nFind and download the last released package in https://github.com/xyshell/dbmaster/releases.\r\n\r\n```bash\r\npip install dbmaster-x.y.z-py3-none-any.whl[binance]\r\n```\r\n\r\n## Hello World\r\n\r\nFind location of site-packages by `pip show dbmaster`\r\n\r\nUnder `site-packages/dbmaster/`, rename `config_example.toml` to `config.toml` and modify the setting for your case. (or override environment variable `DBMASTER_CONFIG_PATH` to point to your modified `config.toml`)\r\n\r\nSee available commands by:\r\n\r\n```bash\r\npython -m dbmaster -h\r\n```\r\n\r\nDownload data by:\r\n\r\n```bash\r\npython -m dbmaster update kline --vendor=binance --freq=1d --datefrom=2024-04-01 --symbol=\"['BTCUSDT', 'ETHUSDT']\"\r\n```\r\n\r\nCheck `/exmaple` for more usages.\r\n",
"bugtrack_url": null,
"license": "Copyright (c) 2024 You Xie Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the \"Software\"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. ",
"summary": "Personal Quant Research Database Manager",
"version": "0.2.0",
"project_urls": {
"Homepage": "https://github.com/xyshell/dbmaster"
},
"split_keywords": [
"quant research",
" personal database"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "f7cfca811432a08e7951e5dc4197ad61229694b367e897ce918e4db64ab78e25",
"md5": "c07e7656c3c1b54736af0eed57d4529c",
"sha256": "ff0c2b3b7affbbfd273a89b31ed61e2543df43804158706756d4d203c99322fe"
},
"downloads": -1,
"filename": "dbmaster-0.2.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "c07e7656c3c1b54736af0eed57d4529c",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.12",
"size": 18024,
"upload_time": "2024-04-28T22:00:56",
"upload_time_iso_8601": "2024-04-28T22:00:56.768748Z",
"url": "https://files.pythonhosted.org/packages/f7/cf/ca811432a08e7951e5dc4197ad61229694b367e897ce918e4db64ab78e25/dbmaster-0.2.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-04-28 22:00:56",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "xyshell",
"github_project": "dbmaster",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"requirements": [
{
"name": "numpy",
"specs": [
[
"==",
"1.26.4"
]
]
},
{
"name": "pandas",
"specs": [
[
"==",
"2.2.2"
]
]
},
{
"name": "pydantic",
"specs": [
[
"==",
"2.7.1"
]
]
},
{
"name": "pydantic-settings",
"specs": [
[
"==",
"2.2.1"
]
]
},
{
"name": "SQLAlchemy",
"specs": [
[
"==",
"2.0.29"
]
]
},
{
"name": "fire",
"specs": [
[
"==",
"0.6.0"
]
]
},
{
"name": "retry",
"specs": [
[
"==",
"0.9.2"
]
]
},
{
"name": "python-binance",
"specs": [
[
"==",
"1.0.19"
]
]
}
],
"lcname": "dbmaster"
}
