Metadata-Version: 2.1
Name: redata
Version: 0.2.0
Summary: Commons code used by ReDATA software
Home-page: https://github.com/UAL-ODIS/redata-commons/
Author: Chun Ly
Author-email: astro.chun@gmail.com
License: MIT License
Project-URL: Source, https://github.com/UAL-ODIS/redata-commons/
Project-URL: Tracker, https://github.com/UAL-ODIS/redata-commons/issues
Description: # redata-commons
        
        - [Overview](#overview)
        - [Installation](#installation)
        - [Execution](#execution)
            - [Using `git_info`](#using-git_info)
        - [Authors](#authors)
        - [License](#license)
        
        
        ## Overview
        
        This repository contains commonly used codes by ReDATA software
        
        The primary sub-package is `commons`. It includes a number of modules, such as:
        1. `git_info`
        2. `...`
        
        
        ## Installation
        
        From PyPI:
        ```
        (venv) $ pip install redata
        ```
        
        From source:
        ```
        (venv) $ git clone git@github.com:UAL-ODIS/redata-commons.git
        (venv) $ python setup.py install
        ```
        
        
        ## Execution
        
        ### Using `git_info`
        
        To use, there are a number of ways to import it the main class, `GitInfo`.
        
        ```python3
        import redata
        
        code_path = "/path/to/repo"
        gi = redata.commons.git_info.GitInfo(code_path)
        ```
        
        or
        
        ```python3
        from redata.commons.git_info import GitInfo
        
        code_path = "/path/to/repo"
        gi = GitInfo(code_path)
        ```
        
        
        ## Authors
        
        * Chun Ly, Ph.D. ([@astrochun](http://www.github.com/astrochun)) - [University of Arizona Libraries](https://github.com/ualibraries), [Office of Digital Innovation and Stewardship](https://github.com/UAL-ODIS)
        
        See also the list of
        [contributors](https://github.com/UAL-ODIS/redata-commons/contributors) who participated in this project.
        
        
        ## License
        
        This project is licensed under the [MIT License](https://opensource.org/licenses/MIT) - see the [LICENSE](LICENSE) file for details.
        
Platform: UNKNOWN
Classifier: Development Status :: 4 - Beta
Classifier: Programming Language :: Python :: 3 :: Only
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Requires-Python: >=3.7
Description-Content-Type: text/markdown
