updated docs to reflect switch to pipenv. Closes #451

nadineproject · Jan 7, 2021 · 8236997 · 8236997
1 parent 5a81b8d
commit 8236997
Show file tree

Hide file tree

Showing 3 changed files with 4 additions and 14 deletions.
diff --git a/Vagrantfile b/Vagrantfile
@@ -61,7 +61,7 @@ $userScript = <<SCRIPT
     pip install pip --upgrade
     git clone https://github.com/nadineproject/nadine.git
     cd nadine
-    pip install -r requirements.txt
+    pipenv install
 
     #SECURE_RANDOM=$(dd if=/dev/urandom count=1 bs=28 2>/dev/null | od -t x1 -A n)
     #SECRET_KEY="${SECURE_RANDOM//[[:space:]]/}"

diff --git a/docs/quickstart.rst b/docs/quickstart.rst
@@ -10,15 +10,6 @@ Setup the database
   $ sudo su postgres -c "createuser -s $(whoami)"
   $ createdb nadinedb
 
-Create a virtual environment for the python project
-
-.. code-block:: console
-
-  $ virtualenv nadine
-  $ cd nadine
-  $ source bin/activate
-
-
 Download the nadine source code from Github
 
 .. code-block:: console
@@ -30,7 +21,7 @@ Install all the requirements
 
 .. code-block:: console
 
-  $ pip3 install -r requirements.txt
+  $ pipenv install --three
 
 Run these scripts to setup nadine, install the database, create your admin user, and compile translations messages:
 

diff --git a/docs/requirements.rst b/docs/requirements.rst
@@ -18,15 +18,14 @@ On Mac OS X
 
   $ git # If you have not installed it, this will prompt you to download it.
   $ brew update
-  $ brew install postgres python3 libffi openssl cairo pango
-  $ pip3 install virtualenv
+  $ brew install postgres python3 libffi openssl cairo pango pipenv
 
 On Ubuntu/Debian
 
 .. code-block:: console
 
   $ sudo apt-get update
-  $ sudo apt-get install git postgresql postgresql-server-dev-all python3-pip python3-dev virtualenv
+  $ sudo apt-get install git postgresql postgresql-server-dev-all python3-pip python3-dev pipenv
   $ sudo apt-get install libffi-dev libghc-cairo-dev libghc-pango-dev