diff --git a/docs/_modules/index.html b/docs/_modules/index.html index 8b4ad33..e0d9583 100644 --- a/docs/_modules/index.html +++ b/docs/_modules/index.html @@ -37,6 +37,7 @@ diff --git a/docs/_modules/pypaystack2/api/bulk_charges.html b/docs/_modules/pypaystack2/api/bulk_charges.html index 68ffa54..038f12b 100644 --- a/docs/_modules/pypaystack2/api/bulk_charges.html +++ b/docs/_modules/pypaystack2/api/bulk_charges.html @@ -38,6 +38,7 @@

Contents:

diff --git a/docs/_modules/pypaystack2/api/charge.html b/docs/_modules/pypaystack2/api/charge.html index 3a9b6d5..7a5b706 100644 --- a/docs/_modules/pypaystack2/api/charge.html +++ b/docs/_modules/pypaystack2/api/charge.html @@ -38,6 +38,7 @@

Contents:

diff --git a/docs/_modules/pypaystack2/api/control_panel.html b/docs/_modules/pypaystack2/api/control_panel.html index a07dfe7..ecddb83 100644 --- a/docs/_modules/pypaystack2/api/control_panel.html +++ b/docs/_modules/pypaystack2/api/control_panel.html @@ -38,6 +38,7 @@

Contents:

diff --git a/docs/_modules/pypaystack2/api/customers.html b/docs/_modules/pypaystack2/api/customers.html index a052001..b78d9fa 100644 --- a/docs/_modules/pypaystack2/api/customers.html +++ b/docs/_modules/pypaystack2/api/customers.html @@ -38,6 +38,7 @@

Contents:

diff --git a/docs/_modules/pypaystack2/api/dedicated_accounts.html b/docs/_modules/pypaystack2/api/dedicated_accounts.html index c3043eb..6a19bcc 100644 --- a/docs/_modules/pypaystack2/api/dedicated_accounts.html +++ b/docs/_modules/pypaystack2/api/dedicated_accounts.html @@ -38,6 +38,7 @@

Contents:

diff --git a/docs/_modules/pypaystack2/api/disputes.html b/docs/_modules/pypaystack2/api/disputes.html index 7de3b7d..376c4a0 100644 --- a/docs/_modules/pypaystack2/api/disputes.html +++ b/docs/_modules/pypaystack2/api/disputes.html @@ -38,6 +38,7 @@

Contents:

diff --git a/docs/_modules/pypaystack2/api/invoices.html b/docs/_modules/pypaystack2/api/invoices.html index 309973a..43eaf0e 100644 --- a/docs/_modules/pypaystack2/api/invoices.html +++ b/docs/_modules/pypaystack2/api/invoices.html @@ -38,6 +38,7 @@

Contents:

diff --git a/docs/_modules/pypaystack2/api/miscellaneous.html b/docs/_modules/pypaystack2/api/miscellaneous.html index ce67747..b1dd793 100644 --- a/docs/_modules/pypaystack2/api/miscellaneous.html +++ b/docs/_modules/pypaystack2/api/miscellaneous.html @@ -38,6 +38,7 @@

Contents:

diff --git a/docs/_modules/pypaystack2/api/payment_pages.html b/docs/_modules/pypaystack2/api/payment_pages.html index 0dab3b9..1af9d5e 100644 --- a/docs/_modules/pypaystack2/api/payment_pages.html +++ b/docs/_modules/pypaystack2/api/payment_pages.html @@ -38,6 +38,7 @@

Contents:

diff --git a/docs/_modules/pypaystack2/api/plans.html b/docs/_modules/pypaystack2/api/plans.html index 9c73442..6d0c32a 100644 --- a/docs/_modules/pypaystack2/api/plans.html +++ b/docs/_modules/pypaystack2/api/plans.html @@ -38,6 +38,7 @@

Contents:

diff --git a/docs/_modules/pypaystack2/api/products.html b/docs/_modules/pypaystack2/api/products.html index d4d2e0b..e8f1aad 100644 --- a/docs/_modules/pypaystack2/api/products.html +++ b/docs/_modules/pypaystack2/api/products.html @@ -38,6 +38,7 @@

Contents:

diff --git a/docs/_modules/pypaystack2/api/refunds.html b/docs/_modules/pypaystack2/api/refunds.html index 5df5603..988c82d 100644 --- a/docs/_modules/pypaystack2/api/refunds.html +++ b/docs/_modules/pypaystack2/api/refunds.html @@ -38,6 +38,7 @@

Contents:

diff --git a/docs/_modules/pypaystack2/api/settlements.html b/docs/_modules/pypaystack2/api/settlements.html index 88e8e1a..bd0657a 100644 --- a/docs/_modules/pypaystack2/api/settlements.html +++ b/docs/_modules/pypaystack2/api/settlements.html @@ -38,6 +38,7 @@

Contents:

diff --git a/docs/_modules/pypaystack2/api/splits.html b/docs/_modules/pypaystack2/api/splits.html index 5cd3824..144684b 100644 --- a/docs/_modules/pypaystack2/api/splits.html +++ b/docs/_modules/pypaystack2/api/splits.html @@ -38,6 +38,7 @@

Contents:

diff --git a/docs/_modules/pypaystack2/api/subaccounts.html b/docs/_modules/pypaystack2/api/subaccounts.html index b765615..67a9cd3 100644 --- a/docs/_modules/pypaystack2/api/subaccounts.html +++ b/docs/_modules/pypaystack2/api/subaccounts.html @@ -38,6 +38,7 @@

Contents:

diff --git a/docs/_modules/pypaystack2/api/subscriptions.html b/docs/_modules/pypaystack2/api/subscriptions.html index 74d3a72..878037f 100644 --- a/docs/_modules/pypaystack2/api/subscriptions.html +++ b/docs/_modules/pypaystack2/api/subscriptions.html @@ -38,6 +38,7 @@

Contents:

diff --git a/docs/_modules/pypaystack2/api/transactions.html b/docs/_modules/pypaystack2/api/transactions.html index d06cac4..124a41e 100644 --- a/docs/_modules/pypaystack2/api/transactions.html +++ b/docs/_modules/pypaystack2/api/transactions.html @@ -38,6 +38,7 @@

Contents:

diff --git a/docs/_modules/pypaystack2/api/transfer_recipients.html b/docs/_modules/pypaystack2/api/transfer_recipients.html index cb87ecc..2537c72 100644 --- a/docs/_modules/pypaystack2/api/transfer_recipients.html +++ b/docs/_modules/pypaystack2/api/transfer_recipients.html @@ -38,6 +38,7 @@

Contents:

diff --git a/docs/_modules/pypaystack2/api/transfers.html b/docs/_modules/pypaystack2/api/transfers.html index 1d5f9f0..246fc54 100644 --- a/docs/_modules/pypaystack2/api/transfers.html +++ b/docs/_modules/pypaystack2/api/transfers.html @@ -38,6 +38,7 @@

Contents:

diff --git a/docs/_modules/pypaystack2/api/transfers_control.html b/docs/_modules/pypaystack2/api/transfers_control.html index f7eaf3c..bf6cd0b 100644 --- a/docs/_modules/pypaystack2/api/transfers_control.html +++ b/docs/_modules/pypaystack2/api/transfers_control.html @@ -38,6 +38,7 @@

Contents:

diff --git a/docs/_modules/pypaystack2/api/verification.html b/docs/_modules/pypaystack2/api/verification.html index 796e706..0a36a11 100644 --- a/docs/_modules/pypaystack2/api/verification.html +++ b/docs/_modules/pypaystack2/api/verification.html @@ -38,6 +38,7 @@

Contents:

diff --git a/docs/_modules/pypaystack2/baseapi.html b/docs/_modules/pypaystack2/baseapi.html index 1020cff..15bb4ec 100644 --- a/docs/_modules/pypaystack2/baseapi.html +++ b/docs/_modules/pypaystack2/baseapi.html @@ -38,6 +38,7 @@

Contents:

@@ -66,8 +67,7 @@

Source code for pypaystack2.baseapi

 import os
-from typing import Any, Dict, NamedTuple, Union
-from pyparsing import Optional
+from typing import Any, Dict, NamedTuple, Union, Optional
 import requests
 from requests import Response as RResponse
 import json
@@ -82,7 +82,7 @@ 
Source code for pypaystack2.baseapi
 
 
[docs]class Response(NamedTuple):
     """A namedtuple that models the data gotten from making a request to
-    paystacks API endpoints.
+    paystack's API endpoints.
 
     Parameters
     ----------
@@ -111,13 +111,13 @@ 
Source code for pypaystack2.baseapi
     _CONTENT_TYPE = "application/json"
     _BASE_END_POINT = "https://api.paystack.co"
 
-    def __init__(self, auth_key: str = None):
+    def __init__(self, auth_key: Optional[str] = None):
         """
         Parameters
         ----------
         auth_key:
             Your paystack authorization key. Required only
-            if it is not provided in your enviromental
+            if it is not provided in your environmental
             variables as ``PAYSTACK_AUTHORIZATION_KEY=your_key``
 
         """
@@ -145,7 +145,7 @@ 
Source code for pypaystack2.baseapi
     def _parse_json(self, response_obj: RResponse) -> Response:
         """
         This function takes in every json response sent back by the
-        server and trys to get out the important return variables
+        server and tries to get out the important return variables
 
         Returns a python namedtuple of Response which contains
         status code, status(bool), message, data
@@ -177,7 +177,7 @@ 
Source code for pypaystack2.baseapi
         request = method_map.get(method)
 
         if not request:
-            raise InvalidMethodError("Request method not recognised or implemented")
+            raise InvalidMethodError("Request method not recognized or implemented")
 
         response = request(url, headers=self._headers(), data=payload, verify=True)
         if response.status_code == 404:
diff --git a/docs/_modules/pypaystack2/errors.html b/docs/_modules/pypaystack2/errors.html
index 9794db4..5d912bf 100644
--- a/docs/_modules/pypaystack2/errors.html
+++ b/docs/_modules/pypaystack2/errors.html
@@ -38,6 +38,7 @@
               
Contents:

 
 
         

diff --git a/docs/_modules/pypaystack2/utils.html b/docs/_modules/pypaystack2/utils.html
index a5aaf25..95633ae 100644
--- a/docs/_modules/pypaystack2/utils.html
+++ b/docs/_modules/pypaystack2/utils.html
@@ -38,6 +38,7 @@
               
Contents:

 
 
         

diff --git a/docs/_sources/index.rst.txt b/docs/_sources/index.rst.txt
index 809944e..8624d8e 100644
--- a/docs/_sources/index.rst.txt
+++ b/docs/_sources/index.rst.txt
@@ -31,7 +31,7 @@ your python project. for example
    from pypaystack2.api import Miscellaneous # assumes you have installed pypaystack2
    from pypaystack2.utils import Country
    miscellaneous_wrapper = Miscellaneous() # assumes that your paystack auth key is in 
-   # your enviromental variables i.e PAYSTACK_AUTHORIZATION_KEY=your_key otherwise instatiate 
+   # your environmental variables i.e PAYSTACK_AUTHORIZATION_KEY=your_key otherwise instantiate 
    # the Miscellaneous API wrapper as it is done below.
    # miscellaneous_wrapper = Miscellaneous(auth_key=your_paystack_auth_key)
    response = miscellaneous_wrapper.get_banks(country=Country.NIGERIA,use_cursor=False) # Requires internet connection.
@@ -69,7 +69,7 @@ in the ``Invoice`` wrapper. Say you wanted to create an invoice by sending a
 
    from pypaystack2.api import Invoice
    invoice_wrapper = Invoice()
-   response = invoice_wrapper.create(custmer="CUS_xwaj0txjryg393b",amount=1000) # Creates an invoice with a charge of ₦100
+   response = invoice_wrapper.create(customer="CUS_xwaj0txjryg393b",amount=1000) # Creates an invoice with a charge of ₦100
 
 From here you can check out the tutorials section to get more examples and get familiar or surf the
 documentation for wrappers and methods you'll need for your next project. Hurray!
@@ -78,8 +78,10 @@ documentation for wrappers and methods you'll need for your next project. Hurray
    :maxdepth: 2
    :caption: Contents:
 
+   paystack-client-turorial
    modules
    
+   
 
 Indices and tables
 ==================
diff --git a/docs/_sources/paystack-client-turorial.rst.txt b/docs/_sources/paystack-client-turorial.rst.txt
new file mode 100644
index 0000000..77a5abc
--- /dev/null
+++ b/docs/_sources/paystack-client-turorial.rst.txt
@@ -0,0 +1,370 @@
+Tutorial 1
+============================
+
+Paystack Command line Client
+----------------------------
+
+This tutorial aims to expose you to how to use ``pypaystack2`` in your python projects for paystack integrations.
+We'll be building a simple command line application that integrates with paystack's services.
+
+Project Setup
+-------------
+We'll start by setting up our project. We'll be using ``pipenv`` for managing this project's dependencies and
+environment. you're free to use your preferred choice like ``pyenv`` or ``venv``. if you don't have ``pipenv``
+installed yet, you can install it with ``pip install pipenv``. it's important to note that ``pipenv`` should be
+installed globally and not within a virtual environment. You're good to proceed if this prerequisite is met.
+
+- Create a directory to house our project.
+  
+  .. code-block:: bash
+
+    mkdir paystack_cli_client && cd paystack_cli_client
+
+- Initialize a virtual environment for the project.
+  
+   .. code-block:: bash
+
+    pipenv shell
+
+- Install the projects dependencies. We'll be needing ``pypaystack2``, ``python-dotenv``, and ``typer``.
+  ``pypaystack2`` package is an API wrapper for paystack's services. ``python-dotenv`` helps us manage our
+  environmental variables and ``typer`` makes building command line apps in python super simple.
+
+  .. code-block:: bash
+
+    pipenv install pypaystack2 python-dotenv typer
+
+If all work's fine, you're good to proceed.
+
+Environmental Variables
+-----------------------
+``pypaystack2`` depends on your paystack authorization key that you get from signing up to paystack.
+Paystack provides you with two pairs. A pair of public and secret key for live mode and another set
+for test mode. You can find them in your account settings. Since this is just a tutorial we'll be 
+using only the test secret key. create a new file named ``.env`` within your project's root directory.
+Now put in your test secret key in the ``.env`` file like so.
+
+.. code-block:: python
+    
+    PAYSTACK_AUTHORIZATION_KEY = ""
+
+.. warning::
+    Because this is just a tutorial, no extra measure is made to protect this environmental.
+    In a more serious project or production code, extra care should be taken to protect it and
+    also avoid pushing it to a remote source control.
+
+Let the games begin
+-------------------
+It's time to start building! create a new file named ``main.py`` in your root directory.
+
+.. code-block:: python
+    
+    # root-dir/main.py
+    from dotenv import load_dotenv
+    load_dotenv()
+
+What we have just done is loaded our secret test key within the ``.env`` file. You may be
+wondering why do we need that, here's why ``pypaystack2`` needs this key to communicate with
+paystack's api. alternatively, you can pass your authorization key into any of the api wrappers
+provided by ``pypaystack2`` via their ``auth_key`` parameter. Here's a list of all the API wrappers
+currently available as at the time of writing of this tutorial.
+
+- ApplePay
+- BulkCharge
+- Charge
+- ControlPanel
+- Customer
+- DedicatedAccount
+- Dispute
+- Invoice
+- Miscellaneous
+- Page
+- Plan
+- Product
+- Refund
+- Settlement
+- Split
+- SubAccount
+- Subscription
+- Transaction
+- TransferReceipt
+- TransferControl
+- Transfer
+- Verification
+  
+So in a situation where you don't have your ``PAYSTACK_AUTHORIZATION_KEY`` as an environmental variable,
+you can pass it into any of the API wrappers. E.g
+
+.. code-block:: python
+
+    # When you don't have PAYSTACK_AUTHORIZATION_KEY in your environmental variables
+    txn_wrapper = Transaction(auth_key="")
+    plan_wrapper = Plan(auth_key="")
+
+    # When you have PAYSTACK_AUTHORIZATION_KEY set in your environmental variables
+    txn_wrapper = Transaction()
+    plan_wrapper = Plan()
+
+.. note:: 
+    You don't have to provide your authorization key on the instantiation of any of the API wrappers
+    as long as you have it set in your environmental variables like this tutorial does.
+
+On your marks!
+--------------
+The first feature we'll be implementing for our **Paystack Command line Client** is the ability to create
+new customers on our paystack integration. so now update your ``main.py`` file with the code below.
+
+.. code-block:: python
+    
+    # root-dir/main.py
+    from dotenv import load_dotenv
+    from typer import Typer
+
+    load_dotenv()
+
+    app = Typer()
+
+    @app.command()
+    def new_customer():
+        print("new customer successfully created!")
+
+    if __name__ == "__main__":
+        app()
+
+This is a minimum setup to building cli apps with ``Typer``. Now try this in your project's root directory.
+
+.. code-block:: bash
+
+    python main.py --help
+
+You should see.
+
+.. code-block:: bash
+
+    Usage: main.py [OPTIONS]
+
+    Options:
+    --install-completion [bash|zsh|fish|powershell|pwsh]
+                                    Install completion for the specified
+                                    shell.
+    --show-completion [bash|zsh|fish|powershell|pwsh]
+                                    Show completion for the specified shell,
+                                    to copy it or customize the installation.
+    --help                          Show this message and exit.
+
+You can see that we now have a command line app that's responding to our command in this case ``--help``. Lets
+try out the custom command we just added.
+
+.. code-block:: bash
+
+    python main.py
+
+You should see
+
+.. code-block:: bash
+
+    new customer successfully created!
+
+At the moment, no new customer is actually getting created on your paystack integration. let's bring in
+``pypaystack2`` to help us get the job done. For this to work, ``pypaystack2`` provides wrappers for the
+RESTful APIs provided by Paystack. This wrappers are named to closely match the API they wrap and methods
+on these wrappers correspond to endpoints on the Paystack services you're interested in so in this case,
+for us to create a customer on our integration, we need to use the ``Customer`` API wrapper which connects
+to Paystack's Customer Services API. More info at https://paystack.com/docs/api/#customer
+
+.. code-block:: python
+    
+    # root-dir/main.py
+    from typing import Optional
+    from dotenv import load_dotenv
+    from pypaystack2.api import Customer
+    from typer import Typer
+
+    load_dotenv()
+    app = Typer()
+
+    customer_wrapper = Customer()
+
+
+    @app.command()
+    def new_customer(
+    email: str,
+    first_name: Optional[str] = None,
+    last_name: Optional[str] = None,
+    phone: Optional[str] = None,
+    ):
+        response = customer_wrapper.create(
+            email=email, first_name=first_name, last_name=last_name, phone=phone
+        )
+        print(response.status_code)
+        print(response.status)
+        print(response.message)
+        print(response.data)
+
+    if __name__ == "__main__":
+        app()
+
+.. note:: 
+    All API wrappers are available in ``pypaystack2.api``. E.g ``from pypaystack2.api import Split, Transaction``
+
+Now if you run the script again.
+
+.. code-block:: bash
+
+    python main.py
+
+You get error saying you have a missing argument 'EMAIL'
+
+.. code-block:: bash
+
+    Usage: main.py [OPTIONS] EMAIL
+    Try 'main.py --help' for help.
+
+    Error: Missing argument 'EMAIL'.
+
+Now let's try out our script with the email of the customer 
+we want to create.
+
+.. code-block:: bash
+
+    python main.py email@example.com
+
+Now if all goes fine. "An Internet connection is required", you should
+get something similar to this
+
+.. code-block:: bash
+
+    200
+    True
+    Customer created
+    {'transactions': [], 'subscriptions': [], 'authorizations': [], 'first_name': '', 'last_name': '', 'email': 'email@example.com', 'phone': '', 'metadata': None, 'domain': 'test', 'customer_code': 'CUS_kd197ej30zxr34v', 'risk_action': 'default', 'id': 47748473, 'integration': 630606, 'createdAt': '2021-06-20T05:16:20.000Z', 'updatedAt': '2021-06-20T05:16:20.000Z', 'identified': False, 'identifications': None}
+
+**Yay! You've just created a new customer on your integration** You can check out the customer's tab in  
+your Paystack account to confirm this. You can also create new customers with a first name and last name like so.
+
+.. code-block:: bash
+
+    python main.py email@example.com --first-name John --last-name Doe
+
+What just happened?
+-------------------
+You have just created a new customer on your integration with the CLI app you just built. But how? If you've followed 
+this tutorial to this point you already know what wrappers are or you can quickly skim through the chapters before to
+get a refresher. The right question should be what is the ``create`` method on the ``Customer`` wrapper for. You guess
+right if what's on your mind is that it creates the new customer on your integration. So as it was said earlier, all 
+wrappers have methods on them that correspond to an endpoint on paystack and all of this methods will return a ``Response``
+object based on the response it get's from Paystack. This ``Response`` is just a ``NamedTuple`` that holds the 
+``status,status_code,message`` and ``data``. So this call 
+
+.. code-block:: python
+    
+    response = customer_wrapper.create(email=email, first_name=first_name, last_name=last_name, phone=phone)
+
+in our script returns the ``Response`` object just described and you can access each of these attributes with
+``response.status``, ``response.status_code``, ``response.message``, ``response.data``
+
+More Commands!
+--------------
+Lets add a few more commands to our **Paystack Command line Client**
+
+.. code-block:: python
+
+    # root-dir/main.py
+    from typing import Optional
+    from dotenv import load_dotenv
+    from pypaystack2.api import Customer
+    from typer import Typer
+
+    load_dotenv()
+
+    app = Typer()
+
+    customer_wrapper = Customer()
+
+
+    @app.command()
+    def new_customer(
+        email: str,
+        first_name: Optional[str] = None,
+        last_name: Optional[str] = None,
+        phone: Optional[str] = None,
+    ):
+        response = customer_wrapper.create(
+            email=email, first_name=first_name, last_name=last_name, phone=phone
+        )
+        print(response.status_code)
+        print(response.status)
+        print(response.message)
+        print(response.data)
+
+
+    @app.command()
+    def list_customers():
+        response = customer_wrapper.get_customers()
+        print(response.status_code)
+        print(response.status)
+        print(response.message)
+        print(response.data)
+
+
+    @app.command()
+    def get_customer(ec: str):
+        response = customer_wrapper.get_customer(email_or_code=ec)
+        print(response.status_code)
+        print(response.status)
+        print(response.message)
+        print(response.data)
+
+
+    @app.command()
+    def update_customer(code: str, last_name: str, first_name: str):
+        response = customer_wrapper.update(
+            code=code, last_name=last_name, first_name=first_name
+        )
+        print(response.status_code)
+        print(response.status)
+        print(response.message)
+        print(response.data)
+
+
+    if __name__ == "__main__":
+        app()
+
+We now have 3 new commands for our cli app. you can check them out with
+
+.. code-block:: bash 
+    
+    python main.py --help
+
+Now under the available command you should see get-customer, list-customers, new-customer,
+update-customer
+
+.. code-block:: bash
+
+    Usage: main.py [OPTIONS] COMMAND [ARGS]...
+
+    Options:
+    --install-completion [bash|zsh|fish|powershell|pwsh]
+                                    Install completion for the specified
+                                    shell.
+    --show-completion [bash|zsh|fish|powershell|pwsh]
+                                    Show completion for the specified shell,
+                                    to copy it or customize the installation.
+    --help                          Show this message and exit.
+
+    Commands:
+    get-customer
+    list-customers
+    new-customer
+    update-customer
+
+You can try out the new command with the following commands
+
+
+Where to go from here
+---------------------
+**It's all in your hands now**. We now have a working cli app but it does not have all the features
+to make it a fully fledged **Paystack command line client** you can bring in more wrappers and implement
+new commands. It's also does not handle all the likely exception that can occur, but then, the purpose of
+the tutorial is to expose you to ``pypaystack2``. Not sure how something works, you can always search the
+documentation. Good luck on your next project!
\ No newline at end of file
diff --git a/docs/genindex.html b/docs/genindex.html
index 446a279..ea6e4d0 100644
--- a/docs/genindex.html
+++ b/docs/genindex.html
@@ -37,6 +37,7 @@