more packaging/readme cleanups, test simplification

Author: dylex

README.md

@@ -8,27 +8,43 @@ on the code.
 
 ## Quick-start
 
-### Test
+### Prerequisites
+
+python3 with pip3 (at le
+
+### Install
 
 ```bash
 git clone https://github.com/flatironinstitute/sciware-testing-python.git
 cd sciware-testing-python
-python3 ./setup.py pytest
+pip3 install -e .
+```
+
+This will work with a virtualenv, conda, or on a personal machine.
+With a system python, you may need `pip3 install --user -e .`.
+This will also install dependencies (like `pytest`) specified in [`requirements.txt`](requirements.txt).
+
+The `-e` indicates that we want to continue developing (editing) the installed package.
+
+### Run tests
+
+```bash
+pytest
 ```
 
 ## Forking This Project
 
 ## Contents
 
-* **`README.md`** - File generating this page.
-* **`setup.py`** - File describing the metadata for the package and rules to build/install/test it.
-* **`requirements.txt`** - File listing the packages required to run the code. It is included by setup.py.
-* **`LICENSE`** - File containing the text of the license the code is released under. Having a license file allows other people to use the code.
-* **`sciware_testing_python/`** - Directory for all the code.
-* **`sciware_testing_python/__init.py__`** - File that python imports to define the `sciware_testing_python` package.
-* **`sciware_testing_python/sciware_testing_python.py`** - File with all of the code.
-* **`tests/`** - Directory for the code which tests the code in `sciware_testing_python`.
-* **`tests/test_sciware_testing_python.py`** - File containing the tests.
-* **`.gitignore`** - File which tells github what files to not track (optional)
-* **`.github/workflows/`** - Directory containing the configuration file for GitHub actions.
-* **`.github/workflows/test.yml`** - File detailing the system configurations to use for the tests.
+* **[`README.md`](README.md)** - File generating this page.
+* **[`setup.py`](setup.py)** - File describing the metadata for the package and rules to build/install/test it.
+* **[`requirements.txt`](requirements.txt)** - File listing the packages required to run the code. It is included by setup.py.
+* **[`LICENSE`](LICENSE)** - File containing the text of the license the code is released under. Having a license file allows other people to use the code.
+* **[`sciware_testing_python/`](sciware_testing_python/)** - Directory for all the code.
+* **[`sciware_testing_python/__init.py__`** - File that python imports to define the `sciware_testing_python`](sciware_testing_python/__init.py__`** - File that python imports to define the `sciware_testing_python) package.
+* **[`sciware_testing_python/sciware_testing_python.py`](sciware_testing_python/sciware_testing_python.py)** - File with all of the code.
+* **[`tests/`** - Directory for the code which tests the code in `sciware_testing_python`](tests/`** - Directory for the code which tests the code in `sciware_testing_python).
+* **[`tests/test_sciware_testing_python.py`](tests/test_sciware_testing_python.py)** - File containing the tests.
+* **[`.gitignore`](.gitignore)** - File which tells github what files to not track (optional)
+* **[`.github/workflows/`](.github/workflows/)** - Directory containing the configuration file for GitHub actions.
+* **[`.github/workflows/test.yml`](.github/workflows/test.yml)** - File detailing the system configurations to use for the tests.

sciware_testing_python/sciware_testing_python.py

@@ -52,6 +52,6 @@ def add_vectors(vector_1, vector_2):
     sum_vec = []
 
     for a, b in zip(vector_1, vector_2):
-        sum_vec += [a + b]
+        sum_vec.append(a + b)
 
     return sum_vec

sciware_testing_python/sciware_testing_python_sol.py

@@ -117,47 +117,16 @@ def add_vectors(vector_1, vector_2):
     ValueError: add_vectors can only sum vectors that are lists.
 
     """
-    sum_vec = []
-    if len(vector_1) != len(vector_2):
-        raise RuntimeError(
-            'add_vectors can only add vectors of the same length.')
-
     if not isinstance(vector_1, list) or not isinstance(vector_2, list):
         raise ValueError(
             'add_vectors can only sum vectors that are lists.')
 
+    if len(vector_1) != len(vector_2):
+        raise RuntimeError(
+            'add_vectors can only add vectors of the same length.')
+
+    sum_vec = []
     for a, b in zip(vector_1, vector_2):
-        sum_vec += [a + b]
+        sum_vec.append(a + b)
 
     return sum_vec
-
-
-# std::vector<double> add_vectors(std::vector<double> &v1, std::vector<double> &v2)
-# {
-#     // Check inputs
-#     if (v1.size() != v2.size())
-#     {
-#         throw std::invalid_argument("There's a mismatch in vector size" + std::to_string(v1.size()) + "!=" + std::to_string(v2.size()));
-#     }
-
-#     //
-#     // Solution 1
-#     //
-
-#     // Add the vectors
-#     std::vector<double> new_vector(v1.size());
-
-#     for (size_t i = 0; i < v1.size(); i++)
-#     {
-#         new_vector[i] = v1[i] + v2[i];
-#     }
-
-#     //
-#     // Solution 2
-#     //
-
-#     // std::vector<double> new_vector = v1;
-#     // std::transform(new_vector.begin(), new_vector.end(), v2.begin(), new_vector.begin(), std::plus<double>());
-
-#     return new_vector;
-# }

setup.py

@@ -5,9 +5,11 @@
 
 from setuptools import find_packages, setup
 
+# load README.md contents to use as long_description
 with open('README.md') as readme_file:
     readme = readme_file.read()
 
+# load requirements.txt to use as install_requires
 with open('requirements.txt', 'r') as f:
     requirements = [l for l in f if l.strip() and not l.startswith('#')]
 
@@ -20,21 +22,18 @@
     version='0.1.0',
     long_description=readme,
     license="Apache Software License 2.0",
+    # some (optional) tags
     classifiers=[
         'Development Status :: 2 - Pre-Alpha',
         'Intended Audience :: Developers',
         'License :: OSI Approved :: Apache Software License',
         'Natural Language :: English',
         'Programming Language :: Python :: 3',
+        'Programming Language :: Python :: 3.6',
         'Programming Language :: Python :: 3.7',
         'Programming Language :: Python :: 3.8',
         'Programming Language :: Python :: 3.9',
     ],
     install_requires=requirements,
-    packages=find_packages(
-        include=[
-            'sciware_testing_python',
-            'sciware_testing_python_sol']),
-    test_suite='tests',
-    setup_requires=['pytest-runner'],
+    packages=find_packages()
 )

tests/test_sciware_testing_python.py

@@ -2,11 +2,8 @@
 """Tests for `sciware_testing_python` package."""
 
 import random
-
 import pytest
-
 import sciware_testing_python as stp
-# import sciware_testing_python_sol as stps
 
 
 def test_sum_numbers():
@@ -50,11 +47,6 @@ def generate_numbers():
 
     return random.sample(range(100), 10)
 
-
-# shortcuts for pytest decorators
-skip = pytest.mark.skip
-parametrize = pytest.mark.parametrize
-xfail = pytest.mark.xfail
 #######################################################################
 
 
@@ -73,7 +65,7 @@ def test_random_sum_numbers_add_1(generate_numbers):
     assert our_result == sum(generate_numbers) + 1
 
 
-@xfail
+@pytest.mark.xfail
 def test_sum_numbers_with_bad_args():
     """ Test sum numbers when not given good input
     """
@@ -90,7 +82,7 @@ def test_parametrize_sum_numbers(number_list, expect_val):
     assert stp.sum_numbers(number_list) == expect_val
 
 
-@xfail(strict=True)
+@pytest.mark.xfail(strict=True)
 def test_add_different_length_vectors():
     """
     """
@@ -99,7 +91,7 @@ def test_add_different_length_vectors():
     result = stp.add_vectors(v1, v2)  # doctest: +IGNORE_EXCEPTION_DETAIL
 
 
-@skip
+@pytest.mark.skip
 def test_add_skip_test():
     """ This test would fail if not for the decorator
     """