Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Remove pipenv from development and documentation #22

Merged
merged 1 commit into from
Feb 28, 2019
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
6 changes: 3 additions & 3 deletions .travis.yml
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
7 changes: 4 additions & 3 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
4 changes: 0 additions & 4 deletions Pipfile

This file was deleted.

12 changes: 5 additions & 7 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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 <https://docs.pytest.org/en/latest/>`_ - ``fastnumbers``
contains a ``Pipfile`` for use with `pipenv <https://github.com/pypa/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 <https://docs.pytest.org/en/latest/>`_.

.. code-block:: sh

$ pipenv install --skip-lock --dev
$ pipenv install --skip-lock -e .
$ pipenv run pytest
$ pip install -r dev/requirements.txt
$ pytest

Author
------
Expand Down
11 changes: 5 additions & 6 deletions appveyor.yml
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand All @@ -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.
Expand Down
1 change: 1 addition & 0 deletions dev/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.
3 changes: 3 additions & 0 deletions dev/requirements.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
pytest >= 3.5
pytest-faulthandler
hypothesis >= 3.8.0
12 changes: 5 additions & 7 deletions docs/source/intro.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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 <https://docs.pytest.org/en/latest/>`_ - ``fastnumbers``
contains a ``Pipfile`` for use with `pipenv <https://github.com/pypa/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 <https://docs.pytest.org/en/latest/>`_.

.. 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 <https://docs.pytest.org/en/latest/>`_ to run its tests.
4 changes: 1 addition & 3 deletions tox.ini
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down