pfeed 0.0.1__tar.gz
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- pfeed-0.0.1/LICENSE +201 -0
- pfeed-0.0.1/PKG-INFO +267 -0
- pfeed-0.0.1/README.md +231 -0
- pfeed-0.0.1/pfeed/__init__.py +62 -0
- pfeed-0.0.1/pfeed/cli/__init__.py +4 -0
- pfeed-0.0.1/pfeed/cli/commands/__init__.py +0 -0
- pfeed-0.0.1/pfeed/cli/commands/config.py +69 -0
- pfeed-0.0.1/pfeed/cli/commands/docker_compose.py +33 -0
- pfeed-0.0.1/pfeed/cli/commands/download.py +47 -0
- pfeed-0.0.1/pfeed/cli/commands/open.py +47 -0
- pfeed-0.0.1/pfeed/cli/commands/stream.py +0 -0
- pfeed-0.0.1/pfeed/cli/main.py +24 -0
- pfeed-0.0.1/pfeed/config_handler.py +148 -0
- pfeed-0.0.1/pfeed/const/common.py +15 -0
- pfeed-0.0.1/pfeed/const/paths.py +15 -0
- pfeed-0.0.1/pfeed/data_tools/data_tool_pandas.py +62 -0
- pfeed-0.0.1/pfeed/data_tools/data_tool_polars.py +65 -0
- pfeed-0.0.1/pfeed/datastore.py +145 -0
- pfeed-0.0.1/pfeed/etl.py +405 -0
- pfeed-0.0.1/pfeed/feeds/__init__.py +3 -0
- pfeed-0.0.1/pfeed/feeds/base_feed.py +296 -0
- pfeed-0.0.1/pfeed/feeds/binance_feed.py +21 -0
- pfeed-0.0.1/pfeed/feeds/bybit_feed.py +53 -0
- pfeed-0.0.1/pfeed/feeds/custom_csv_feed.py +13 -0
- pfeed-0.0.1/pfeed/feeds/yahoo_finance_feed.py +178 -0
- pfeed-0.0.1/pfeed/filepath.py +103 -0
- pfeed-0.0.1/pfeed/main.py +18 -0
- pfeed-0.0.1/pfeed/resolution.py +62 -0
- pfeed-0.0.1/pfeed/sources/binance/__init__.py +11 -0
- pfeed-0.0.1/pfeed/sources/binance/api.py +105 -0
- pfeed-0.0.1/pfeed/sources/binance/const.py +47 -0
- pfeed-0.0.1/pfeed/sources/binance/download.py +181 -0
- pfeed-0.0.1/pfeed/sources/binance/stream.py +3 -0
- pfeed-0.0.1/pfeed/sources/bybit/__init__.py +4 -0
- pfeed-0.0.1/pfeed/sources/bybit/api.py +76 -0
- pfeed-0.0.1/pfeed/sources/bybit/const.py +25 -0
- pfeed-0.0.1/pfeed/sources/bybit/download.py +196 -0
- pfeed-0.0.1/pfeed/sources/bybit/stream.py +3 -0
- pfeed-0.0.1/pfeed/sources/bybit/types.py +4 -0
- pfeed-0.0.1/pfeed/sources/bybit/utils.py +44 -0
- pfeed-0.0.1/pfeed/types/common_literals.py +13 -0
- pfeed-0.0.1/pfeed/utils/file_format.py +76 -0
- pfeed-0.0.1/pfeed/utils/monitor.py +21 -0
- pfeed-0.0.1/pfeed/utils/utils.py +122 -0
- pfeed-0.0.1/pfeed/utils/validate.py +39 -0
- pfeed-0.0.1/pyproject.toml +64 -0
pfeed-0.0.1/LICENSE
ADDED
|
@@ -0,0 +1,201 @@
|
|
|
1
|
+
Apache License
|
|
2
|
+
Version 2.0, January 2004
|
|
3
|
+
http://www.apache.org/licenses/
|
|
4
|
+
|
|
5
|
+
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
|
|
6
|
+
|
|
7
|
+
1. Definitions.
|
|
8
|
+
|
|
9
|
+
"License" shall mean the terms and conditions for use, reproduction,
|
|
10
|
+
and distribution as defined by Sections 1 through 9 of this document.
|
|
11
|
+
|
|
12
|
+
"Licensor" shall mean the copyright owner or entity authorized by
|
|
13
|
+
the copyright owner that is granting the License.
|
|
14
|
+
|
|
15
|
+
"Legal Entity" shall mean the union of the acting entity and all
|
|
16
|
+
other entities that control, are controlled by, or are under common
|
|
17
|
+
control with that entity. For the purposes of this definition,
|
|
18
|
+
"control" means (i) the power, direct or indirect, to cause the
|
|
19
|
+
direction or management of such entity, whether by contract or
|
|
20
|
+
otherwise, or (ii) ownership of fifty percent (50%) or more of the
|
|
21
|
+
outstanding shares, or (iii) beneficial ownership of such entity.
|
|
22
|
+
|
|
23
|
+
"You" (or "Your") shall mean an individual or Legal Entity
|
|
24
|
+
exercising permissions granted by this License.
|
|
25
|
+
|
|
26
|
+
"Source" form shall mean the preferred form for making modifications,
|
|
27
|
+
including but not limited to software source code, documentation
|
|
28
|
+
source, and configuration files.
|
|
29
|
+
|
|
30
|
+
"Object" form shall mean any form resulting from mechanical
|
|
31
|
+
transformation or translation of a Source form, including but
|
|
32
|
+
not limited to compiled object code, generated documentation,
|
|
33
|
+
and conversions to other media types.
|
|
34
|
+
|
|
35
|
+
"Work" shall mean the work of authorship, whether in Source or
|
|
36
|
+
Object form, made available under the License, as indicated by a
|
|
37
|
+
copyright notice that is included in or attached to the work
|
|
38
|
+
(an example is provided in the Appendix below).
|
|
39
|
+
|
|
40
|
+
"Derivative Works" shall mean any work, whether in Source or Object
|
|
41
|
+
form, that is based on (or derived from) the Work and for which the
|
|
42
|
+
editorial revisions, annotations, elaborations, or other modifications
|
|
43
|
+
represent, as a whole, an original work of authorship. For the purposes
|
|
44
|
+
of this License, Derivative Works shall not include works that remain
|
|
45
|
+
separable from, or merely link (or bind by name) to the interfaces of,
|
|
46
|
+
the Work and Derivative Works thereof.
|
|
47
|
+
|
|
48
|
+
"Contribution" shall mean any work of authorship, including
|
|
49
|
+
the original version of the Work and any modifications or additions
|
|
50
|
+
to that Work or Derivative Works thereof, that is intentionally
|
|
51
|
+
submitted to Licensor for inclusion in the Work by the copyright owner
|
|
52
|
+
or by an individual or Legal Entity authorized to submit on behalf of
|
|
53
|
+
the copyright owner. For the purposes of this definition, "submitted"
|
|
54
|
+
means any form of electronic, verbal, or written communication sent
|
|
55
|
+
to the Licensor or its representatives, including but not limited to
|
|
56
|
+
communication on electronic mailing lists, source code control systems,
|
|
57
|
+
and issue tracking systems that are managed by, or on behalf of, the
|
|
58
|
+
Licensor for the purpose of discussing and improving the Work, but
|
|
59
|
+
excluding communication that is conspicuously marked or otherwise
|
|
60
|
+
designated in writing by the copyright owner as "Not a Contribution."
|
|
61
|
+
|
|
62
|
+
"Contributor" shall mean Licensor and any individual or Legal Entity
|
|
63
|
+
on behalf of whom a Contribution has been received by Licensor and
|
|
64
|
+
subsequently incorporated within the Work.
|
|
65
|
+
|
|
66
|
+
2. Grant of Copyright License. Subject to the terms and conditions of
|
|
67
|
+
this License, each Contributor hereby grants to You a perpetual,
|
|
68
|
+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
|
69
|
+
copyright license to reproduce, prepare Derivative Works of,
|
|
70
|
+
publicly display, publicly perform, sublicense, and distribute the
|
|
71
|
+
Work and such Derivative Works in Source or Object form.
|
|
72
|
+
|
|
73
|
+
3. Grant of Patent License. Subject to the terms and conditions of
|
|
74
|
+
this License, each Contributor hereby grants to You a perpetual,
|
|
75
|
+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
|
76
|
+
(except as stated in this section) patent license to make, have made,
|
|
77
|
+
use, offer to sell, sell, import, and otherwise transfer the Work,
|
|
78
|
+
where such license applies only to those patent claims licensable
|
|
79
|
+
by such Contributor that are necessarily infringed by their
|
|
80
|
+
Contribution(s) alone or by combination of their Contribution(s)
|
|
81
|
+
with the Work to which such Contribution(s) was submitted. If You
|
|
82
|
+
institute patent litigation against any entity (including a
|
|
83
|
+
cross-claim or counterclaim in a lawsuit) alleging that the Work
|
|
84
|
+
or a Contribution incorporated within the Work constitutes direct
|
|
85
|
+
or contributory patent infringement, then any patent licenses
|
|
86
|
+
granted to You under this License for that Work shall terminate
|
|
87
|
+
as of the date such litigation is filed.
|
|
88
|
+
|
|
89
|
+
4. Redistribution. You may reproduce and distribute copies of the
|
|
90
|
+
Work or Derivative Works thereof in any medium, with or without
|
|
91
|
+
modifications, and in Source or Object form, provided that You
|
|
92
|
+
meet the following conditions:
|
|
93
|
+
|
|
94
|
+
(a) You must give any other recipients of the Work or
|
|
95
|
+
Derivative Works a copy of this License; and
|
|
96
|
+
|
|
97
|
+
(b) You must cause any modified files to carry prominent notices
|
|
98
|
+
stating that You changed the files; and
|
|
99
|
+
|
|
100
|
+
(c) You must retain, in the Source form of any Derivative Works
|
|
101
|
+
that You distribute, all copyright, patent, trademark, and
|
|
102
|
+
attribution notices from the Source form of the Work,
|
|
103
|
+
excluding those notices that do not pertain to any part of
|
|
104
|
+
the Derivative Works; and
|
|
105
|
+
|
|
106
|
+
(d) If the Work includes a "NOTICE" text file as part of its
|
|
107
|
+
distribution, then any Derivative Works that You distribute must
|
|
108
|
+
include a readable copy of the attribution notices contained
|
|
109
|
+
within such NOTICE file, excluding those notices that do not
|
|
110
|
+
pertain to any part of the Derivative Works, in at least one
|
|
111
|
+
of the following places: within a NOTICE text file distributed
|
|
112
|
+
as part of the Derivative Works; within the Source form or
|
|
113
|
+
documentation, if provided along with the Derivative Works; or,
|
|
114
|
+
within a display generated by the Derivative Works, if and
|
|
115
|
+
wherever such third-party notices normally appear. The contents
|
|
116
|
+
of the NOTICE file are for informational purposes only and
|
|
117
|
+
do not modify the License. You may add Your own attribution
|
|
118
|
+
notices within Derivative Works that You distribute, alongside
|
|
119
|
+
or as an addendum to the NOTICE text from the Work, provided
|
|
120
|
+
that such additional attribution notices cannot be construed
|
|
121
|
+
as modifying the License.
|
|
122
|
+
|
|
123
|
+
You may add Your own copyright statement to Your modifications and
|
|
124
|
+
may provide additional or different license terms and conditions
|
|
125
|
+
for use, reproduction, or distribution of Your modifications, or
|
|
126
|
+
for any such Derivative Works as a whole, provided Your use,
|
|
127
|
+
reproduction, and distribution of the Work otherwise complies with
|
|
128
|
+
the conditions stated in this License.
|
|
129
|
+
|
|
130
|
+
5. Submission of Contributions. Unless You explicitly state otherwise,
|
|
131
|
+
any Contribution intentionally submitted for inclusion in the Work
|
|
132
|
+
by You to the Licensor shall be under the terms and conditions of
|
|
133
|
+
this License, without any additional terms or conditions.
|
|
134
|
+
Notwithstanding the above, nothing herein shall supersede or modify
|
|
135
|
+
the terms of any separate license agreement you may have executed
|
|
136
|
+
with Licensor regarding such Contributions.
|
|
137
|
+
|
|
138
|
+
6. Trademarks. This License does not grant permission to use the trade
|
|
139
|
+
names, trademarks, service marks, or product names of the Licensor,
|
|
140
|
+
except as required for reasonable and customary use in describing the
|
|
141
|
+
origin of the Work and reproducing the content of the NOTICE file.
|
|
142
|
+
|
|
143
|
+
7. Disclaimer of Warranty. Unless required by applicable law or
|
|
144
|
+
agreed to in writing, Licensor provides the Work (and each
|
|
145
|
+
Contributor provides its Contributions) on an "AS IS" BASIS,
|
|
146
|
+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
|
|
147
|
+
implied, including, without limitation, any warranties or conditions
|
|
148
|
+
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
|
|
149
|
+
PARTICULAR PURPOSE. You are solely responsible for determining the
|
|
150
|
+
appropriateness of using or redistributing the Work and assume any
|
|
151
|
+
risks associated with Your exercise of permissions under this License.
|
|
152
|
+
|
|
153
|
+
8. Limitation of Liability. In no event and under no legal theory,
|
|
154
|
+
whether in tort (including negligence), contract, or otherwise,
|
|
155
|
+
unless required by applicable law (such as deliberate and grossly
|
|
156
|
+
negligent acts) or agreed to in writing, shall any Contributor be
|
|
157
|
+
liable to You for damages, including any direct, indirect, special,
|
|
158
|
+
incidental, or consequential damages of any character arising as a
|
|
159
|
+
result of this License or out of the use or inability to use the
|
|
160
|
+
Work (including but not limited to damages for loss of goodwill,
|
|
161
|
+
work stoppage, computer failure or malfunction, or any and all
|
|
162
|
+
other commercial damages or losses), even if such Contributor
|
|
163
|
+
has been advised of the possibility of such damages.
|
|
164
|
+
|
|
165
|
+
9. Accepting Warranty or Additional Liability. While redistributing
|
|
166
|
+
the Work or Derivative Works thereof, You may choose to offer,
|
|
167
|
+
and charge a fee for, acceptance of support, warranty, indemnity,
|
|
168
|
+
or other liability obligations and/or rights consistent with this
|
|
169
|
+
License. However, in accepting such obligations, You may act only
|
|
170
|
+
on Your own behalf and on Your sole responsibility, not on behalf
|
|
171
|
+
of any other Contributor, and only if You agree to indemnify,
|
|
172
|
+
defend, and hold each Contributor harmless for any liability
|
|
173
|
+
incurred by, or claims asserted against, such Contributor by reason
|
|
174
|
+
of your accepting any such warranty or additional liability.
|
|
175
|
+
|
|
176
|
+
END OF TERMS AND CONDITIONS
|
|
177
|
+
|
|
178
|
+
APPENDIX: How to apply the Apache License to your work.
|
|
179
|
+
|
|
180
|
+
To apply the Apache License to your work, attach the following
|
|
181
|
+
boilerplate notice, with the fields enclosed by brackets "[]"
|
|
182
|
+
replaced with your own identifying information. (Don't include
|
|
183
|
+
the brackets!) The text should be enclosed in the appropriate
|
|
184
|
+
comment syntax for the file format. We also recommend that a
|
|
185
|
+
file or class name and description of purpose be included on the
|
|
186
|
+
same "printed page" as the copyright notice for easier
|
|
187
|
+
identification within third-party archives.
|
|
188
|
+
|
|
189
|
+
Copyright [2024] [Stephen Yau, PFund.ai]
|
|
190
|
+
|
|
191
|
+
Licensed under the Apache License, Version 2.0 (the "License");
|
|
192
|
+
you may not use this file except in compliance with the License.
|
|
193
|
+
You may obtain a copy of the License at
|
|
194
|
+
|
|
195
|
+
http://www.apache.org/licenses/LICENSE-2.0
|
|
196
|
+
|
|
197
|
+
Unless required by applicable law or agreed to in writing, software
|
|
198
|
+
distributed under the License is distributed on an "AS IS" BASIS,
|
|
199
|
+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
200
|
+
See the License for the specific language governing permissions and
|
|
201
|
+
limitations under the License.
|
pfeed-0.0.1/PKG-INFO
ADDED
|
@@ -0,0 +1,267 @@
|
|
|
1
|
+
Metadata-Version: 2.1
|
|
2
|
+
Name: pfeed
|
|
3
|
+
Version: 0.0.1
|
|
4
|
+
Summary: Data pipeline for algo-trading, getting and storing both real-time and historical data made easy.
|
|
5
|
+
Home-page: https://pfund.ai
|
|
6
|
+
License: Apache-2.0
|
|
7
|
+
Keywords: trading,algo-trading,data pipeline,ETL,data lake,data warehouse,data integration,historical data,live data,data streaming
|
|
8
|
+
Author: Stephen Yau
|
|
9
|
+
Author-email: softwareentrepreneer+pfeed@gmail.com
|
|
10
|
+
Requires-Python: >=3.10,<3.13
|
|
11
|
+
Classifier: License :: OSI Approved :: Apache Software License
|
|
12
|
+
Classifier: Programming Language :: Python :: 3
|
|
13
|
+
Classifier: Programming Language :: Python :: 3.10
|
|
14
|
+
Classifier: Programming Language :: Python :: 3.11
|
|
15
|
+
Classifier: Programming Language :: Python :: 3.12
|
|
16
|
+
Provides-Extra: all
|
|
17
|
+
Provides-Extra: boost
|
|
18
|
+
Provides-Extra: data
|
|
19
|
+
Provides-Extra: df
|
|
20
|
+
Requires-Dist: beautifulsoup4 (>=4.12.3,<5.0.0)
|
|
21
|
+
Requires-Dist: connectorx (>=0.3.3,<0.4.0) ; extra == "boost" or extra == "all"
|
|
22
|
+
Requires-Dist: fastparquet (>=2024.5.0,<2025.0.0)
|
|
23
|
+
Requires-Dist: minio (>=7.2.8,<8.0.0) ; extra == "data" or extra == "all"
|
|
24
|
+
Requires-Dist: pandas (>=2.2.2,<3.0.0) ; extra == "df" or extra == "all"
|
|
25
|
+
Requires-Dist: pfund (>=0.0.1.dev13,<0.0.2)
|
|
26
|
+
Requires-Dist: polars (>=1.7.0,<2.0.0) ; extra == "df" or extra == "all"
|
|
27
|
+
Requires-Dist: psutil (>=6.0.0,<7.0.0) ; extra == "data" or extra == "all"
|
|
28
|
+
Requires-Dist: pyarrow (>=15.0.0,<16.0.0) ; extra == "df" or extra == "all"
|
|
29
|
+
Requires-Dist: ray (>=2.35.0,<3.0.0) ; extra == "boost" or extra == "all"
|
|
30
|
+
Requires-Dist: s3fs (>=2024.9.0,<2025.0.0) ; extra == "data" or extra == "all"
|
|
31
|
+
Requires-Dist: yfinance (>=0.2.43,<0.3.0)
|
|
32
|
+
Project-URL: Documentation, https://pfeed-docs.pfund.ai
|
|
33
|
+
Project-URL: Repository, https://github.com/PFund-Software-Ltd/pfeed
|
|
34
|
+
Description-Content-Type: text/markdown
|
|
35
|
+
|
|
36
|
+
# PFeed: Data Pipeline for Algo-Trading, Getting and Storing Real-Time and Historical Data Made Easy.
|
|
37
|
+
|
|
38
|
+
|
|
39
|
+
|
|
40
|
+
[](https://pypi.org/project/pfeed)
|
|
41
|
+
|
|
42
|
+
[](https://jupyterbook.org)
|
|
43
|
+
[](https://python-poetry.org/)
|
|
44
|
+
|
|
45
|
+
[MinIO]: https://min.io/
|
|
46
|
+
[PFund]: https://github.com/PFund-Software-Ltd/pfund
|
|
47
|
+
[Ray]: https://github.com/ray-project/ray
|
|
48
|
+
[Polars]: https://github.com/pola-rs/polars
|
|
49
|
+
[Prefect]: https://www.prefect.io
|
|
50
|
+
[Timescaledb]: https://www.timescale.com/
|
|
51
|
+
[Dask]: https://www.dask.org/
|
|
52
|
+
[Spark]: https://spark.apache.org/docs/latest/api/python/index.html
|
|
53
|
+
[DuckDB]: https://github.com/duckdb/duckdb
|
|
54
|
+
[Daft]: https://github.com/Eventual-Inc/Daft
|
|
55
|
+
[PyTrade.org]: https://pytrade.org
|
|
56
|
+
[Databento]: https://databento.com/
|
|
57
|
+
[Polygon]: https://polygon.io/
|
|
58
|
+
[Bybit]: https://bybit.com/
|
|
59
|
+
[FirstRate Data]: https://firstratedata.com
|
|
60
|
+
|
|
61
|
+
## Problem
|
|
62
|
+
Starting algo-trading requires reliable, clean data. However, the time-consuming and mundane tasks of data cleaning and storage often discourage traders from embarking on their algo-trading journey.
|
|
63
|
+
|
|
64
|
+
## Solution
|
|
65
|
+
By leveraging modern data engineering tools, `pfeed` handles the tedious data work and **outputs backtesting-ready data**, accelerating traders to get to the strategy development phase.
|
|
66
|
+
|
|
67
|
+
---
|
|
68
|
+
PFeed (/piː fiːd/) is a data pipeline for algorithmic trading, serving as a bridge between raw data sources and traders by automating the process of data collection, cleaning, transformation, and storage, loading clean data into a **local data lake for quantitative analysis**.
|
|
69
|
+
|
|
70
|
+
## Core Features
|
|
71
|
+
- [x] Unified approach for interacting with various [data sources](#supported-data-sources) and obtaining historical and live data
|
|
72
|
+
- [x] ETL data pipline for transforming raw data to clean data and storing it in [MinIO] (optional)
|
|
73
|
+
- [x] Fast data downloading, utilizing [Ray] for parallelization
|
|
74
|
+
- [x] Supports multiple data tools (e.g. Pandas, [Polars], [Dask], [Spark], [DuckDB], [Daft])
|
|
75
|
+
- [ ] Integrates with [Prefect] to control data flows
|
|
76
|
+
- [ ] Listens to PFund's trade engine and adds trade history to a local database [Timescaledb] (optional)
|
|
77
|
+
|
|
78
|
+
> It is designed to be used alongside [PFund] — A Complete Algo-Trading Framework for Machine Learning, TradFi, CeFi and DeFi ready.
|
|
79
|
+
|
|
80
|
+
---
|
|
81
|
+
|
|
82
|
+
<details>
|
|
83
|
+
<summary>Table of Contents</summary>
|
|
84
|
+
|
|
85
|
+
- [Installation](#installation)
|
|
86
|
+
- [Quick Start](#quick-start)
|
|
87
|
+
- [Main Usage: Data Feed](#main-usage-data-feed)
|
|
88
|
+
- [Download Historical Data on Command Line](#download-historical-data-on-command-line)
|
|
89
|
+
- [Download Historical Data in Python](#download-historical-data-in-python)
|
|
90
|
+
- [List Current Config](#list-current-config)
|
|
91
|
+
- [Run PFeed's docker-compose.yml](#run-pfeeds-docker-composeyml)
|
|
92
|
+
- [Supported Data Sources](#supported-data-sources)
|
|
93
|
+
- [Supported Data Tools](#supported-data-tools)
|
|
94
|
+
- [Related Projects](#related-projects)
|
|
95
|
+
- [Disclaimer](#disclaimer)
|
|
96
|
+
|
|
97
|
+
</details>
|
|
98
|
+
|
|
99
|
+
|
|
100
|
+
## Installation
|
|
101
|
+
### Using [Poetry](https://python-poetry.org) (Recommended)
|
|
102
|
+
```bash
|
|
103
|
+
# [RECOMMENDED]: Download data (e.g. Bybit and Yahoo Finance) + Data tools (e.g. pandas, polars) + Data storage (e.g. MinIO) + Boosted performance (e.g. Ray)
|
|
104
|
+
poetry add "pfeed[all]"
|
|
105
|
+
|
|
106
|
+
# [Download data + Data tools + Data storage]
|
|
107
|
+
poetry add "pfeed[df,data]"
|
|
108
|
+
|
|
109
|
+
# [Download data + Data tools]
|
|
110
|
+
poetry add "pfeed[df]"
|
|
111
|
+
|
|
112
|
+
# [Download data only]:
|
|
113
|
+
poetry add pfeed
|
|
114
|
+
|
|
115
|
+
# update to the latest version:
|
|
116
|
+
poetry update pfeed
|
|
117
|
+
```
|
|
118
|
+
|
|
119
|
+
### Using Pip
|
|
120
|
+
```bash
|
|
121
|
+
# same as above, you can choose to install "pfeed[all]", "pfeed[df,data]", "pfeed[df]" or "pfeed"
|
|
122
|
+
pip install "pfeed[all]"
|
|
123
|
+
|
|
124
|
+
# install the latest version:
|
|
125
|
+
pip install -U pfeed
|
|
126
|
+
```
|
|
127
|
+
|
|
128
|
+
### Checking your installation
|
|
129
|
+
```bash
|
|
130
|
+
$ pfeed --version
|
|
131
|
+
```
|
|
132
|
+
|
|
133
|
+
## Quick Start
|
|
134
|
+
### 1. Get Historical Data in Dataframe (No storage)
|
|
135
|
+
Get [Bybit]'s data in dataframe, e.g. 1-minute data (data is downloaded on the fly if not stored locally)
|
|
136
|
+
|
|
137
|
+
```python
|
|
138
|
+
import pfeed as pe
|
|
139
|
+
|
|
140
|
+
feed = pe.BybitFeed(data_tool='polars')
|
|
141
|
+
|
|
142
|
+
df = feed.get_historical_data(
|
|
143
|
+
'BTC_USDT_PERP',
|
|
144
|
+
resolution='1minute', # 'raw' or '1tick'/'1t' or '2second'/'2s' etc.
|
|
145
|
+
start_date='2024-03-01',
|
|
146
|
+
end_date='2024-03-01',
|
|
147
|
+
)
|
|
148
|
+
```
|
|
149
|
+
|
|
150
|
+
Printing the first few rows of `df`:
|
|
151
|
+
| | ts | product | resolution | open | high | low | close | volume |
|
|
152
|
+
|---:|:--------------------|:--------------|:-------------|--------:|--------:|--------:|--------:|---------:|
|
|
153
|
+
| 0 | 2024-03-01 00:00:00 | BTC_USDT_PERP | 1m | 61184.1 | 61244.5 | 61175.8 | 61244.5 | 159.142 |
|
|
154
|
+
| 1 | 2024-03-01 00:01:00 | BTC_USDT_PERP | 1m | 61245.3 | 61276.5 | 61200.7 | 61232.2 | 227.242 |
|
|
155
|
+
| 2 | 2024-03-01 00:02:00 | BTC_USDT_PERP | 1m | 61232.2 | 61249 | 61180 | 61184.2 | 91.446 |
|
|
156
|
+
|
|
157
|
+
> By using pfeed, you are just a few lines of code away from a standardized dataframe, how convenient!
|
|
158
|
+
|
|
159
|
+
|
|
160
|
+
|
|
161
|
+
### 2. Download Historical Data on the Command Line Interface (CLI)
|
|
162
|
+
```bash
|
|
163
|
+
# download data, default data type (dtype) is 'raw' data
|
|
164
|
+
pfeed download -d BYBIT -p BTC_USDT_PERP --start-date 2024-03-01 --end-date 2024-03-08
|
|
165
|
+
|
|
166
|
+
# download multiple products BTC_USDT_PERP and ETH_USDT_PERP and minute data
|
|
167
|
+
pfeed download -d BYBIT -p BTC_USDT_PERP -p ETH_USDT_PERP --dtypes minute
|
|
168
|
+
|
|
169
|
+
# download all perpetuals data from bybit
|
|
170
|
+
pfeed download -d BYBIT --ptypes PERP
|
|
171
|
+
|
|
172
|
+
# download all the data from bybit (CAUTION: your local machine probably won't have enough space for this!)
|
|
173
|
+
pfeed download -d BYBIT
|
|
174
|
+
|
|
175
|
+
# store data into MinIO (need to start MinIO by running `pfeed docker-compose up -d` first)
|
|
176
|
+
pfeed download -d BYBIT -p BTC_USDT_PERP --use-minio
|
|
177
|
+
|
|
178
|
+
# enable debug mode and turn off using Ray
|
|
179
|
+
pfeed download -d BYBIT -p BTC_USDT_PERP --debug --no-ray
|
|
180
|
+
```
|
|
181
|
+
|
|
182
|
+
### 3. Download Historical Data in Python
|
|
183
|
+
```python
|
|
184
|
+
import pfeed as pe
|
|
185
|
+
|
|
186
|
+
# compared to the CLI approach, this approach is more convenient for downloading multiple products
|
|
187
|
+
pe.download(
|
|
188
|
+
data_source='bybit',
|
|
189
|
+
pdts=[
|
|
190
|
+
'BTC_USDT_PERP',
|
|
191
|
+
'ETH_USDT_PERP',
|
|
192
|
+
'BCH_USDT_PERP',
|
|
193
|
+
],
|
|
194
|
+
dtypes=['raw'], # data types, e.g. 'raw', 'tick', 'second', 'minute' etc.
|
|
195
|
+
start_date='2024-03-01',
|
|
196
|
+
end_date='2024-03-08',
|
|
197
|
+
use_minio=False,
|
|
198
|
+
)
|
|
199
|
+
```
|
|
200
|
+
|
|
201
|
+
### List Current Config
|
|
202
|
+
```bash
|
|
203
|
+
# list the current config:
|
|
204
|
+
pfeed config --list
|
|
205
|
+
|
|
206
|
+
# change the data storage location to your local project's 'data' folder:
|
|
207
|
+
pfeed config --data-path ./data
|
|
208
|
+
|
|
209
|
+
# for more commands:
|
|
210
|
+
pfeed --help
|
|
211
|
+
```
|
|
212
|
+
|
|
213
|
+
### Run PFeed's docker-compose.yml
|
|
214
|
+
```bash
|
|
215
|
+
# same as 'docker-compose', only difference is it has pointed to pfeed's docker-compose.yml file
|
|
216
|
+
pfeed docker-compose [COMMAND]
|
|
217
|
+
|
|
218
|
+
# e.g. start services
|
|
219
|
+
pfeed docker-compose up -d
|
|
220
|
+
|
|
221
|
+
# e.g. stop services
|
|
222
|
+
pfeed docker-compose down
|
|
223
|
+
```
|
|
224
|
+
|
|
225
|
+
|
|
226
|
+
## Supported Data Sources
|
|
227
|
+
| Data Source | Get Historical Data | Download Historical Data | Get Live/Paper Data | Stream Live/Paper Data |
|
|
228
|
+
| ------------------------- | ------------------- | ------------------------ | ------------------- | ---------------------- |
|
|
229
|
+
| Yahoo Finance | 🟢 | ⚪ | ⚪ | ⚪ |
|
|
230
|
+
| Bybit | 🟢 | 🟢 | 🟡 | 🔴 |
|
|
231
|
+
| *Interactive Brokers (IB) | 🔴 | ⚪ | 🔴 | 🔴 |
|
|
232
|
+
| *[FirstRate Data] | 🔴 | 🔴 | ⚪ | ⚪ |
|
|
233
|
+
| [Databento] | 🔴 | 🔴 | 🔴 | 🔴 |
|
|
234
|
+
| [Polygon] | 🔴 | 🔴 | 🔴 | 🔴 |
|
|
235
|
+
| Binance | 🔴 | 🔴 | 🔴 | 🔴 |
|
|
236
|
+
| OKX | 🔴 | 🔴 | 🔴 | 🔴 |
|
|
237
|
+
|
|
238
|
+
🟢 = finished \
|
|
239
|
+
🟡 = in progress \
|
|
240
|
+
🔴 = todo \
|
|
241
|
+
⚪ = not applicable \
|
|
242
|
+
\* = paid data
|
|
243
|
+
|
|
244
|
+
|
|
245
|
+
## Supported Data Tools
|
|
246
|
+
| Data Tools | Supported |
|
|
247
|
+
| ------------------------ | --------- |
|
|
248
|
+
| Pandas | 🟢 |
|
|
249
|
+
| [Polars] | 🟢 |
|
|
250
|
+
| [Dask] | 🔴 |
|
|
251
|
+
| [Spark] | 🔴 |
|
|
252
|
+
| [DuckDB] | 🔴 |
|
|
253
|
+
| [Daft] | 🔴 |
|
|
254
|
+
|
|
255
|
+
|
|
256
|
+
## Related Projects
|
|
257
|
+
- [PFund] — A Complete Algo-Trading Framework for Machine Learning, TradFi, CeFi and DeFi ready. Supports Vectorized and Event-Driven Backtesting, Paper and Live Trading
|
|
258
|
+
- [PyTrade.org] - A curated list of Python libraries and resources for algorithmic trading.
|
|
259
|
+
|
|
260
|
+
|
|
261
|
+
## Disclaimer
|
|
262
|
+
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.
|
|
263
|
+
|
|
264
|
+
This framework is intended for educational and research purposes only. It should not be used for real trading without understanding the risks involved. Trading in financial markets involves significant risk, and there is always the potential for loss. Your trading results may vary. No representation is being made that any account will or is likely to achieve profits or losses similar to those discussed on this platform.
|
|
265
|
+
|
|
266
|
+
The developers of this framework are not responsible for any financial losses incurred from using this software. This includes but not limited to losses resulting from inaccuracies in any financial data output by PFeed. Users should conduct their due diligence, verify the accuracy of any data produced by PFeed, and consult with a professional financial advisor before engaging in real trading activities.
|
|
267
|
+
|