farms 0.1.14__tar.gz

farms-0.1.14/LICENSE

@@ -0,0 +1,9 @@
+MIT License
+
+Copyright (c) 2026 Brian Boyer
+
+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.

farms-0.1.14/PKG-INFO

@@ -0,0 +1,36 @@
+Metadata-Version: 2.4
+Name: farms
+Version: 0.1.14
+Summary: A Python toolkit for loading financial data and performing regression and portfolio analysis for teaching and research.
+Author: Brian Boyer, Royston Vance
+License: MIT License
+        
+        Copyright (c) 2026 Brian Boyer
+        
+        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.
+Project-URL: Homepage, https://github.com/rvance1/simple-finance
+Project-URL: Issues, https://github.com/rvance1/simple-finance/issues
+Requires-Python: >=3.11
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: pandas<2.3,>=2.2
+Requires-Dist: requests>=2.32.4
+Requires-Dist: statsmodels>=0.14.5
+Requires-Dist: yfinance>=0.2.66
+Provides-Extra: dev
+Requires-Dist: ipykernel>=6.0; extra == "dev"
+Requires-Dist: pytest>=8.0; extra == "dev"
+Requires-Dist: ruff>=0.6; extra == "dev"
+Requires-Dist: mypy>=1.0; extra == "dev"
+Requires-Dist: wrds>=0.9.0; extra == "dev"
+Dynamic: license-file
+
+# simple-finance
+
+## Install
+```bash
+pip install simple-finance

farms-0.1.14/README.md

@@ -0,0 +1,5 @@
+# simple-finance
+
+## Install
+```bash
+pip install simple-finance

farms-0.1.14/pyproject.toml

@@ -0,0 +1,42 @@
+[build-system]
+requires = ["setuptools>=69", "wheel"]
+build-backend = "setuptools.build_meta"
+
+[project]
+name = "farms"
+version = "0.1.14"
+description = "A Python toolkit for loading financial data and performing regression and portfolio analysis for teaching and research."
+readme = "README.md"
+requires-python = ">=3.11"
+license = { file = "LICENSE" }
+authors = [{ name = "Brian Boyer" }, { name = "Royston Vance" }]
+dependencies = [
+    "pandas>=2.2,<2.3",
+    "requests>=2.32.4",
+    "statsmodels>=0.14.5",
+    "yfinance>=0.2.66",
+]
+
+[project.urls]
+Homepage = "https://github.com/rvance1/simple-finance"
+Issues = "https://github.com/rvance1/simple-finance/issues"
+
+[project.optional-dependencies]
+dev = [
+  "ipykernel>=6.0",
+  "pytest>=8.0",
+  "ruff>=0.6",
+  "mypy>=1.0",
+  "wrds>=0.9.0",
+]
+
+[tool.setuptools]
+package-dir = {"" = "src"}
+
+[tool.setuptools.packages.find]
+where = ["src"]
+
+[dependency-groups]
+dev = [
+    "python-dotenv>=1.2.1",
+]

farms-0.1.14/setup.cfg

@@ -0,0 +1,4 @@
+[egg_info]
+tag_build = 
+tag_date = 0
+

farms-0.1.14/src/farms/__init__.py

@@ -0,0 +1,44 @@
+from .pipelines.alpha_vantage import format_alpha_vantage
+from .pipelines.crsp import get_crsp_msf_by_ids
+from .pipelines.Ken_French_library import get_ff3, get_ff5, get_ken_french_deciles
+from .pipelines.yahoo_finance import get_monthly_returns
+
+from .tools.black_scholes import black_scholes, implied_volatility
+from .tools.portfolio_tools import describe, portfolio_volatility, portfolio_sharpe, EFRS_portfolio, tangent_portfolio
+from .tools.stats_tools import intercept, slope, run_ols
+from importlib.metadata import version
+
+import pandas as pd
+import warnings
+
+warnings.filterwarnings(
+    "ignore",
+    message="pandas only supports SQLAlchemy connectable.*",
+    category=UserWarning,
+)
+
+pd.set_option('display.max_rows', None)  # Show all rows
+pd.set_option('display.max_columns', None)  # Show all columns
+pd.set_option('display.width', None)  # Adjust width to fit the output
+pd.set_option('display.max_colwidth', None)  # Show full column content without truncation
+
+__version__ = version("simple-finance")
+
+__all__ = [
+    "format_alpha_vantage",
+    "get_crsp_msf_by_ids",
+    "get_ff3",
+    "get_ff5",
+    "get_ken_french_deciles",
+    "get_monthly_returns",
+    "black_scholes",
+    "implied_volatility",
+    "describe",
+    "portfolio_volatility",
+    "portfolio_sharpe",
+    "EFRS_portfolio",
+    "tangent_portfolio",
+    "intercept",
+    "slope",
+    "run_ols"
+]