openseries 0.14.0__py3-none-any.whl → 1.0.1__py3-none-any.whl

openseries/types.py

@@ -1,5 +1,5 @@
 """
-Declaring types used througout the project
+Declaring types used throughout the project
 """
 from typing import Literal, List
 from pydantic import BaseModel

{openseries-0.14.0.dist-info → openseries-1.0.1.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: openseries
-Version: 0.14.0
+Version: 1.0.1
 Summary: Package for simple financial time series analysis.
 Home-page: https://github.com/CaptorAB/OpenSeries
 License: BSD-3-Clause
@@ -27,10 +27,8 @@ Requires-Dist: plotly (>=5.15.0,<6.0.0)
 Requires-Dist: pydantic (>=1.10.11,<2.0.0)
 Requires-Dist: python-dateutil (>=2.8.2,<3.0.0)
 Requires-Dist: python-stdnum (>=1.18,<2.0)
-Requires-Dist: requests (>=2.28.1,<3.0.0)
 Requires-Dist: scipy (>=1.11.1,<2.0.0)
 Requires-Dist: statsmodels (>=0.13.5,<0.14.0)
-Requires-Dist: urllib3 (>=1.26.9,<2.0.0)
 Project-URL: Repository, https://github.com/CaptorAB/OpenSeries
 Description-Content-Type: text/markdown
 
@@ -50,7 +48,7 @@ width="81" height="100" align="left" float="right"/><br/>
 ![pylint](https://github.com/CaptorAB/OpenSeries/actions/workflows/pylint.yml/badge.svg)
 [![License](https://img.shields.io/badge/License-BSD%203--Clause-blue.svg)](https://opensource.org/licenses/BSD-3-Clause)
 
-**OpenSeries** is a project with tools to perform timeseries analysis on a single
+**OpenSeries** is a project with tools to analyse financial timeseries of a single
 asset or a group of assets. It is solely made for daily or less frequent data.
 
 <span style="font-size:2em;">[Changelog](https://github.com/CaptorAB/OpenSeries/blob/master/CHANGELOG.md)</span>
@@ -64,8 +62,12 @@ To install:
 pip install openseries
 ```
 
-An overview of an OpenTimeSeries object is shown in the below example. My preference
-is to instantiate an object from a constructing class methods such as this.
+An overview of an OpenTimeSeries object is shown in the below example. It shows how to
+create an object from a constructing classmethod. The design aligns with how we within
+our fund company's code base have a subclass of OpenTimeSeries with class methods
+for our different data sources. Combined with some additional tools it allows us to
+efficiently present investment cases to clients.
+
 The OpenTimeSeries and OpenFrame classes are both subclasses of
 the [Pydantic BaseModel](https://docs.pydantic.dev/usage/models/).
 
@@ -75,16 +77,16 @@ and [OpenFrame](https://github.com/CaptorAB/OpenSeries/blob/master/openseries/fr
 classes have an attribute `tsdf`
 which is a DataFrame constructed from the raw data in the lists `dates` and `values`.
 
-```
+```python
 from openseries.series import OpenTimeSeries
-```
+import yfinance as yf
+
+msft=yf.Ticker("MSFT")
+history=msft.history(period="max")
+series=OpenTimeSeries.from_df(history.loc[:, "Close"])
+_=series.value_to_log().set_new_label("Microsoft Log Returns of Close Prices")
+_,_=series.plot_series()
 
-```
-series = OpenTimeSeries.from_arrays(
-    name="Timeseries",
-    dates=["2023-05-08", "2023-05-09", "2023-05-10", "2023-05-11", "2023-05-12"],
-    values=[90.2533, 89.9977, 90.1052, 90.9142, 90.5574],
-)
 ```
 
 ### Sample output using the OpenFrame.all_properties() method:
@@ -130,7 +132,7 @@ own way.
 
 ### Windows Powershell
 
-```
+```powershell
 git clone https://github.com/CaptorAB/OpenSeries.git
 cd OpenSeries
 ./make.ps1 -task make
@@ -138,12 +140,13 @@ cd OpenSeries
 
 ### Mac Terminal/Linux
 
-```
+```bash
 git clone https://github.com/CaptorAB/OpenSeries.git
 cd OpenSeries
 make
 source source_me
 make install
+
 ```
 
 ## Testing and Linting / Type-checking
@@ -157,16 +160,18 @@ file.
 
 ### Windows Powershell
 
-```
+```powershell
 ./make.ps1 -task test
 ./make.ps1 -task lint
+
 ```
 
 ### Mac Terminal/Linux
 
-```
+```bash
 make test
 make lint
+
 ```
 
 

{openseries-0.14.0.dist-info → openseries-1.0.1.dist-info}/RECORD

@@ -8,8 +8,8 @@ openseries/risk.py,sha256=_NJd8V-6pMx8pTodW-QpGKlmCDbCn4TsEjieKnCkIxU,4404
 openseries/series.py,sha256=Xw7ppt2bCVspkjYIqZKcMNfVIlrsmrnV7XWtp99qxrg,84385
 openseries/sim_price.py,sha256=dWzmj22nq4TW4BZBwP8Ajtid_g322No6D_m7t5bT8No,13878
 openseries/stoch_processes.py,sha256=6O4C_nC2iBseWggvDDC2gTpTqS5fI5nfjSRpccaazLE,14673
-openseries/types.py,sha256=SffsPIrtSD5JZ4mp-d-k2ymf7U0rjnIUxFbKcLhd4Os,6697
-openseries-0.14.0.dist-info/LICENSE.md,sha256=NJjeq3wyB7EnnHLmsdK1EK6zT00T1eB3FgAmHAPT_vM,1521
-openseries-0.14.0.dist-info/METADATA,sha256=WBxxftTEJ1drHyHkAajgrAserprXkNdGlXjgT8pcExg,47714
-openseries-0.14.0.dist-info/WHEEL,sha256=Zb28QaM1gQi8f4VCBhsUklF61CTlNYfs9YAZn-TOGFk,88
-openseries-0.14.0.dist-info/RECORD,,
+openseries/types.py,sha256=t5xeqoD-e9fm0aU5I9chbzLcZ-MHmb9-jInCz3NrIfk,6698
+openseries-1.0.1.dist-info/LICENSE.md,sha256=NJjeq3wyB7EnnHLmsdK1EK6zT00T1eB3FgAmHAPT_vM,1521
+openseries-1.0.1.dist-info/METADATA,sha256=PTN4E6RKx3YEmLLohbkKawOJZJPsbrE4B-wjRUxiWwM,47927
+openseries-1.0.1.dist-info/WHEEL,sha256=Zb28QaM1gQi8f4VCBhsUklF61CTlNYfs9YAZn-TOGFk,88
+openseries-1.0.1.dist-info/RECORD,,