From ee3fb9ac371c9e7252d8c3df2128f0f8346f8b55 Mon Sep 17 00:00:00 2001 From: Seth Morton Date: Wed, 27 Feb 2019 22:35:59 -0800 Subject: [PATCH] Remove pipenv from development and documentation Pipenv keeps changing its API and causing my builds to fail. I am tired of this. From now on, only pip will be used. Besides, Pipenv doesn't make much sense for use in a library, anyway. --- .travis.yml | 6 +++--- CONTRIBUTING.md | 7 ++++--- Pipfile | 4 ---- README.rst | 12 +++++------- appveyor.yml | 11 +++++------ dev/README.md | 1 + dev/requirements.txt | 3 +++ docs/source/intro.rst | 12 +++++------- tox.ini | 4 +--- 9 files changed, 27 insertions(+), 33 deletions(-) delete mode 100644 Pipfile create mode 100644 dev/requirements.txt diff --git a/.travis.yml b/.travis.yml index dd0942ce..1374b866 100644 --- a/.travis.yml +++ b/.travis.yml @@ -50,11 +50,11 @@ branches: install: - pip install -U pip -- pip install codecov pipenv -- pipenv install --dev --skip-lock +- pip install codecov +- pip install -r dev/requirements.txt before_script: - - python dev/patch_doctest.py +- python dev/patch_doctest.py script: - python setup.py install diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 935a6d23..724196ac 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -11,13 +11,14 @@ Located in the `dev/` folder is development collateral such as formatting and patching scripts. The only development collateral not in the `dev/` folder are those files that are expected to exist in the the top-level directory (such as `setup.py`, `.travis.yml`, `appveyor.yml`, and `tox.ini`). -`fastnumbers` uses [`pipenv`](https://github.com/pypa/pipenv) to manage dependencies -and virtual environments - to get all your dependencies installed use the following. +To get all your dependencies installed use the following: ``` -$ pipenv install --dev --skip-lock +$ pip install -r dev-requirements.txt ``` +Although, it is easier to just use ``tox``. + I do not have strong opinions on how one should contribute, so I have copy/pasted some text verbatim from the [Contributor's Guide](http://docs.python-requests.org/en/latest/dev/contributing/) section of diff --git a/Pipfile b/Pipfile deleted file mode 100644 index 15d1c261..00000000 --- a/Pipfile +++ /dev/null @@ -1,4 +0,0 @@ -[dev-packages] -pytest = "*" -pytest-faulthandler = "*" -hypothesis = "*" \ No newline at end of file diff --git a/README.rst b/README.rst index 27877625..82a1cb5b 100644 --- a/README.rst +++ b/README.rst @@ -172,16 +172,14 @@ execute $ tox -If you do not wish to use ``tox``, you can install the testing dependencies and run the -tests manually using `pytest `_ - ``fastnumbers`` -contains a ``Pipfile`` for use with `pipenv `_ that -makes it easy for you to install the testing dependencies: +If you do not wish to use ``tox``, you can install the testing dependencies with the +``dev-requirements.txt`` file and then run the tests manually using +`pytest `_. .. code-block:: sh - $ pipenv install --skip-lock --dev - $ pipenv install --skip-lock -e . - $ pipenv run pytest + $ pip install -r dev/requirements.txt + $ pytest Author ------ diff --git a/appveyor.yml b/appveyor.yml index 1e79da7f..655e8bcd 100644 --- a/appveyor.yml +++ b/appveyor.yml @@ -20,9 +20,8 @@ environment: install: - "SET PATH=%PYTHON%;%PYTHON%\\Scripts;%PATH%" - "python -m pip install -U pip" - - "python -m pip install pipenv" - - "pipenv install --dev --skip-lock" - - "pipenv run python dev/patch_doctest.py" + - "python -m pip install -r dev/requirements.txt" + - "python dev/patch_doctest.py" build: false @@ -31,9 +30,9 @@ test_script: # If you don't need to build C extensions on 64-bit Python 3.3 or 3.4, # you can remove "build.cmd" from the front of the command, as it's # only needed to support those cases. - - "dev\\build.cmd pipenv run python setup.py install" - - "pipenv run python -m doctest fastnumbers" - - "pipenv run pytest --doctest-glob=README.rst" + - "dev\\build.cmd python setup.py install" + - "python -m doctest fastnumbers" + - "pytest --doctest-glob=README.rst" #on_success: # You can use this step to upload your artifacts to a public website. diff --git a/dev/README.md b/dev/README.md index 052404f7..e19f6e8d 100644 --- a/dev/README.md +++ b/dev/README.md @@ -14,6 +14,7 @@ This file contains some files useful for development. whereby it cannot run tests on extension modules. This file makes a local copy of `doctest.py` and patches it to be able to run on extension modules. +- `requirements.txt` - Requirements to run tests - `run_coverage.sh` - A small shell one-liner placed into a file that will compile `fastnumbers`, run all tests, then run `lcov` and `genhtml` to create an HTML coverage report. Only tested on OSX. diff --git a/dev/requirements.txt b/dev/requirements.txt new file mode 100644 index 00000000..ebd44a59 --- /dev/null +++ b/dev/requirements.txt @@ -0,0 +1,3 @@ +pytest >= 3.5 +pytest-faulthandler +hypothesis >= 3.8.0 diff --git a/docs/source/intro.rst b/docs/source/intro.rst index 0a1d054c..75586fc8 100644 --- a/docs/source/intro.rst +++ b/docs/source/intro.rst @@ -151,15 +151,13 @@ execute $ tox -If you do not wish to use ``tox``, you can install the testing dependencies and run the -tests manually using `pytest `_ - ``fastnumbers`` -contains a ``Pipfile`` for use with `pipenv `_ that -makes it easy for you to install the testing dependencies: +If you do not wish to use ``tox``, you can install the testing dependencies with the +``dev-requirements.txt`` file and then run the tests manually using +`pytest `_. .. code-block:: sh - $ pipenv install --skip-lock --dev - $ pipenv install --skip-lock -e . - $ pipenv run pytest + $ pip install -r dev/requirements.txt + $ pytest :mod:`fastnumbers` uses `pytest `_ to run its tests. diff --git a/tox.ini b/tox.ini index 44566137..044bd03d 100644 --- a/tox.ini +++ b/tox.ini @@ -13,10 +13,8 @@ envlist = py27, py34, py35, py36, py37 [testenv] passenv = CC CFLAGS skip_install = true -deps = pipenv +deps = -r dev-requirements.txt commands = - # Install dependencies into this virtual environment - pipenv install --dev --skip-lock # All versions need to build and patch doctest for testing the fastnumbers module. {envpython} dev/patch_doctest.py # Install into this virtual environment.