Metadata-Version: 2.1
Name: cpac-py
Version: 0.2.4
Summary: C-PAC Python Package
Home-page: https://github.com/FCP-INDI/cpac-python-package
Author: C-PAC developers
Author-email: cpac@cnl.childmind.org
License: mit
Description: ===============================================================
        C-PAC Python Package |github-version| |build-status| |coverage|
        ===============================================================
        
        A Python package that wraps `C-PAC <http://fcp-indi.github.io>`_, enabling users to install cpac with `pip <https://pip.pypa.io>`_ and run from the command line.
        
        
        Description
        ===========
        
        C-PAC Python Package is a lightweight Python package that handles interfacing a user's machine and a C-PAC container through a command line interface.
        
        Dependencies
        ============
        
        * `Python <https://www.python.org>`_ ≥3.6
        * `pip <https://pip.pypa.io>`_
        * At least one of:
        
          * `Docker <https://www.docker.com>`_
          * `Singularity <https://sylabs.io/singularity>`_ ≥2.5&≤3.0
        
        Usage
        =====
        
        .. BEGIN USAGE
        
        .. code-block:: shell
        
            cpac --help
            usage: cpac [-h] [--platform {docker,singularity}] [--image IMAGE] [--tag TAG]
                        [--version] [-v] [-vv] [--working_dir PATH] [--temp_dir PATH]
                        [--output_dir PATH] [-o OPT [OPT ...]]
                        [-B CUSTOM_BINDING [CUSTOM_BINDING ...]]
                        {run,group,utils,crash} ...
            
            cpac: a Python package that simplifies using C-PAC <http://fcp-indi.github.io>
            containerized images. If no platform nor image is specified, cpac will try
            Docker first, then try Singularity if Docker fails.
            
            positional arguments:
              {run,group,utils,crash}
            
            optional arguments:
              -h, --help            show this help message and exit
              --platform {docker,singularity}
              --image IMAGE         path to Singularity image file OR name of Docker image
                                    (eg, "fcpindi/c-pac"). Will attempt to pull from
                                    Singularity Hub or Docker Hub if not provided.
              --tag TAG             tag of the Docker image to use (eg, "latest" or
                                    "nightly").
              --version             show program's version number and exit
              -v, --verbose         set loglevel to INFO
              -vv, --very-verbose   set loglevel to DEBUG
              --working_dir PATH    working directory
              --temp_dir PATH       directory for temporary files
              --output_dir PATH     directory where output files should be stored
              -o OPT [OPT ...], --container_option OPT [OPT ...]
                                    parameters and flags to pass through to Docker or
                                    Singularity
              -B CUSTOM_BINDING [CUSTOM_BINDING ...], --custom_binding CUSTOM_BINDING [CUSTOM_BINDING ...]
                                    directory to bind to container with a different path
                                    than the real path in the format
                                    real_path:container_path (eg,
                                    /home/C-PAC/run5/outputs:/outputs). Use absolute paths
                                    for both paths
        
        .. END USAGE
        
        .. |github-version| image:: https://img.shields.io/github/tag/shnizzedy/cpac-python-package.svg
            :target: https://github.com/shnizzedy/cpac-python-package/releases
            :alt: GitHub version
        .. |build-status| image:: https://travis-ci.org/shnizzedy/cpac-python-package.svg?branch=master
            :target: https://travis-ci.org/shnizzedy/cpac-python-package
            :alt: Travis CI build status
        .. |coverage| image:: https://coveralls.io/repos/github/shnizzedy/cpac-python-package/badge.svg?branch=master
            :target: https://coveralls.io/github/shnizzedy/cpac-python-package?branch=master
            :alt: coverage badge
        
Platform: any
Classifier: Development Status :: 2 - Pre-Alpha
Classifier: Intended Audience :: Science/Research
Classifier: License :: OSI Approved :: MIT License
Classifier: Natural Language :: English
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 3
Classifier: Topic :: Scientific/Engineering :: Bio-Informatics
Requires-Python: >=3.6
Description-Content-Type: text/x-rst
Provides-Extra: testing
