Metadata-Version: 2.1
Name: sdss-tree
Version: 4.0.0
Summary: Control and setup of SDSS tree environment and modules
Home-page: https://github.com/sdss/tree
Author: Brian Cherinka
Author-email: bcherinka@stsci.edu
License: BSD 3-Clause License
Project-URL: Repository, https://github.com/sdss/tree
Project-URL: Documentation, https://sdss-tree.readthedocs.org
Description: # tree
        
        ![Versions](https://img.shields.io/badge/python->3.7-blue)
        [![Documentation Status](https://readthedocs.org/projects/sdss-tree/badge/?version=latest)](https://sdss-tree.readthedocs.io/en/latest/?badge=latest)
        [![Build Sphinx Documentation](https://github.com/sdss/tree/actions/workflows/sphinxbuild.yml/badge.svg)](https://github.com/sdss/tree/actions/workflows/sphinxbuild.yml)
        [![Build and Test](https://github.com/sdss/tree/actions/workflows/build.yml/badge.svg)](https://github.com/sdss/tree/actions/workflows/build.yml)
        [![codecov](https://codecov.io/gh/sdss/tree/branch/master/graph/badge.svg)](https://codecov.io/gh/sdss/tree)
        
        This product contains the definition(s) of the SDSS Science Archiver Server (SAS) filesystem environment tree(s).  It
        sets up the SDSS environment configuration files for loading either via the [Modules Environment Manager](http://modules.sourceforge.net/) or dynamically with a ``tree.Tree`` python package.  Available environments are a SDSS "working" environment, i.e. ``sdsswork`` or any number of environments for public Data
        Releases, i.e. ``dr16.cfg``.  See full documentation at http://sdss-tree.readthedocs.io/en/latest/.
        
        
        ## Developer Install
        
        To install tree for development:
        
        ```
        git clone https://github.com/sdss/tree
        cd tree
        pip install -e ".[dev,docs]"
        ```
        
        ## Build Sphinx Docs
        
        Within the top level repo directory, run the `sdsstools` commands:
        ```
        # build the Sphinx documentation
        sdss docs.build
        
        # open the docs locally in a browser
        sdss docs.show
        ```
        Documentation is automatically built and pushed to Read The Docs.
        
        ## Testing
        Tests are created using `pytest`.  Navigate to the `tests` directory from the top level and run with `pytest`.
        ```
        cd tests
        pytest
        ```
        
        ## Creating Releases
        
        New releases of `sdss-tree` are created automatically, and pushed to [PyPi](https://pypi.org/project/sdss-tree/), when new tags are pushed to Github.  See the [Create Release](.github/workflows/release.yml) Github Action and [Releases](https://github.com/sdss/tree/releases) for the list.
        
        New tag names follow the Python semantic versioning syntax, i.e. `X.Y.Z`.
        
        
        ## Useful links
        
        - GitHub: https://github.com/sdss/tree
        - Documentation: https://sdss-tree.readthedocs.org
        - Issues: https://github.com/sdss/tree/issues
        
        
        
        
Keywords: astronomy,software
Platform: UNKNOWN
Classifier: Intended Audience :: Science/Research
Classifier: Natural Language :: English
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Classifier: Topic :: Documentation :: Sphinx
Classifier: Topic :: Software Development :: Libraries :: Python Modules
Requires-Python: >=3.6
Description-Content-Type: text/markdown
Provides-Extra: dev
Provides-Extra: docs
