kissbt 0.1.1__py3-none-any.whl

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.
kissbt/strategy.py ADDED
@@ -0,0 +1,98 @@
1
+ from abc import ABC, abstractmethod
2
+
3
+ import pandas as pd
4
+
5
+ from kissbt.broker import Broker
6
+
7
+
8
+ class Strategy(ABC):
9
+ """
10
+ Abstract base class for trading strategies in the kissbt backtesting framework.
11
+
12
+ This class serves as a template for implementing trading strategies. Subclasses must
13
+ implement the generate_orders() method to define the trading logic. The strategy
14
+ interacts with a broker instance to place orders and manage positions.
15
+
16
+ Attributes:
17
+ _broker (Broker): Trading broker instance for order execution and position
18
+ management
19
+ """
20
+
21
+ def __init__(self, broker: Broker) -> None:
22
+ """
23
+ Initialize the strategy with a broker instance.
24
+
25
+ Args:
26
+ broker: Broker instance for order execution
27
+
28
+ Raises:
29
+ TypeError: If broker is not an instance of Broker class
30
+ """
31
+ if not isinstance(broker, Broker):
32
+ raise TypeError("broker must be an instance of Broker")
33
+ self._broker = broker # Make broker protected
34
+ self.initialize()
35
+
36
+ def initialize(self) -> None:
37
+ """
38
+ Hook method for strategy initialization and parameter setup.
39
+
40
+ Override this method to set up strategy-specific parameters, indicators,
41
+ or other initialization logic. Called automatically after strategy creation.
42
+
43
+ Returns:
44
+ None
45
+ """
46
+ pass
47
+
48
+ @abstractmethod
49
+ def generate_orders(
50
+ self,
51
+ current_data: pd.DataFrame,
52
+ current_datetime: pd.Timestamp,
53
+ ) -> None:
54
+ """
55
+ Generate trading orders based on current market data and indicators.
56
+
57
+ This is the main method where trading logic should be implemented. It is called
58
+ for each bar in the backtest data sequence.
59
+
60
+ Args:
61
+ current_data: DataFrame containing market data and indicators for the
62
+ current bar. Index consists of ticker symbols. For single-asset
63
+ strategies, the DataFrame will have one row. For multi-asset strategies,
64
+ it contains data for all assets in the current universe.
65
+
66
+ Common columns include:
67
+ - open: Opening price
68
+ - high: High price
69
+ - low: Low price
70
+ - close: Closing price
71
+ - volume: Trading volume
72
+ - [custom]: Any additional indicators added during data preparation
73
+
74
+ current_datetime: Timestamp of the current bar, e.g. used for order timing
75
+
76
+ Returns:
77
+ None
78
+
79
+ Note:
80
+ - Orders are placed through the _broker instance using methods like:
81
+ create_market_order(), create_limit_order()
82
+ - Position and portfolio information can be accessed through the _broker
83
+ - Avoid look-ahead bias by only using data available at current_datetime
84
+ - All orders are processed at the next bar's prices (which price depends on
85
+ the order type)
86
+
87
+ Raises:
88
+ NotImplementedError: If the method is not implemented by subclass
89
+ """
90
+ raise NotImplementedError("Subclass must implement generate_orders()")
91
+
92
+ def __call__(self, *args, **kwargs) -> None:
93
+ """
94
+ Make strategy callable to generate orders.
95
+
96
+ Delegates to generate_orders() method.
97
+ """
98
+ self.generate_orders(*args, **kwargs)
@@ -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 2025 FinBlobs GmbH
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.
@@ -0,0 +1,346 @@
1
+ Metadata-Version: 2.2
2
+ Name: kissbt
3
+ Version: 0.1.1
4
+ Summary: The keep it simple backtesting framework for Python.
5
+ Author-email: Adrian Hasse <adrian.hasse@finblobs.com>
6
+ Maintainer-email: Adrian Hasse <adrian.hasse@finblobs.com>
7
+ License: Apache License
8
+ Version 2.0, January 2004
9
+ http://www.apache.org/licenses/
10
+
11
+ TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
12
+
13
+ 1. Definitions.
14
+
15
+ "License" shall mean the terms and conditions for use, reproduction,
16
+ and distribution as defined by Sections 1 through 9 of this document.
17
+
18
+ "Licensor" shall mean the copyright owner or entity authorized by
19
+ the copyright owner that is granting the License.
20
+
21
+ "Legal Entity" shall mean the union of the acting entity and all
22
+ other entities that control, are controlled by, or are under common
23
+ control with that entity. For the purposes of this definition,
24
+ "control" means (i) the power, direct or indirect, to cause the
25
+ direction or management of such entity, whether by contract or
26
+ otherwise, or (ii) ownership of fifty percent (50%) or more of the
27
+ outstanding shares, or (iii) beneficial ownership of such entity.
28
+
29
+ "You" (or "Your") shall mean an individual or Legal Entity
30
+ exercising permissions granted by this License.
31
+
32
+ "Source" form shall mean the preferred form for making modifications,
33
+ including but not limited to software source code, documentation
34
+ source, and configuration files.
35
+
36
+ "Object" form shall mean any form resulting from mechanical
37
+ transformation or translation of a Source form, including but
38
+ not limited to compiled object code, generated documentation,
39
+ and conversions to other media types.
40
+
41
+ "Work" shall mean the work of authorship, whether in Source or
42
+ Object form, made available under the License, as indicated by a
43
+ copyright notice that is included in or attached to the work
44
+ (an example is provided in the Appendix below).
45
+
46
+ "Derivative Works" shall mean any work, whether in Source or Object
47
+ form, that is based on (or derived from) the Work and for which the
48
+ editorial revisions, annotations, elaborations, or other modifications
49
+ represent, as a whole, an original work of authorship. For the purposes
50
+ of this License, Derivative Works shall not include works that remain
51
+ separable from, or merely link (or bind by name) to the interfaces of,
52
+ the Work and Derivative Works thereof.
53
+
54
+ "Contribution" shall mean any work of authorship, including
55
+ the original version of the Work and any modifications or additions
56
+ to that Work or Derivative Works thereof, that is intentionally
57
+ submitted to Licensor for inclusion in the Work by the copyright owner
58
+ or by an individual or Legal Entity authorized to submit on behalf of
59
+ the copyright owner. For the purposes of this definition, "submitted"
60
+ means any form of electronic, verbal, or written communication sent
61
+ to the Licensor or its representatives, including but not limited to
62
+ communication on electronic mailing lists, source code control systems,
63
+ and issue tracking systems that are managed by, or on behalf of, the
64
+ Licensor for the purpose of discussing and improving the Work, but
65
+ excluding communication that is conspicuously marked or otherwise
66
+ designated in writing by the copyright owner as "Not a Contribution."
67
+
68
+ "Contributor" shall mean Licensor and any individual or Legal Entity
69
+ on behalf of whom a Contribution has been received by Licensor and
70
+ subsequently incorporated within the Work.
71
+
72
+ 2. Grant of Copyright License. Subject to the terms and conditions of
73
+ this License, each Contributor hereby grants to You a perpetual,
74
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
75
+ copyright license to reproduce, prepare Derivative Works of,
76
+ publicly display, publicly perform, sublicense, and distribute the
77
+ Work and such Derivative Works in Source or Object form.
78
+
79
+ 3. Grant of Patent License. Subject to the terms and conditions of
80
+ this License, each Contributor hereby grants to You a perpetual,
81
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
82
+ (except as stated in this section) patent license to make, have made,
83
+ use, offer to sell, sell, import, and otherwise transfer the Work,
84
+ where such license applies only to those patent claims licensable
85
+ by such Contributor that are necessarily infringed by their
86
+ Contribution(s) alone or by combination of their Contribution(s)
87
+ with the Work to which such Contribution(s) was submitted. If You
88
+ institute patent litigation against any entity (including a
89
+ cross-claim or counterclaim in a lawsuit) alleging that the Work
90
+ or a Contribution incorporated within the Work constitutes direct
91
+ or contributory patent infringement, then any patent licenses
92
+ granted to You under this License for that Work shall terminate
93
+ as of the date such litigation is filed.
94
+
95
+ 4. Redistribution. You may reproduce and distribute copies of the
96
+ Work or Derivative Works thereof in any medium, with or without
97
+ modifications, and in Source or Object form, provided that You
98
+ meet the following conditions:
99
+
100
+ (a) You must give any other recipients of the Work or
101
+ Derivative Works a copy of this License; and
102
+
103
+ (b) You must cause any modified files to carry prominent notices
104
+ stating that You changed the files; and
105
+
106
+ (c) You must retain, in the Source form of any Derivative Works
107
+ that You distribute, all copyright, patent, trademark, and
108
+ attribution notices from the Source form of the Work,
109
+ excluding those notices that do not pertain to any part of
110
+ the Derivative Works; and
111
+
112
+ (d) If the Work includes a "NOTICE" text file as part of its
113
+ distribution, then any Derivative Works that You distribute must
114
+ include a readable copy of the attribution notices contained
115
+ within such NOTICE file, excluding those notices that do not
116
+ pertain to any part of the Derivative Works, in at least one
117
+ of the following places: within a NOTICE text file distributed
118
+ as part of the Derivative Works; within the Source form or
119
+ documentation, if provided along with the Derivative Works; or,
120
+ within a display generated by the Derivative Works, if and
121
+ wherever such third-party notices normally appear. The contents
122
+ of the NOTICE file are for informational purposes only and
123
+ do not modify the License. You may add Your own attribution
124
+ notices within Derivative Works that You distribute, alongside
125
+ or as an addendum to the NOTICE text from the Work, provided
126
+ that such additional attribution notices cannot be construed
127
+ as modifying the License.
128
+
129
+ You may add Your own copyright statement to Your modifications and
130
+ may provide additional or different license terms and conditions
131
+ for use, reproduction, or distribution of Your modifications, or
132
+ for any such Derivative Works as a whole, provided Your use,
133
+ reproduction, and distribution of the Work otherwise complies with
134
+ the conditions stated in this License.
135
+
136
+ 5. Submission of Contributions. Unless You explicitly state otherwise,
137
+ any Contribution intentionally submitted for inclusion in the Work
138
+ by You to the Licensor shall be under the terms and conditions of
139
+ this License, without any additional terms or conditions.
140
+ Notwithstanding the above, nothing herein shall supersede or modify
141
+ the terms of any separate license agreement you may have executed
142
+ with Licensor regarding such Contributions.
143
+
144
+ 6. Trademarks. This License does not grant permission to use the trade
145
+ names, trademarks, service marks, or product names of the Licensor,
146
+ except as required for reasonable and customary use in describing the
147
+ origin of the Work and reproducing the content of the NOTICE file.
148
+
149
+ 7. Disclaimer of Warranty. Unless required by applicable law or
150
+ agreed to in writing, Licensor provides the Work (and each
151
+ Contributor provides its Contributions) on an "AS IS" BASIS,
152
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
153
+ implied, including, without limitation, any warranties or conditions
154
+ of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
155
+ PARTICULAR PURPOSE. You are solely responsible for determining the
156
+ appropriateness of using or redistributing the Work and assume any
157
+ risks associated with Your exercise of permissions under this License.
158
+
159
+ 8. Limitation of Liability. In no event and under no legal theory,
160
+ whether in tort (including negligence), contract, or otherwise,
161
+ unless required by applicable law (such as deliberate and grossly
162
+ negligent acts) or agreed to in writing, shall any Contributor be
163
+ liable to You for damages, including any direct, indirect, special,
164
+ incidental, or consequential damages of any character arising as a
165
+ result of this License or out of the use or inability to use the
166
+ Work (including but not limited to damages for loss of goodwill,
167
+ work stoppage, computer failure or malfunction, or any and all
168
+ other commercial damages or losses), even if such Contributor
169
+ has been advised of the possibility of such damages.
170
+
171
+ 9. Accepting Warranty or Additional Liability. While redistributing
172
+ the Work or Derivative Works thereof, You may choose to offer,
173
+ and charge a fee for, acceptance of support, warranty, indemnity,
174
+ or other liability obligations and/or rights consistent with this
175
+ License. However, in accepting such obligations, You may act only
176
+ on Your own behalf and on Your sole responsibility, not on behalf
177
+ of any other Contributor, and only if You agree to indemnify,
178
+ defend, and hold each Contributor harmless for any liability
179
+ incurred by, or claims asserted against, such Contributor by reason
180
+ of your accepting any such warranty or additional liability.
181
+
182
+ END OF TERMS AND CONDITIONS
183
+
184
+ APPENDIX: How to apply the Apache License to your work.
185
+
186
+ To apply the Apache License to your work, attach the following
187
+ boilerplate notice, with the fields enclosed by brackets "[]"
188
+ replaced with your own identifying information. (Don't include
189
+ the brackets!) The text should be enclosed in the appropriate
190
+ comment syntax for the file format. We also recommend that a
191
+ file or class name and description of purpose be included on the
192
+ same "printed page" as the copyright notice for easier
193
+ identification within third-party archives.
194
+
195
+ Copyright 2025 FinBlobs GmbH
196
+
197
+ Licensed under the Apache License, Version 2.0 (the "License");
198
+ you may not use this file except in compliance with the License.
199
+ You may obtain a copy of the License at
200
+
201
+ http://www.apache.org/licenses/LICENSE-2.0
202
+
203
+ Unless required by applicable law or agreed to in writing, software
204
+ distributed under the License is distributed on an "AS IS" BASIS,
205
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
206
+ See the License for the specific language governing permissions and
207
+ limitations under the License.
208
+
209
+ Project-URL: homepage, https://github.com/FinBlobs/kissbt
210
+ Project-URL: bug-tracker, https://github.com/FinBlobs/kissbt/issues
211
+ Classifier: Programming Language :: Python :: 3
212
+ Classifier: License :: OSI Approved :: Apache Software License
213
+ Classifier: Operating System :: OS Independent
214
+ Requires-Python: >=3.10
215
+ Description-Content-Type: text/markdown
216
+ License-File: LICENSE
217
+ Requires-Dist: numpy
218
+ Requires-Dist: pandas
219
+ Requires-Dist: matplotlib
220
+ Provides-Extra: dev
221
+ Requires-Dist: pytest; extra == "dev"
222
+ Requires-Dist: pytest-mock; extra == "dev"
223
+ Requires-Dist: flake8; extra == "dev"
224
+ Requires-Dist: black; extra == "dev"
225
+ Requires-Dist: isort; extra == "dev"
226
+ Requires-Dist: yfinance; extra == "dev"
227
+ Requires-Dist: pyarrow; extra == "dev"
228
+
229
+ # kissbt
230
+
231
+ **kissbt**, the `keep it simple` backtesting framework, is a lightweight and user-friendly Python framework for backtesting trading strategies. It focuses on simplicity, performance, and ease of extensibility while providing essential tools for effective backtesting.
232
+
233
+ ## Why kissbt?
234
+
235
+ - **🚀 Lightweight** – Minimal dependencies ensure fast installation and execution.
236
+ - **📖 Simple API** – Lowers the barrier for traders new to backtesting.
237
+ - **🔌 Extensible** – Modular architecture enables easy customization.
238
+ - **📊 Essential Features** – Includes tools for data handling, strategy implementation, and performance evaluation.
239
+
240
+ ## Features
241
+
242
+ ✔️ Object-oriented design for intuitive strategy development
243
+ ✔️ Fast execution, even for large universes
244
+ ✔️ Supports long and short positions
245
+ ✔️ Built-in trade execution, position tracking, and P&L calculation
246
+ ✔️ Performance analysis with key trading metrics
247
+ ✔️ Backtesting with historical market data
248
+ ✔️ Modular components (Strategy, Broker, Engine, Analyzer)
249
+
250
+ ## Installation
251
+
252
+ You can install `kissbt` using either `pip` or `conda`.
253
+
254
+ ### Using pip
255
+
256
+ To install `kissbt` via `pip`, run the following command:
257
+
258
+ ```sh
259
+ pip install kissbt
260
+ ```
261
+
262
+ ### Using conda
263
+
264
+ To install `kissbt` via `conda`, run the following command:
265
+
266
+ ```sh
267
+ conda install kissbt
268
+ ```
269
+
270
+ ## Usage
271
+
272
+ ### 1. Define a Strategy
273
+
274
+ Create a custom strategy by extending the `Strategy` class and implementing the `generate_orders` method:
275
+
276
+ ```python
277
+ from kissbt.strategy import Strategy
278
+ from kissbt.entities import Order, OrderType
279
+
280
+ class MyStrategy(Strategy):
281
+ def generate_orders(self, current_data, current_datetime):
282
+ # Example: Buy if the close price is above the 128-day SMA
283
+ for ticker in current_data.index:
284
+ close_price = current_data.loc[ticker, "close"]
285
+ sma_128 = current_data.loc[ticker, "sma_128"]
286
+ if close_price > sma_128:
287
+ order = Order(ticker=ticker, size=10, order_type=OrderType.OPEN)
288
+ self._broker.place_order(order)
289
+ ```
290
+
291
+ ### 2. Set Up the Broker
292
+
293
+ Initialize the `Broker` with starting capital, fees, and other parameters:
294
+
295
+ ```python
296
+ from kissbt.broker import Broker
297
+
298
+ broker = Broker(start_capital=100000, fees=0.001)
299
+ ```
300
+
301
+ ### 3. Run the Backtest
302
+
303
+ Use the `Engine` to run the backtest with your strategy and market data:
304
+
305
+ ```python
306
+ from kissbt.engine import Engine
307
+ import pandas as pd
308
+
309
+ # Load market data
310
+ data = pd.read_csv('market_data.csv', parse_dates=['date'])
311
+
312
+ # Initialize strategy and engine
313
+ strategy = MyStrategy(broker)
314
+ engine = Engine(broker, strategy)
315
+
316
+ # Run the backtest
317
+ engine.run(data)
318
+ ```
319
+
320
+ ### 4. Analyze Performance
321
+
322
+ Use the `Analyzer` to calculate and display performance metrics:
323
+
324
+ ```python
325
+ from kissbt.analyzer import Analyzer
326
+
327
+ analyzer = Analyzer(broker)
328
+ metrics = analyzer.get_performance_metrics()
329
+ print(metrics)
330
+ ```
331
+
332
+ ## Examples
333
+
334
+ Check out the `examples` directory for more detailed examples and use cases.
335
+
336
+ ## License
337
+
338
+ This project is licensed under the Apache License 2.0. See the [LICENSE](LICENSE) file for details.
339
+
340
+ ## Contributing
341
+
342
+ We welcome contributions! If you have ideas, bug fixes, or feature requests, feel free to open an issue or submit a pull request.
343
+
344
+ ## Contact
345
+
346
+ For any questions or inquiries, please contact Adrian Hasse at adrian.hasse@finblobs.com.
@@ -0,0 +1,11 @@
1
+ kissbt/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
2
+ kissbt/analyzer.py,sha256=n4RZsAu2hYZmYjtXfodKDCdCeTIqn29Stteh2DOZsds,14009
3
+ kissbt/broker.py,sha256=HSdJLaXfn_cCnW3VGGORD5ieVDtCJ4cFpisbqpAiRtg,23186
4
+ kissbt/engine.py,sha256=MeRhCGkDn-BPWPLsJgiIIK-695hdJM_9DegYgKWKxsw,978
5
+ kissbt/entities.py,sha256=SccTgLPU3Fd3JJMul5-x3_1ZXeX7EwwfpQTETqWWV9Q,1942
6
+ kissbt/strategy.py,sha256=eblYpO8_daQG7xLGMX-ejoLdGt7VtDRM6GU1gsGTYRY,3408
7
+ kissbt-0.1.1.dist-info/LICENSE,sha256=_GKyfzDdVHMUQWxpWL8ywZTBseAJGUhjMhYn-CHJtko,11343
8
+ kissbt-0.1.1.dist-info/METADATA,sha256=HOlXLn9rmAQaWNEJ36rUetNPzWabODNtM91t9uEhofc,17265
9
+ kissbt-0.1.1.dist-info/WHEEL,sha256=In9FTNxeP60KnTkGw7wk6mJPYd_dQSjEZmXdBdMCI-8,91
10
+ kissbt-0.1.1.dist-info/top_level.txt,sha256=C0fXgJnoBmNvgGwD-KpJ1rVkdOx8zJey9SD4kbMv3Sk,7
11
+ kissbt-0.1.1.dist-info/RECORD,,
@@ -0,0 +1,5 @@
1
+ Wheel-Version: 1.0
2
+ Generator: setuptools (75.8.0)
3
+ Root-Is-Purelib: true
4
+ Tag: py3-none-any
5
+
@@ -0,0 +1 @@
1
+ kissbt