Updating

Author: Josh Wolff

.idea/workspace.xml

@@ -5,20 +5,20 @@
 
 class SpontitResource:
     """
-
+    Use this resource to access your account and related functions.
     """
     class FunctionStrings(Enum):
         """
-
+        An mapping of function to string. For internal use.
         """
         GET_TOPIC_ID_TO_DISPLAY_NAME_MAPPING = "get_topic_id_to_display_name_mapping"
         PUSH = "push"
 
     def __init__(self, user_id, secret_key):
         """
-
-        :param user_id:
-        :param secret_key:
+        Initializes the resource.
+        :param user_id: Your user ID.
+        :param secret_key: A secret key you generated on spontit.com/secret_keys
         """
         if type(user_id) is not str:
             raise Exception("User ID must be a string.")
@@ -47,7 +47,7 @@ def get_topic_id_to_display_name_mapping(self):
         """
         Sends a put request requesting the topic IDs associated with the user account. You can access the list of topic
         IDs by getting the .keys() of the dictionary returned.
-        :return:
+        :return: Returns either a mapping or an error description (with the key "Error")
         """
         return util.put_request(self.__get_payload_dict(self.FunctionStrings.GET_TOPIC_ID_TO_DISPLAY_NAME_MAPPING))
 
@@ -56,11 +56,12 @@ def push(self,
              link=None,
              to_topic_ids=None):
         """
-
-        :param call_to_action:
-        :param link: [OPTIONAL]
-        :param to_topic_ids: [OPTIONAL]
-        :return:
+        Use this method to send your own push notification!
+        :param call_to_action: The message that you would like to push.
+        :param link: [OPTIONAL] A link for content you would like to attach to the push notification
+        :param to_topic_ids: [OPTIONAL] A list of topic IDS you would like to push to. If to_topic_ids is not specified,
+        then the push notification will be sent to the main channel.
+        :return: Returns either a success response or an error description (with the key "Error")
         """
         # Construct the payload.
         payload = self.__get_payload_dict(self.FunctionStrings.PUSH)

spontit_pkg/LICENSE renamed to LICENSE

@@ -0,0 +1,3 @@
+# Inside of setup.cfg
+[metadata]
+description-file = README.md

build/lib/spontit_pkg/resource.py

@@ -1,5 +1,7 @@
 import setuptools
 
+# Thank you to https://packaging.python.org/tutorials/packaging-projects/
+
 with open("README.md", "r") as fh:
     long_description = fh.read()
 
@@ -19,4 +21,4 @@
         "Operating System :: OS Independent",
     ],
     python_requires='>=3.6',
-)
+)