Metadata-Version: 2.1
Name: heaserver-folders
Version: 1.0.0a23
Summary: The HEA folder service.
Home-page: https://risr.hci.utah.edu
Author: Research Informatics Shared Resource, Huntsman Cancer Institute, Salt Lake City, UT
Author-email: Andrew.Post@hci.utah.edu
License: UNKNOWN
Description: # HEA Server Folders Microservice
        [Research Informatics Shared Resource](https://risr.hci.utah.edu), [Huntsman Cancer Institute](https://healthcare.utah.edu/huntsmancancerinstitute/), 
        Salt Lake City, UT
        
        The HEA Server Folders Microservice manages the folders of the HEA desktop.
        
        ## Version 1
        Initial release.
        
        ## Runtime requirements
        * Python 3.8
        
        ## Development environment
        
        ### Build requirements
        * Any development environment is fine.
        * On Windows, you also will need:
            * Build Tools for Visual Studio 2019, found at https://visualstudio.microsoft.com/downloads/. Select the C++ tools.
            * git, found at https://git-scm.com/download/win.
        * On Mac, Xcode or the command line developer tools is required, found in the Apple Store app.
        * Python 3.8: Download and install Python 3.8 from https://www.python.org, and select the options to install for all users and add
        Python to your environment variables. The install for all users option will help keep you from accidentally installing
        packages into your Python installation's site-packages directory instead of to your virtualenv environment, described
        below.
        * Create a virtualenv environment using the `python -m venv <venv_directory>` command, substituting `<venv_directory>`
        with the directory name of your virtual environment. Run `source <venv_directory>/bin/activate` (or `<venv_directory>/Scripts/activate` on Windows) to activate the virtual
        environment. You will need to activate the virtualenv every time before starting work, or your IDE may be able to do 
        this for you automatically. **Note that PyCharm will do this for you, but you have to create a new Terminal panel
        after you newly configure a project with your virtualenv.**
        * From the project's root directory, and using the activated virtualenv, run `pip install -r requirements_dev.txt`.
        **Do NOT run `python setup.py develop`. It will break your environment.**
        
        ### Running tests
        Run tests with the `pytest` command from the project root directory.
        
        ### Versioning
        Use semantic versioning as described in 
        https://packaging.python.org/guides/distributing-packages-using-setuptools/#choosing-a-versioning-scheme. In addition,
        while development is underway, the version should be the next version number suffixed by `.dev`.
        
        ### Version tags in git
        Version tags should follow the format `heaserver-folders-<version>`, for example, `heaserver-folders-1.0.0`.
        
        ### Uploading to an index server
        The following instructions assume separate stable and staging indexes. Numbered releases, including alphas and betas, go 
        into the stable index. Snapshots of works in progress go into the staging index. Thus, use staging to upload numbered
        releases, verify the uploaded packages, and then upload to stable.
        
        From the project's root directory:
        1. For numbered releases, remove `.dev` from the version number in setup.py, tag it in git to indicate a release, 
        and commit to version control. Skip this step for developer snapshot releases.
        2. Run `python setup.py clean --all sdist bdist_wheel` to create the artifacts.
        3. Run `twine upload -r <repository> dist/<wheel-filename> dist/<tarball-filename>` to upload to the
         repository. The repository name has to be defined in a twine configuration file such as `$HOME/.pypirc`.
        4. For numbered releases, increment the version number in setup.py, append `.dev` to it, and commit to version 
        control with a commit message like, "Prepare for next development iteration."
        
Platform: UNKNOWN
Classifier: Development Status :: 2 - Pre-Alpha
Classifier: Intended Audience :: Developers
Classifier: Intended Audience :: Science/Research
Classifier: License :: OSI Approved :: Apache Software License
Classifier: Framework :: AsyncIO
Classifier: Environment :: Web Environment
Classifier: Natural Language :: English
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.8
Classifier: Topic :: Software Development
Classifier: Topic :: Scientific/Engineering
Classifier: Topic :: Scientific/Engineering :: Bio-Informatics
Classifier: Topic :: Scientific/Engineering :: Information Analysis
Classifier: Topic :: Scientific/Engineering :: Medical Science Apps.
Requires-Python: >=3.8
Description-Content-Type: text/markdown
