installation-on-pycharm.md

Defining environment variable

• Python and PIP should be defined in your PATH. Verify the same using below commands:

  pip --version //This will display the version of PIP dependency manager installed.

  python --version //This will display the version of Python installed. This should be >=2.7.1, if you are using Python 2 else it can be >=3.4 if you are using Python 3.

• Use the below command to navigate to the directory:

  cd pepipost_python

Quickstart- Using the SDK from GitHub repository

1. Run the below command to download the requirements:

   pip install -r requirements.txt

   

2. Open project in an IDE. Here we have used PyCharm IDE. The basic workflow presented here is also applicable if you prefer using a different editor or IDE.

   

   Click on Open in PyCharm to browse to your generated SDK directory and then

   Click OK

   

   The project files will be displayed in the side bar as follows:

   

3. Add a new "Test Project"

   Create a new directory by right clicking on the solution name as shown below:

   

   Name the directory as "test"

   

   Add a python file to this project with the name "testsdk"

   

   Name it "testsdk"

   

4. Importing files from python library

   In order to import file you need to just copy the sample file from here.

   

5. Get your API key and Sending Domain from your Pepipost account.

   • apikey will be available under Login to Pepipost -> Settings -> Integration
   • Sending Domain will be available under Login to Pepiost -> Settings -> Sending Domains

  *Note :: Domains showing with Active status on Sending Domain dashboard are only allowed to send any sort of emails.* In case there are no Sending Domain added under your account, then first add the domain, get the DNS (SPF/DKIM) settings done and get it reviewed by our compliance team for approval. Once the domain is approved, it will be in ACTIVE status and will be ready to send any sort of emails. 

6. Run the Test Project

   Ctrl+F5

   OR

   Right click on your Python file inside your Test project and click on Run