Metadata-Version: 1.1
Name: castorapi
Version: 0.1.2
Summary: Python API wrapper for Castor EDC to fetch data from you clinical study.
Home-page: https://github.com/wouterpotters/castorapi
Author: Wouter V. Potters
Author-email: w.v.potters@amsterdamumc.nl
License: MIT
Download-URL: https://github.com/wouterpotters/castorapi/archive/master.zip
Description: # castorapi
        Python API wrapper for Castor EDC to fetch data from you clinical study.
        
        ## Install
        It is recommended to use anaconda.
        
        Using conda: ![Conda logo](https://anaconda.org/wouterpotters/castorapi/badges/installer/conda.svg)
        
            conda install -c wouterpotters castorapi
        
        or from the conda-forge channel
        
            conda install -c conda-forge castorapi
        
        Using pip (https://pypi.org/project/castorapi/)
        
            pip install castorapi
        
        ## Usage
        First, make sure that save the client and secret from your Castor account in 
        seperate *client* and *secret* files (without line endings) in a private 
        folder on your PC. Do not share these files with anyone.    
        
        See also https://data.castoredc.com/api and https://helpdesk.castoredc.com/article/124-application-programming-interface-api
        
        ## Example code
            import castorapi
            c = CastorApi("/path/to/folder/with/secret_client")
            c.select_study_by_name("<castor_name_of_your_study>")
            
            # export data - fast method
            data = c.request_study_export_data() 
            
            # export data - slow method, but required if you have many records
            # or if you get a error 500 
            data = c.records_reports_all()
        
        ## NOTE
        I am not affiliated with Castor EDC in any way. Use this software at your own risk.
        
        ## TODO
        - implement POST endpoints of the api
        - implement PATCH endpoints of the api
        
Keywords: Castor EDC,API,Castor,Clinical study,database,data science
Platform: UNKNOWN
Classifier: Development Status :: 3 - Alpha
Classifier: Intended Audience :: Developers
Classifier: Topic :: Software Development :: Build Tools
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python :: 3
