Feature/alias elements

.gitignore

@@ -17,4 +17,10 @@ htmlcov
 .eggs
 
 # coverage
-.coverage
+.coverage
+
+# VirtualEnvs!
+venv
+
+# TOX
+.tox

.travis.yml

@@ -1,9 +1,14 @@
 language: python
 python:
-  - "2.7"
-  - "3.4"
-  - "3.5"
-  - "3.6"
+  - 2.7
+  - 3.5
+  - 3.6
+matrix:
+  include:
+    - python: 3.7
+      dist: xenial
+      sudo: true
+
 
 # command to install dependencies
 install: "python setup.py install"

CONTRIBUTING.md

@@ -3,6 +3,22 @@ Contributing to rwslib
 
 Thank you for considering contributing to rwslib.
 
+Developer Setup
+---------------
+1. Clone the repository
+   ```
+   git clone https://github.com/mdsol/rwslib
+   ```
+2. Create a Virtual Env for the Local instance
+    ```bash
+    $ python -m venv venv
+    $ source venv/bin/activate
+    ```
+3. Install the development dependencies
+    ```bash
+    $ pip install -r requirements-dev.txt
+    ```
+4. Enjoy !!!
 
 Pull Requests
 -------------

docs/source/classes.rst

@@ -4,172 +4,36 @@ Class Reference
 rwslib
 ======
 
-.. module:: rwslib
-
-.. autoclass:: RWSConnection
-   :members: send_request
-
-rwslib.builders
-===============
-Note: Any Class with the Prefix **Mdsol** represents a Medidata Rave specific extension
-
-.. automodule:: rwslib.builders
+.. automodule:: rwslib
     :members:
-    :undoc-members:
-
-.. autoclass:: ActionType
-.. autoclass:: Address
-.. autoclass:: AdminData
-.. autoclass:: Alias
-.. autoclass:: Annotation
-.. autoclass:: Annotations
-.. autoclass:: AuditRecord
-.. autoclass:: BasicDefinitions
-.. autoclass:: CheckValue
-.. autoclass:: City
-.. autoclass:: ClinicalData
-.. autoclass:: CodeList
-.. autoclass:: CodeListItem
-.. autoclass:: CodeListRef
-.. autoclass:: Comment
-.. autoclass:: ControlType
-.. autoclass:: Country
-.. autoclass:: DataType
-.. autoclass:: DateTimeStamp
-.. autoclass:: Decode
-.. autoclass:: DisplayName
-.. autoclass:: Email
-.. autoclass:: FirstName
-.. autoclass:: Flag
-.. autoclass:: FlagType
-.. autoclass:: FlagValue
-.. autoclass:: FormData
-.. autoclass:: FormDef
-.. autoclass:: FormRef
-.. autoclass:: FullName
-.. autoclass:: GlobalVariables
-.. autoclass:: GranularityType
-.. autoclass:: ItemData
-.. autoclass:: ItemDef
-.. autoclass:: ItemGroupData
-.. autoclass:: ItemGroupDef
-.. autoclass:: ItemGroupRef
-.. autoclass:: ItemRef
-.. autoclass:: LastName
-.. autoclass:: LastUpdateMixin
-.. autoclass:: Location
-.. autoclass:: LocationRef
-.. autoclass:: LocationType
-.. autoclass:: LogicalRecordPositionType
-.. autoclass:: LoginName
-.. autoclass:: MODMAttribute
-.. autoclass:: MODMExtensionRegistry
-.. autoclass:: MODMMixin
-.. autoclass:: MdsolAttribute
-.. autoclass:: MdsolCheckAction
-.. autoclass:: MdsolCheckStep
-.. autoclass:: MdsolConfirmationMessage
-.. autoclass:: MdsolCustomFunctionDef
-.. autoclass:: MdsolDerivationDef
-.. autoclass:: MdsolDerivationStep
-.. autoclass:: MdsolEditCheckDef
-.. autoclass:: MdsolEntryRestriction
-.. autoclass:: MdsolHeaderText
-.. autoclass:: MdsolHelpText
-.. autoclass:: MdsolLabelDef
-.. autoclass:: MdsolLabelRef
-.. autoclass:: MdsolProtocolDeviation
-.. autoclass:: MdsolQuery
-.. autoclass:: MdsolReviewGroup
-.. autoclass:: MdsolViewRestriction
-.. autoclass:: MeasurementUnit
-.. autoclass:: MeasurementUnitRef
-.. autoclass:: MetaDataVersion
-.. autoclass:: MetaDataVersionRef
-.. autoclass:: MilestoneMixin
-.. autoclass:: ODM
-.. autoclass:: ODMElement
-.. autoclass:: Organization
-.. autoclass:: OtherText
-.. autoclass:: Phone
-.. autoclass:: PostalCode
-.. autoclass:: Protocol
-.. autoclass:: ProtocolDeviationStatus
-.. autoclass:: QueryStatusType
-.. autoclass:: Question
-.. autoclass:: RangeCheck
-.. autoclass:: RangeCheckComparatorType
-.. autoclass:: RangeCheckType
-.. autoclass:: ReasonForChange
-.. autoclass:: Signature
-.. autoclass:: SignatureRef
-.. autoclass:: SimpleChildElement
-.. autoclass:: SiteRef
-.. autoclass:: SourceID
-.. autoclass:: StateProv
-.. autoclass:: StepType
-.. autoclass:: StreetName
-.. autoclass:: Study
-.. autoclass:: StudyEventData
-.. autoclass:: StudyEventDef
-.. autoclass:: StudyEventRef
-.. autoclass:: SubjectData
-.. autoclass:: Symbol
-.. autoclass:: TransactionalElement
-.. autoclass:: TranslatedText
-.. autoclass:: User
-.. autoclass:: UserRef
-.. autoclass:: UserType
-
-rwslib.rws_requests
-===================
 
-.. module:: rwslib.rws_requests
+Rave Web Services Request Objects
+=================================
 
-.. autoclass:: StudyDatasetRequest
-.. autoclass:: SubjectDatasetRequest
-.. autoclass:: VersionDatasetRequest
-.. autoclass:: ConfigurableDatasetRequest
-
-rwslib.rwsobjects
-=================
-.. module:: rwslib.rwsobjects
+.. automodule:: rwslib.rws_requests
+    :members:
+    :exclude-members: url_path
 
-.. autoclass:: ODMDoc
-.. autoclass:: RWSResponse
-.. autoclass:: RWSException
-.. autoclass:: RWSError
-.. autoclass:: RWSErrorResponse
-.. autoclass:: RWSPostResponse
-.. autoclass:: RWSStudies
-.. autoclass:: RWSSubjects
-.. autoclass:: RWSSubjectListItem
-.. autoclass:: RWSStudyMetadataVersions
-.. autoclass:: MetaDataVersion
+Rave Web Services Objects
+=========================
 
-rwslib.rws_requests.biostats_gateway
-====================================
+.. automodule:: rwslib.rwsobjects
+    :members:
 
-.. module:: rwslib.rws_requests.biostats_gateway
 
-.. autoclass:: CVMetaDataRequest
-.. autoclass:: FormDataRequest
-.. autoclass:: ProjectMetaDataRequest
-.. autoclass:: ViewMetaDataRequest
-.. autoclass:: CommentDataRequest
-.. autoclass:: ProtocolDeviationsRequest
-.. autoclass:: DataDictionariesRequest
+Biostats Gateway
+================
 
-rwslib.rws_requests.odm_adapter
-===============================
+.. automodule:: rwslib.rws_requests.biostats_gateway
+    :members:
+    :exclude-members: url_path, studyoid
 
-.. module:: rwslib.rws_requests.odm_adapter
+ODM Adapter
+===========
 
-.. autoclass:: AuditRecordsRequest
-.. autoclass:: VersionFoldersRequest
-.. autoclass:: SitesMetadataRequest
-.. autoclass:: UsersRequest
-.. autoclass:: SignatureDefinitionsRequest
+.. automodule:: rwslib.rws_requests.odm_adapter
+    :members:
+    :exclude-members: url_path, studyoid
 
 
 

docs/source/classes_builders.rst

@@ -0,0 +1,41 @@
+Class Reference for Builders
+****************************
+
+Metadata Builders
+=================
+
+.. note:: Any Class with the Prefix **Mdsol** represents a Medidata Rave specific extension
+
+.. automodule:: rwslib.builders.metadata
+    :members:
+    :exclude-members: build
+
+Clinical Data Builders
+======================
+
+.. note:: Any Class with the Prefix **Mdsol** represents a Medidata Rave specific extension
+
+.. automodule:: rwslib.builders.clinicaldata
+    :members:
+    :exclude-members: build
+
+
+Medidata Extensions to ODM (MODM) Builders
+==========================================
+
+.. note:: Any Class with the Prefix **Mdsol** represents a Medidata Rave specific extension
+
+.. automodule:: rwslib.builders.clinicaldata
+    :members:
+    :exclude-members: build
+
+
+Administrative Data Builders
+============================
+
+.. note:: Any Class with the Prefix **Mdsol** represents a Medidata Rave specific extension
+
+.. automodule:: rwslib.builders.admindata
+    :members:
+    :exclude-members: build
+

docs/source/index.rst

@@ -25,6 +25,7 @@ Contents:
    odm_adapter
    rwscmd
    classes
+   classes_builders
 
 Indices and tables
 ==================

requirements-dev.txt

@@ -0,0 +1,5 @@
+-r requirements.txt
+httpretty
+tox
+mock
+sphinx

requirements.txt

@@ -1,9 +1,6 @@
 lxml
 requests
-httpretty
-tox
 six
-enum34
-mock
+enum34; python_version < '3.4'
 click
 faker