Merge pull request #21 from Capitains/pkging

Pkging

.gitignore

@@ -3,7 +3,7 @@
 
 # Setuptools distribution folder.
 /dist/
-
+/doc/build/
 # Python egg metadata, regenerated from source files by setuptools.
 /*.egg-info
 
@@ -15,4 +15,4 @@ __pycache__
 lxml-3.4.4-py3.4-linux-x86_64.egg/
 *.egg
 /.eggs/
-/venv*/
+/venv*/

MANIFEST.in

@@ -0,0 +1 @@
+recursive-include MyCapytain *.py

MyCapytain/__init__.py

@@ -7,4 +7,8 @@
 .. moduleauthor:: Thibault Clérice <leponteineptique@gmail.com>
 
 
-"""
+"""
+
+__name__ = "MyCapytain"
+__version__ = "0.0.1"
+__all__ = ["common", "endpoints", "resources"]

MyCapytain/common/__init__.py

@@ -0,0 +1,9 @@
+# -*- coding: utf-8 -*-
+"""
+.. module:: MyCapytain.common
+   :synopsis: Set of tools for common uses of CTS objects
+
+.. moduleauthor:: Thibault Clérice <leponteineptique@gmail.com>
+
+
+"""

MyCapytain/common/metadata.py

@@ -1,3 +1,12 @@
+# -*- coding: utf-8 -*-
+"""
+.. module:: MyCapytain.common.metadata
+   :synopsis: Metadata related objects
+
+.. moduleauthor:: Thibault Clérice <leponteineptique@gmail.com>
+
+
+"""
 from __future__ import unicode_literals
 
 

MyCapytain/common/reference.py

@@ -1,3 +1,12 @@
+# -*- coding: utf-8 -*-
+"""
+.. module:: MyCapytain.common.reference
+   :synopsis: URN related objects
+
+.. moduleauthor:: Thibault Clérice <leponteineptique@gmail.com>
+
+
+"""
 from __future__ import unicode_literals
 
 

MyCapytain/common/utils.py

@@ -1,3 +1,12 @@
+# -*- coding: utf-8 -*-
+"""
+.. module:: MyCapytain.common.reference
+   :synopsis: Common useful tools and constants
+
+.. moduleauthor:: Thibault Clérice <leponteineptique@gmail.com>
+
+
+"""
 from __future__ import unicode_literals
 
 

MyCapytain/endpoints/__init__.py

@@ -0,0 +1,9 @@
+# -*- coding: utf-8 -*-
+"""
+.. module:: MyCapytain.endpoints
+   :synopsis: Implementation and abstraction of CTS related endpoints
+
+.. moduleauthor:: Thibault Clérice <leponteineptique@gmail.com>
+
+
+"""

MyCapytain/endpoints/ahab.py

@@ -1,3 +1,12 @@
+# -*- coding: utf-8 -*-
+"""
+.. module:: MyCapytain.endpoints.ahab
+   :synopsis: Ahab endpoint implementation
+
+.. moduleauthor:: Thibault Clérice <leponteineptique@gmail.com>
+
+
+"""
 from . import proto
 import requests
 

MyCapytain/endpoints/cts5.py

@@ -1,3 +1,12 @@
+# -*- coding: utf-8 -*-
+"""
+.. module:: MyCapytain.endpoints.cts5
+   :synopsis: CTS5 endpoint implementation
+
+.. moduleauthor:: Thibault Clérice <leponteineptique@gmail.com>
+
+
+"""
 from . import proto
 import requests
 

MyCapytain/endpoints/proto.py

@@ -1,5 +1,11 @@
+# -*- coding: utf-8 -*-
 """
-    Prototypes used for implementation of API abstraction
+.. module:: MyCapytain.endpoints.proto
+   :synopsis: Prototypes of APIs endpoint
+
+.. moduleauthor:: Thibault Clérice <leponteineptique@gmail.com>
+
+
 """
 class API(object):
     """ API Prototype object """

MyCapytain/resources/__init__.py

@@ -0,0 +1,9 @@
+# -*- coding: utf-8 -*-
+"""
+.. module:: MyCapytain.resources
+   :synopsis: Text and repository related objects
+
+.. moduleauthor:: Thibault Clérice <leponteineptique@gmail.com>
+
+
+"""

MyCapytain/resources/proto/__init__.py

@@ -0,0 +1,9 @@
+# -*- coding: utf-8 -*-
+"""
+.. module:: MyCapytain.resources.proto
+   :synopsis: Prototypes for Text and repository
+
+.. moduleauthor:: Thibault Clérice <leponteineptique@gmail.com>
+
+
+"""

MyCapytain/resources/proto/inventory.py

@@ -1,6 +1,13 @@
+# -*- coding: utf-8 -*-
 """
-    Resources Prototypes
+.. module:: MyCapytain.resources.proto.inventory
+   :synopsis: Prototypes for repository/inventory
+
+.. moduleauthor:: Thibault Clérice <leponteineptique@gmail.com>
+
+
 """
+
 from MyCapytain.common.reference import URN, Reference
 from MyCapytain.common.metadata import Metadata
 from past.builtins import basestring

MyCapytain/resources/proto/text.py

@@ -1,3 +1,12 @@
+# -*- coding: utf-8 -*-
+"""
+.. module:: MyCapytain.resources.proto.text
+   :synopsis: Prototypes for Text
+
+.. moduleauthor:: Thibault Clérice <leponteineptique@gmail.com>
+
+
+"""
 from . import inventory
 
 class Resource(object):

MyCapytain/resources/xml.py

@@ -1,3 +1,12 @@
+# -*- coding: utf-8 -*-
+"""
+.. module:: MyCapytain.resources.xml
+   :synopsis: XML based Text and repository
+
+.. moduleauthor:: Thibault Clérice <leponteineptique@gmail.com>
+
+
+"""
 from __future__ import unicode_literals
 
 from MyCapytain.resources.proto import inventory

devnotes.md

@@ -12,4 +12,9 @@ class MyTest(TestCase):
             my_method_under_test()
             # Ensure patched get was called, called only once and with exactly these params.
             patched_get.assert_called_once_with("https://ec2.amazonaws.com/", params={'Action': 'GetConsoleOutput', 'InstanceId': 'i-123456'})
-```
+```
+
+###Useful links
+
+Submitting : 
+- http://peterdowns.com/posts/first-time-with-pypi.html