From f05094c00ff2eed7f675af1e42674e1ded339a5f Mon Sep 17 00:00:00 2001 From: Subhash Bhushan Date: Sat, 23 Mar 2024 09:10:53 -0700 Subject: [PATCH] minor adds to documentation --- docs/user/installation.rst | 7 ++++--- docs/user/quickstart.rst | 18 +++++++++++++++++- 2 files changed, 21 insertions(+), 4 deletions(-) diff --git a/docs/user/installation.rst b/docs/user/installation.rst index 290cb8c7..c680539e 100644 --- a/docs/user/installation.rst +++ b/docs/user/installation.rst @@ -95,16 +95,17 @@ Use the ``protean`` command-line utility to verify the installation: .. code-block:: shell - $ protean --version + $ python -m protean --version 0.11.0 -To verify that Protean can be seen by Python, try importing Proteam from a ``python`` shell: +To verify that Protean can be seen by your current installation of Python, +try importing Protean from a ``python`` shell: .. code-block:: shell $ python3 >>> import protean - >>> print(protean.get_version()) + >>> protean.get_version() 0.11.0 ------------------- diff --git a/docs/user/quickstart.rst b/docs/user/quickstart.rst index fb914ad4..6bc87b16 100644 --- a/docs/user/quickstart.rst +++ b/docs/user/quickstart.rst @@ -3,7 +3,23 @@ Quickstart Eager to get started? This page gives a good introduction to Protean. Follow :doc:`installation` to set up a project and install Protean first. -In this quickstart, we will write a simple Protean application with SQLITE as the database and Flask as the API framework. +In this quickstart, we will create a simple Protean application with SQLITE as the database and Flask as the API framework. + +Initialize a Project +-------------------- + +Let us initialize a new directory for your project. We will call it ``authentication``. + +From the command line, cd into a directory where you’d like to store your code, then run the following command: + +.. code-block:: shell + + $ protean new authentication + +This will create a ``authentication`` directory in your current directory. + +Here is a quicklook at the directory structure: + A Simple Domain ---------------