Metadata-Version: 2.1
Name: drstorage
Version: 0.0.1
Summary: Protocol Parser for Dr. Storage Dry Air Cabinets
Home-page: https://github.com/kratsg/drstorage
Author: Giordon Stark
Author-email: gstark@cern.ch
License: BSD 3-Clause
Project-URL: Documentation, https://kratsg.github.io/drstorage/
Project-URL: Source, https://github.com/kratsg/drstorage
Project-URL: Tracker, https://github.com/kratsg/drstorage/issues
Description: # drstorage
        
        [![GitHub Project](https://img.shields.io/badge/GitHub--blue?style=social&logo=GitHub)](https://github.com/kratsg/drstorage)
        [![GitHub Actions Status: CI](https://github.com/kratsg/drstorage/workflows/CI/badge.svg?branch=master)](https://github.com/kratsg/drstorage/actions?query=workflow%3ACI+branch%3Amaster)
        [![Code Coverage](https://codecov.io/gh/kratsg/drstorage/graph/badge.svg?branch=master)](https://codecov.io/gh/kratsg/drstorage?branch=master)
        [![pre-commit.ci status](https://results.pre-commit.ci/badge/github/kratsg/drstorage/master.svg)](https://results.pre-commit.ci/latest/github/kratsg/drstorage/master)
        [![Code style: black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/psf/black)
        
        ## Installation
        
        In a fresh virtual environment
        
        ```
        $ python -m pip install "git+https://github.com/kratsg/drstorage.git"
        ```
        
        The above is actually cloning and installing directly from the Git repository.
        However, if you want to, you can of course also install it directly from the Git repository "locally" by first cloning the repo and then from the top level of it running
        
        ```
        $ python -m pip install .
        ```
        
        ## Contributing
        
        As this library is experimental contributions of all forms are welcome.
        If you have ideas on how to improve the API or conceptually how a library meant to introduce people to the Scikit-HEP ecosystem should be structured please open an Issue.
        You are of course also most welcome and encouraged to open PRs.
        
        ### Developing
        
        To develop, use a virtual environment.
        Once the environment is activated, clone the repo from GitHub
        
        ```
        git clone git@github.com:kratsg/drstorage.git
        ```
        
        and install all necessary packages for development
        
        ```
        python -m pip install --ignore-installed --upgrade -e .[complete]
        ```
        
        Then setup the Git pre-commit hooks by running
        
        ```
        pre-commit install
        ```
        
        ## Acknowledgements
        
        * Mike Hance
        * Noah Peake
        * Will Johansson
        * James Tranovich
        * Anja Berens
        * Paul Ingemi
        
Keywords: hep utilities physics protocol struct drstorage dry air cabinet
Platform: UNKNOWN
Classifier: Development Status :: 3 - Alpha
Classifier: License :: OSI Approved :: Apache Software License
Classifier: Intended Audience :: Science/Research
Classifier: Topic :: Scientific/Engineering
Classifier: Topic :: Scientific/Engineering :: Interface Engine/Protocol Translator
Classifier: Topic :: Scientific/Engineering :: Physics
Classifier: Topic :: System :: Hardware
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Classifier: Topic :: Utilities
Requires-Python: >=3.6
Description-Content-Type: text/markdown
Provides-Extra: lint
Provides-Extra: test
Provides-Extra: develop
Provides-Extra: complete
