Replacing Travis-CI with GitHub Actions (fmilthaler#82)

fmilthaler · PietropaoloFrisoni · web-flow · commit e39493bcb277 · 2023-07-11T12:47:32.000+02:00
Co-authored-by: Pietropaolo Frisoni &lt;pfrisoni@uwo.ca&gt;
diff --git a/.github/workflows/pytest.yml b/.github/workflows/pytest.yml
@@ -0,0 +1,38 @@
+name: Python CI
+
+env:
+  QUANDLAPIKEY: ${{ secrets.QUANDLAPIKEY }}
+
+on:
+  push:
+    branches:
+      - master
+      - develop
+  pull_request:
+    branches:
+      - master
+      - develop
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        python-version: [ '3.10', '3.11' ]
+
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v3
+
+      - name: Set up Python ${{ matrix.python-version }}
+        uses: actions/setup-python@v3
+        with:
+          python-version: ${{ matrix.python-version }}
+
+      - name: Install dependencies
+        run: |
+          python -m pip install --upgrade pip
+          python -m pip install .[test]
+
+      - name: Run tests
+        run: make test
diff --git a/.travis.yml b/.travis.yml
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -36,6 +36,7 @@ To keep everything consistent, please use [Black](https://github.com/psf/black)
 ### Create a Pull Request
 Create a new [Pull Request](https://github.com/fmilthaler/FinQuant/pulls). Describe what your changes are in the Pull Request. If your contribution fixes a bug, or adds a features listed under [issues](https://github.com/fmilthaler/FinQuant/issues) as "#12", please add "fixes #12" or "closes #12". 
 
-If you do not have a [Quandl API key](https://docs.quandl.com/docs#section-authentication) set on your Travis account, some of the tests are most likely going to fail. There are two ways forward:
-1. you get a [Quandl API key](https://docs.quandl.com/docs#section-authentication), and set it as an environment variable under your Travis account settings.
-2. Or you set the target of your Pull Request to either `feature/new-feature` or `bugfix/new-bugfix`, if your contribution is a new feature of bugfix respectively. That way your changes can be merged into a branch of FinQuant, and all the tests can be ran with my [Quandl API key](https://docs.quandl.com/docs#section-authentication).
+If you do not have a [Quandl API key](https://docs.quandl.com/docs#section-authentication) set as a secret in your fork, some of the tests are going to fail. 
+While you are working on your fork, you can ignore the Quandl specific tests that are failing. Once you are happy with your work,
+open a PR and use `master` as the target branch. GitHub Actions is set up to run the tests automatically for PRs, and the
+Quandl tests are then run with my secret API key.
diff --git a/README.md b/README.md
@@ -9,8 +9,8 @@
   <a href="https://pypi.org/project/FinQuant">
     <img src="https://img.shields.io/badge/pypi-v0.2.2-brightgreen.svg?style=popout" alt='pypi'>
   </a>
-  <a href="https://travis-ci.org/fmilthaler/FinQuant">
-    <img src="https://travis-ci.org/fmilthaler/FinQuant.svg?style=popout?branch=master" alt='travis'>
+  <a href="https://github.com/fmilthaler/FinQuant">
+    <img src="https://github.com/fmilthaler/finquant/actions/workflows/pytest.yml/badge.svg?branch=master" alt='GitHub Actions'>
   </a>
   <a href="http://finquant.readthedocs.io/">
     <img src="https://img.shields.io/readthedocs/finquant.svg?style=popout" alt="docs">
@@ -162,14 +162,13 @@ As it is common for open-source projects, there are several ways to get hold of
 
 ### Dependencies
 *FinQuant* depends on the following Python packages:
- - python>=3.5.0
+ - python>=3.10
  - numpy>=1.15
- - pandas>=0.24
- - matplotlib>=1.5.1
+ - pandas>=2.0
+ - matplotlib>=3.0
  - quandl>=3.4.5
  - yfinance>=0.1.43
  - scipy>=1.2.0
- - pytest>=2.8.7
 
 ### From PyPI
 *FinQuant* can be obtained from PyPI
diff --git a/README.tex.md b/README.tex.md
@@ -9,8 +9,8 @@
   <a href="https://pypi.org/project/FinQuant">
     <img src="https://img.shields.io/badge/pypi-v0.2.2-brightgreen.svg?style=popout" alt='pypi'>
   </a>
-  <a href="https://travis-ci.org/fmilthaler/FinQuant">
-    <img src="https://travis-ci.org/fmilthaler/FinQuant.svg?style=popout?branch=master" alt='travis'>
+  <a href="https://github.com/fmilthaler/FinQuant">
+    <img src="https://github.com/fmilthaler/finquant/actions/workflows/pytest.yml/badge.svg?branch=master" alt='GitHub Actions'>
   </a>
   <a href="http://finquant.readthedocs.io/">
     <img src="https://img.shields.io/readthedocs/finquant.svg?style=popout" alt="docs">
@@ -129,7 +129,7 @@ yields
 
 ### Bollinger Band
 ```
-from finquant.moving_average import plot_bollinger_band
+from finquant.moving_average import plot_bollinger_band, sma
 # get stock data for disney
 dis = pf.get_stock("DIS").data.copy(deep=True)
 span=20
@@ -162,14 +162,13 @@ As it is common for open-source projects, there are several ways to get hold of
 
 ### Dependencies
 *FinQuant* depends on the following Python packages:
- - python>=3.5.0
+ - python>=3.10
  - numpy>=1.15
- - pandas>=0.24
- - matplotlib>=1.5.1
+ - pandas>=2.0
+ - matplotlib>=3.0
  - quandl>=3.4.5
  - yfinance>=0.1.43
  - scipy>=1.2.0
- - pytest>=2.8.7
 
 ### From PyPI
 *FinQuant* can be obtained from PyPI
diff --git a/docs/index.rst b/docs/index.rst
@@ -8,7 +8,7 @@
     :width: 30
     :align: middle
 
-.. _Travis Ci: https://travis-ci.org/fmilthaler/FinQuant
+.. _GitHub Actions: https://github.com/fmilthaler/finquant/actions/workflows/pytest.yml/badge.svg?branch=master
 
 .. _GitHub: https://github.com/fmilthaler/FinQuant/
 
@@ -22,7 +22,7 @@ Welcome to FinQuant's documentation
 
 *FinQuant* is made to be easily extended. I hope it proves itself useful for hobby investors, students, geeks, and the intellectual curious.
 
-.. caution:: While *FinQuant* has tests in place that are run automatically by `Travis CI`_, it cannot guarantee to be bug free, nor that the analysis or optimised portfolio yield to wealth. Please use at your own discretion and refer to the :ref:`license`.
+.. caution:: While *FinQuant* has tests in place that are run automatically by `GitHub Actions`_, it cannot guarantee to be bug free, nor that the analysis or optimised portfolio yield to wealth. Please use at your own discretion and refer to the :ref:`license`.
 
 
 Installation
@@ -34,14 +34,13 @@ Dependencies
 
 *FinQuant* depends on the following Python packages:
 
-- ``python>=3.5.0``
+- ``python>=3.10.0``
 - ``numpy>=1.15``
-- ``pandas>=0.24``
-- ``matplotlib>=1.5.1``
+- ``scipy>=1.2.0``
+- ``pandas>=2.0``
+- ``matplotlib>=3.0``
 - ``quandl>=3.4.5``
 - ``yfinance>=0.1.43``
-- ``scipy>=1.2.0``
-- ``pytest>=2.8.7``
 
 From PyPI
 ---------
diff --git a/requirements.txt b/requirements.txt
@@ -1,7 +1,6 @@
 numpy>=1.15
-pandas>=0.24
-matplotlib>=1.5.1
-quandl>=3.4.5
-yfinance>=0.1.43
 scipy>=1.2.0
-pytest>=2.8.7
+pandas>=2.0
+matplotlib>=3.0
+quandl>=3.4.5
+yfinance>=0.1.43
diff --git a/requirements_dev.txt b/requirements_dev.txt
@@ -0,0 +1,3 @@
+black==23.1.0
+jupyter
+notebook
diff --git a/requirements_docs.txt b/requirements_docs.txt
@@ -0,0 +1,2 @@
+sphinx
+sphinx_rtd_theme
diff --git a/requirements_test.txt b/requirements_test.txt
@@ -0,0 +1 @@
+pytest>=7.3.2
diff --git a/setup.cfg b/setup.cfg
@@ -1,4 +1,3 @@
 [metadata]
 description-file = README.md
-license-file = LICENSE.txt
-
+license-file = LICENSE.txt
diff --git a/setup.py b/setup.py
@@ -2,22 +2,36 @@
 
 # get version/release from file
 with open("version", "r") as f:
-    ver = dict(x.rstrip().split("=") for x in f)
+    version = dict(x.rstrip().split("=") for x in f)
 
+# get long description from README
 with open("README.md", "r") as fh:
     long_description = fh.read()
 
+# get dependencies
+def read_requirements(file_path):
+    with open(file_path, "r") as f:
+        return [line.strip() for line in f if line.strip()]
+
+install_requires = read_requirements("requirements.txt")
+
+extras_require = {
+    "test": read_requirements("requirements_test.txt"),
+    "dev": read_requirements("requirements_dev.txt"),
+    "docs": read_requirements("requirements_docs.txt"),
+}
+
 setuptools.setup(
     name="FinQuant",
-    version=ver["version"],
+    version=version["version"],
     author="Frank Milthaler",
     author_email="f.milthaler@gmail.com",
     description="A program for financial portfolio management, analysis and optimisation",
     long_description=long_description,
     long_description_content_type="text/markdown",
     url="https://github.com/fmilthaler/FinQuant",
     download_url="https://github.com/fmilthaler/FinQuant/archive/v{}.tar.gz".format(
-        ver["release"]
+        version["release"]
     ),
     license="MIT",
     packages=setuptools.find_packages(),
@@ -45,14 +59,7 @@
         "quant",
     ],
     python_requires=">=3.10",
-    install_requires=[
-        "quandl",
-        "yfinance",
-        "numpy",
-        "pandas",
-        "scipy",
-        "matplotlib",
-        "pytest",
-    ],
+    install_requires=install_requires,
+    extras_require=extras_require,
     project_urls={"Documentation": "https://finquant.readthedocs.io"},
 )

Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,3 @@`
	`1`	`+black==23.1.0`
	`2`	`+jupyter`
	`3`	`+notebook`