Updated documentation

docs/01-quick_start.rst

@@ -0,0 +1,137 @@
+Quick Start Guide
+=================
+This is a quick start guide on seting up a simple project and implement some features of the django-daraja library.
+
+To install the package, run
+
+    .. code-block:: none
+
+        $ pip install django_daraja
+
+First, create  a django project
+
+    .. code-block:: none
+
+        $ django-admin startproject my_site
+        $ cd my_site
+        $ django-admin startapp my_app
+
+Create a ``.env`` file in the root folder (``my_site``) and in the file load the configuration for your daraja developer app. Fill it in with these details:
+
+    .. code-block:: none
+
+        # MPESA Configuration variables     
+                
+        # The Mpesa environment to use
+        # Possible values: sandbox, production
+        
+        MPESA_ENVIRONMENT=sandbox        
+        
+        # Credentials for the daraja app
+        
+        MPESA_CONSUMER_KEY=mpesa_consumer_key
+        MPESA_CONSUMER_SECRET=mpesa_consumer_secret
+        
+        
+        #Shortcode to use for transactions
+        
+        MPESA_SHORTCODE=mpesa_shortcode
+        
+        
+        # Shortcode to use for Lipa na MPESA Online (MPESA Express) transactions
+        # This only has a different value on sandbox, you do not need to set it on production
+        
+        MPESA_EXPRESS_SHORTCODE=mpesa_express_shortcode        
+        
+        #Type of shortcode
+        # Possible values: 
+        # - paybill (For Paybill)
+        # - till_number (For Buy Goods Till Number)
+        
+        MPESA_SHORTCODE_TYPE=paybill
+        
+        # Lipa na MPESA Online passkey
+        # Sandbox passkey is available on test credentials page
+        # Production passkey is sent via email once you go live
+        
+        MPESA_PASSKEY=mpesa_passkey
+
+In ``settings.py``, add ``django_daraja`` to the ``INSTALLED_APPS`` list
+
+    .. code-block:: python
+
+        INSTALLED_APPS = [
+            ...,
+            'django.contrib.staticfiles',
+            'django_daraja',
+            'my_app',
+        ]
+
+In ``urls.py``, Add the URL configuration
+
+    .. code-block:: python
+
+        from django.contrib import admin
+        from django.urls import path, include
+        urlpatterns = [
+            path('admin/', admin.site.urls),
+            path('', include('my_app.urls')),
+        ]
+
+In ``my_app/urls.py`` Add this code to create a test endpoint
+
+    .. code-block:: python
+
+        from django.urls import path, include
+        from . import views
+        urlpatterns = [
+            path('', views.index, name='index'),
+        ]
+
+
+In ``my_app/views.py`` Create a test index view
+
+    .. code-block:: python
+
+        from django.shortcuts import render
+        from django.http import HttpResponse
+        from django_daraja.mpesa.core import MpesaClient
+        
+        def index(request):
+            cl = MpesaClient()
+            # Use a Safaricom phone number that you have access to, for you to be able to view the prompt.
+            phone_number = 'PHONE_NUMBER'
+            amount = 1
+            account_reference = 'reference'
+            transaction_desc = 'Description'
+            # This is a test callback URL.
+            # You can replace this with an endpoint where you wish to receive the result of the STK push transaction.
+            callback_url = 'https://darajambili.herokuapp.com/express-payment'
+            response = cl.stk_push(phone_number, amount, account_reference, transaction_desc, callback_url)
+            return HttpResponse(response.text)
+
+
+On the command line, run migrations to add the models created by the library
+
+    .. code-block:: none
+
+        $ python manage.py migrate
+
+Then run the server
+    .. code-block:: none
+
+        $ python manage.py runserver
+
+You can now visit your site at ``localhost:8000`` to view your project
+
+If the STK push was successful, you should see an STK prompt on your phone (the phone number you provided), and you should see the response on the browser. It looks like this:
+
+   .. code-block:: json
+
+        {
+            "MerchantRequestID": "2134-9231241-1",
+            "CheckoutRequestID": "ws_CO_DMZ_157917982_20112018173133556",
+            "ResponseCode": "0",
+            "ResponseDescription": "Success. Request accepted for processing",
+            "CustomerMessage": "Success. Request accepted for processing"
+        }

docs/index.rst

@@ -11,7 +11,8 @@ This is a django library that interacts with the MPESA Daraja API.
 .. toctree::
    :maxdepth: 2
 
-   01-testing
+   01-quick_start
+   02-testing