Merge pull request #63 from Kai-Striega/move_to_poetry

Author: Kai-Striega

.github/workflows/pythonpackage.yml

@@ -4,14 +4,11 @@ on: [push, pull_request]
 
 jobs:
   build:
-
     runs-on: ${{ matrix.os }}
     strategy:
       matrix:
         os: [ubuntu-latest, macos-latest, windows-latest]
-        python-version: ["3.7", "3.8", "3.9", "3.10", "3.11"]
-        numpy-version: ["oldest-supported-numpy", "numpy"]
-
+        python-version: ["3.9", "3.10", "3.11"]
     steps:
     - uses: actions/checkout@v3
     - name: Set up Python ${{ matrix.python-version }}
@@ -20,19 +17,15 @@ jobs:
         python-version: ${{ matrix.python-version }}
     - name: Install dependencies
       run: |
-        python -m pip install --upgrade pip
-        pip install ${{ matrix.numpy-version }}
+        python -m pip install --upgrade pip poetry
+        poetry env use ${{ matrix.python-version }}
+        poetry install --with=test --with=lint
     - name: Lint with flake8
       run: |
-        pip install flake8
         # stop the build if there are Python syntax errors or undefined names
-        flake8 . --count --select=E9,F63,F7,F82 --show-source --statistics
-        # exit-zero treats all errors as warnings. The GitHub editor is 127 chars wide
-        flake8 . --count --exit-zero --max-complexity=10 --max-line-length=127 --statistics
-    - name: Install numpy-financial
-      run: |
-        pip install .
+        poetry run flake8 . --count --select=E9,F63,F7,F82 --show-source --statistics
+        # The GitHub editor is 127 chars wide
+        poetry run flake8 . --ignore=F401,F403,W503,E226 --count --max-complexity=10 --max-line-length=127 --statistics
     - name: Test with pytest
       run: |
-        pip install pytest
-        pytest
+        poetry run pytest

doc_developer/building_with_poetry.md

@@ -0,0 +1,67 @@
+# Building with poetry
+
+## Installing poetry
+numpy-financial uses [poetry](https://python-poetry.org/) to manage 
+dependencies, build wheels and sdists, and publish to PyPI this page documents
+how to work with poetry.
+
+To install poetry follow their [official guide](https://python-poetry.org/docs/#installing-with-the-official-installer)
+it is recommended to use the official installer for local development.
+
+To check your installation try to check the version of poetry:
+
+```shell
+poetry -V
+```
+
+## Setting up a virtual environment using poetry
+
+Once poetry is installed it is time to set up the virtual environment. To do
+this run:
+
+```shell
+poetry install
+```
+
+``poetry install`` looks for dependencies in the ``pyproject.toml`` file,
+resolves them to the most recent version and installs the dependencies
+in a virtual environment. It is now possible to launch an interactive REPL
+by running the following command:
+
+```shell
+poetry run python
+```
+
+## Running the test suite
+
+numpy-financial has an extensive test suite, which can be run with the
+following command:
+
+```shell
+poetry run pytest
+```
+
+## Building distributions
+
+It is possible to manually build distributions for numpy-financial using
+poetry. This is possible via the `build` command:
+
+```shell
+poetry build
+```
+
+The `build` command creates a `dist` directory containing a wheel and sdist
+file.
+
+
+## Publishing to PyPI
+
+poetry provides support to publish packages to PyPI. This is possible using
+the ``publish`` command:
+
+```shell
+poetry publish --build --username <your username> --password <your password>
+```
+
+Note that this builds the package before publishing it. You will need to 
+provide the correct username and password for PyPI.

numpy_financial/_financial.py

@@ -27,16 +27,14 @@
                 'start': 1,
                 'finish': 0}
 
-# Define custom Exceptions
 
 class NoRealSolutionException(Exception):
     """ No real solution to the problem. """
-
     pass
 
+
 class IterationsExceededException(Exception):
     """ Maximum number of iterations reached. """
-
     pass
 
 

pyproject.toml

@@ -0,0 +1,55 @@
+[build-system]
+requires = ["poetry-core"]
+build-backend = "poetry.core.masonry.api"
+
+
+[tool.poetry]
+name = "numpy-financial"
+version = "1.1.0.dev0"
+description = "Simple financial functions"
+license = "BSD-3-Clause"
+authors = ["Travis E. Oliphant et al."]
+maintainers = ["Numpy Financial Developers <numpy-discussion@python.org>"]
+readme = "README.md"
+homepage = "https://numpy.org/numpy-financial/latest/"
+repository = "https://github.com/numpy/numpy-financial"
+documentation = "https://numpy.org/numpy-financial/latest/#functions"
+classifiers = [
+    "Development Status :: 5 - Production/Stable",
+    "Intended Audience :: Developers",
+    "Intended Audience :: Financial and Insurance Industry",
+    "License :: OSI Approved :: BSD License",
+    "Programming Language :: Python",
+    "Programming Language :: Python :: 3",
+    "Programming Language :: Python :: 3.9",
+    "Programming Language :: Python :: 3.10",
+    "Programming Language :: Python :: 3.11",
+    "Programming Language :: Python :: 3.12",
+    "Programming Language :: Python :: 3 :: Only",
+    "Topic :: Software Development",
+    "Topic :: Office/Business :: Financial :: Accounting",
+    "Topic :: Office/Business :: Financial :: Investment",
+    "Topic :: Office/Business :: Financial :: Spreadsheet",
+    "Operating System :: Microsoft :: Windows",
+    "Operating System :: POSIX",
+    "Operating System :: Unix",
+    "Operating System :: MacOS",
+]
+packages = [{include = "numpy_financial"}]
+
+[tool.poetry.dependencies]
+python = "^3.9"
+numpy = "^1.23"
+
+
+[tool.poetry.group.test.dependencies]
+pytest = "^7.4"
+
+
+[tool.poetry.group.docs.dependencies]
+sphinx = "^7.0"
+numpydoc = "^1.5"
+
+
+[tool.poetry.group.lint.dependencies]
+flake8 = "*"

requirements.txt

@@ -6,7 +6,7 @@
 import numpy
 from numpy.testing import (
     assert_, assert_almost_equal, assert_allclose, assert_equal, assert_raises
-    )
+)
 import pytest
 
 import numpy_financial as npf