From 205d3fae024990cf2b9d9c281dd224361a53579a Mon Sep 17 00:00:00 2001 From: Dominik Kellner Date: Sat, 10 Aug 2019 10:31:40 +0200 Subject: [PATCH 1/2] Update installation instructions - use HTTPS instead of HTTP - correct example command line output - use `pip install .` instead of `python setup.py install` --- docs/install.rst | 21 +++++++++++---------- 1 file changed, 11 insertions(+), 10 deletions(-) diff --git a/docs/install.rst b/docs/install.rst index 0681675c3..9b5cdbe8b 100644 --- a/docs/install.rst +++ b/docs/install.rst @@ -5,7 +5,7 @@ Installation This part of the documentation covers the installation of Eve. The first step to using any software package is getting it properly installed. -Installing Eve is simple with `pip `_: +Installing Eve is simple with `pip `_: .. code-block:: console @@ -23,17 +23,20 @@ Get the git checkout in a new virtualenv and run in development mode. .. code-block:: console - $ git clone http://github.com/pyeve/eve.git - Initialized empty Git repository in ~/dev/eve/.git/ + $ git clone https://github.com/pyeve/eve.git + Cloning into 'eve'... + ... $ cd eve $ virtualenv venv - New python executable in venv/bin/python + ... + Installing setuptools, pip, wheel... + done. $ . venv/bin/activate - $ python setup.py install + $ pip install . ... - Finished processing dependencies for Eve + Successfully installed ... This will pull in the dependencies and activate the git head as the current version inside the virtualenv. Then all you have to do is run ``git pull @@ -47,10 +50,8 @@ To just get the development version without git, do this instead: $ cd eve $ virtualenv venv $ . venv/bin/activate - New python executable in venv/bin/python - - $ pip install git+git://github.com/pyeve/eve.git + $ pip install git+https://github.com/pyeve/eve.git ... - Cleaning up... + Successfully installed ... And you're done! From 5fdee8d37fd49c3fcd220aad455aa250ee8856b6 Mon Sep 17 00:00:00 2001 From: Nicola Iarocci Date: Mon, 26 Aug 2019 09:44:57 +0200 Subject: [PATCH 2/2] Changelog for #1303 --- CHANGES.rst | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/CHANGES.rst b/CHANGES.rst index 338b1b361..ba7171068 100644 --- a/CHANGES.rst +++ b/CHANGES.rst @@ -18,14 +18,16 @@ New Fixed ~~~~~ +- Update installation instructions (`#1303`_) - (*breaking*) Delete on empty resource returns 404, should return 204 (`#1299`_) -- MONGO_REPLICA_SET ignored (`#1302`_) +- ``MONGO_REPLICA_SET`` ignored (`#1302`_) - Documentation typo (`#1293`_) - Flask 1.1.1 breaks ``test_logging_info`` test (`#1296`_) - Display the full release number on Eve frontpage. - Update link to EveGenie repository. New maintainer: David Zisky. +.. _`#1303`: https://github.com/pyeve/eve/pull/1303 .. _`#1299`: https://github.com/pyeve/eve/issues/1299 .. _`#1302`: https://github.com/pyeve/eve/issues/1302 .. _`#1296`: https://github.com/pyeve/eve/issues/1296