Setting up the project for PyPi deployment on pip.

Updated README
Created LICENSE

.gitignore

@@ -10,7 +10,11 @@ __pycache__/
 local_settings.py
 db.sqlite3
 media
+
+
+### Other ###
 tests.py
+venmo_api/test.py
 
 ### Linux ###
 *~
@@ -124,6 +128,7 @@ fabric.properties
 # C extensions
 *.so
 
+
 # Distribution / packaging
 .Python
 env/
@@ -143,6 +148,7 @@ wheels/
 .installed.cfg
 *.egg
 
+
 # PyInstaller
 #  Usually these files are written by a python script from a template
 #  before PyInstaller builds the exe, so as to inject date/other infos into it.

README.md

@@ -4,17 +4,35 @@
 
 This is a wrapper for the Venmo API. This library provides a Python interface for the Venmo API. It's compatible with Python versions 3.6+.
 
-## Usage
+## Installing
+
+You can install or upgrade venmo-api with:
+
+```bash
+$ pip3 install venmo-api --upgrade
+```
+
+Or you can install it from the source:
+
+```bash
+$ git clone https://github.com/mmohades/Venmo.git --recursive
+$ cd python-telegram-bot
+$ python setup.py install
+```
+
+## Getting Started
+
+### Usage
 
 In short, you can send money, request for money, get a user's public transactions, get a user's public profile info, etc. The following is an example of initializing and working with it.
 
  ```python
-from Venmo import VenmoApi
+from venmo_api import Client
 
 # Get your access token. You will need to complete the 2FA process
-access_token = VenmoApi.get_access_token(username='myemail@random.com',
+access_token = Client.get_access_token(username='myemail@random.com',
                                           password='your password')
-venmo_api = VenmoApi(access_token=access_token)
+venmo = Client(access_token=access_token)
 
 # Search for users. You get 50 results per page.
 users = venmo.user.search_for_users(query="Peter",
@@ -32,6 +50,19 @@ venmo.user.search_for_users(query="peter",
                              count=10)
 
  ```
+Just keep this in mind that your access token almost never expires! You will need to revoke it by yoursef.
+
+```Python
+venmo.log_out("Bearer a40fsdfhsfhdsfjhdkgljsdglkdsfj3j3i4349t34j7d")
+```
+
+```python
+# Request money
+users = venmoash.payment.request_money(32.5, "house expenses", "1122334455667")
+```
+
+
+
 Getting a user's public transactions
 
 ```python
@@ -45,19 +76,14 @@ venmo_api.user.get_user_transactions(user_id='0000000000000',
 ```
 
 
-## Getting Started
-
-### Installation
-
-
 
 ### Documentation
 
-
+`venmo-api`'s documentation lives at [readthedocs.io](https://venmo.readthedocs.io/en/latest/).
 
 ## Contributing
 
-Contributions of all sizes are welcome. You can also help by [reporting bugs](https://github.com/mmohades/VenmoApi/issues/new).
+Contributions of all sizes are welcome. You can help with the wrapper documentation located in /docs. You can also help by [reporting bugs](https://github.com/mmohades/VenmoApi/issues/new). You can add more routes to both  [Venmo Unofficial API Documentation](https://github.com/mmohades/VenmoApiDocumentation) and the `venmo-api` wrapper. 
 
 ## Venmo Unofficial API Documentation
 

requirements.txt

@@ -0,0 +1 @@
+requests>=2.19.0

setup.py

@@ -0,0 +1,52 @@
+#!/usr/bin/env python
+
+"""The setup script."""
+from setuptools import setup, find_packages
+
+with open('README.md') as readme_file:
+    readme = readme_file.read()
+
+
+def requirements():
+    """Build the requirements list for this project"""
+    requirements_list = []
+
+    with open('requirements.txt') as requirements:
+        for install in requirements:
+            requirements_list.append(install.strip())
+
+    return requirements_list
+
+
+requirements = requirements()
+
+setup(
+    name='venmo-api',
+    version='0.1.0',
+    author="Mark Mohades",
+    author_email='mohades@umd.edu',
+    license="GNU General Public License v3",
+    url='https://github.com/mmohades/venmo',
+    keywords='Python Venmo API wrapper',
+    description="A simple Python wrapper for the Venmo API",
+    long_description=readme,
+    long_description_content_type="text/markdown",
+    packages=find_packages(),
+    install_requires=requirements,
+    python_requires='>=3.6',
+    include_package_data=True,
+    classifiers=[
+        'Development Status :: 3 - Alpha',
+        'Intended Audience :: Developers',
+        'License :: OSI Approved :: GNU General Public License v3 (GPLv3)',
+        'Operating System :: OS Independent',
+        'Natural Language :: English',
+        'Topic :: Software Development :: Libraries :: Python Modules',
+        'Topic :: Internet',
+        'Programming Language :: Python',
+        'Programming Language :: Python :: 3',
+        'Programming Language :: Python :: 3.6',
+        'Programming Language :: Python :: 3.7',
+        'Programming Language :: Python :: 3.8',
+    ]
+)

venmo_api/__init__.py

@@ -0,0 +1,26 @@
+from .models.exception import *
+
+from .utils import (string_to_timestamp, get_phone_model_from_json, random_device_id, deserialize, wrap_callback,
+                    warn, confirm)
+from .utils.api_client import ApiClient
+
+from .models.json_schema import JSONSchema
+from .models.user import User
+from .models.transaction import Transaction
+from .models.payment_method import PaymentMethod, PaymentRole, PaymentPrivacy
+
+from .apis.auth_api import AuthenticationApi
+from .apis.payment_api import PaymentApi
+from .apis.user_api import UserApi
+
+from .venmo import Client
+
+
+__all__ = ["AuthenticationFailedError", "InvalidArgumentError", "InvalidHttpMethodError", "ArgumentMissingError",
+           "JSONDecodeError", "ResourceNotFoundError", "HttpCodeError", "NoPaymentMethodFoundError",
+           "string_to_timestamp", "get_phone_model_from_json", "random_device_id", "deserialize", "wrap_callback",
+           "warn", "confirm",
+           "JSONSchema", "User", "Transaction", "PaymentMethod", "PaymentRole", "PaymentPrivacy",
+           "ApiClient", "AuthenticationApi", "UserApi", "PaymentApi",
+           "Client"
+           ]

apis/auth_api.py → venmo_api/apis/auth_api.py

@@ -1,6 +1,6 @@
-from utils import random_device_id, warn, confirm
-from models.exception import AuthenticationFailedError
-from utils.api_client import ApiClient
+from venmo_api import random_device_id, warn, confirm
+from venmo_api import AuthenticationFailedError
+from venmo_api import ApiClient
 
 
 class AuthenticationApi(object):
@@ -26,7 +26,7 @@ def login_using_credentials(self, username: str, password: str) -> str:
 
         header_params = {'device-id': self.__device_id,
                          'Content-Type': 'application/json',
-                         'Host': 'api.venmo.com'
+                         'Host': 'api.venmo_api.com'
                          }
 
         body = {"phone_email_or_username": username,
@@ -51,7 +51,7 @@ def login_using_credentials(self, username: str, password: str) -> str:
 
     def __two_factor_process(self, response):
 
-        otp_secret = response['headers']['venmo-otp-secret']
+        otp_secret = response['headers']['venmo_api-otp-secret']
         self.__send_text_otp(otp_secret=otp_secret)
         user_otp = self.__ask_user_for_otp_password()
 
@@ -64,7 +64,7 @@ def __send_text_otp(self, otp_secret):
 
         header_params = {'device-id': self.__device_id,
                          'Content-Type': 'application/json',
-                         'venmo-otp-secret': otp_secret
+                         'venmo_api-otp-secret': otp_secret
                          }
         body = {"via": "sms"}
         resource_path = '/account/two-factor/token'
@@ -94,8 +94,8 @@ def __ask_user_for_otp_password():
     def __login_using_otp(self, user_otp, otp_secret):
 
         header_params = {'device-id': self.__device_id,
-                         'venmo-otp': user_otp,
-                         'venmo-otp-secret': otp_secret
+                         'venmo_api-otp': user_otp,
+                         'venmo_api-otp-secret': otp_secret
                          }
         params = {'client_id': 1}
         resource_path = '/oauth/access_token'

apis/payment_api.py → venmo_api/apis/payment_api.py

@@ -1,7 +1,7 @@
-from utils.api_client import ApiClient
-from models import User, PaymentMethod, PaymentRole, PaymentPrivacy
-from models.exception import ArgumentMissingError, NoPaymentMethodFoundError
-from utils import deserialize, wrap_callback
+from venmo_api import ApiClient
+from venmo_api import User, PaymentMethod, PaymentRole, PaymentPrivacy
+from venmo_api import ArgumentMissingError, NoPaymentMethodFoundError
+from venmo_api import deserialize, wrap_callback
 from threading import Thread
 from typing import List, Union
 
@@ -55,8 +55,8 @@ def send_money(self, amount: float,
 
     def request_money(self, amount: float,
                       note: str,
-                      privacy_setting: str = PaymentPrivacy.private.value,
                       target_user_id: int = None, target_user: User = None,
+                      privacy_setting: str = PaymentPrivacy.private.value,
                       callback=None) -> Union[bool, Thread]:
         """
         Request money from a user.

apis/user_api.py → venmo_api/apis/user_api.py

@@ -1,7 +1,7 @@
-from models.user import User
-from models.transaction import Transaction
-from models.exception import InvalidArgumentError, ArgumentMissingError
-from utils import deserialize, wrap_callback
+from venmo_api import User
+from venmo_api import Transaction
+from venmo_api import InvalidArgumentError, ArgumentMissingError
+from venmo_api import deserialize, wrap_callback
 from threading import Thread
 from typing import List, Union
 

models/exception.py → venmo_api/models/exception.py

@@ -71,3 +71,8 @@ class NoPaymentMethodFoundError(Exception):
     def __init__(self, msg: str = None, reason=None):
         self.msg = msg or ("No eligible payment method found." + "" or reason)
         super(NoPaymentMethodFoundError, self).__init__(self.msg)
+
+
+__all__ = ["AuthenticationFailedError", "InvalidArgumentError", "InvalidHttpMethodError", "ArgumentMissingError",
+           "JSONDecodeError", "ResourceNotFoundError", "HttpCodeError", "NoPaymentMethodFoundError"
+           ]

models/payment_method.py → venmo_api/models/payment_method.py

@@ -1,6 +1,6 @@
 from typing import Dict
 from enum import Enum
-from utils.json_schema import JSONSchema
+from venmo_api import JSONSchema
 
 
 class PaymentMethod(object):

models/transaction.py → venmo_api/models/transaction.py

@@ -1,7 +1,7 @@
-from utils import string_to_timestamp
-from models.user import User
-from utils import get_phone_model_from_json
-from utils.json_schema import JSONSchema
+from venmo_api import string_to_timestamp
+from venmo_api import User
+from venmo_api import get_phone_model_from_json
+from venmo_api import JSONSchema
 
 
 class Transaction(object):

models/user.py → venmo_api/models/user.py

@@ -1,5 +1,5 @@
-from utils import string_to_timestamp
-from utils.json_schema import JSONSchema
+from venmo_api import string_to_timestamp
+from venmo_api import JSONSchema
 
 
 class User(object):

utils/api_client.py → venmo_api/utils/api_client.py

@@ -1,8 +1,8 @@
-import requests
-import threading
 from json import JSONDecodeError
 from typing import List
-from models.exception import ResourceNotFoundError, InvalidHttpMethodError, HttpCodeError
+from venmo_api import ResourceNotFoundError, InvalidHttpMethodError, HttpCodeError
+import requests
+import threading
 
 
 class ApiClient(object):

venmo.py → venmo_api/venmo.py

@@ -1,8 +1,7 @@
-from utils.api_client import ApiClient
-from apis import *
+from venmo_api import ApiClient, UserApi, PaymentApi, AuthenticationApi
 
 
-class VenmoApi(object):
+class Client(object):
 
     def __init__(self, access_token: str):
         """