From baa65e544083fe99e98347298f5c23842071b9db Mon Sep 17 00:00:00 2001 From: Elise Hinman <121896266+ehinman@users.noreply.github.com> Date: Wed, 25 Sep 2024 22:33:20 -0500 Subject: [PATCH] Update code.json to include both dev and official versions (#165) * update code.json to include both dev and official versions * switch master to main --- .github/workflows/python-package.yml | 4 +-- .github/workflows/sphinx-docs.yml | 6 ++-- README.md | 2 +- code.json | 47 ++++++++++++++++++++++++++-- docs/source/conf.py | 6 ++-- docs/source/examples/index.rst | 2 +- docs/source/meta/installing.rst | 4 +-- docs/source/meta/license.rst | 4 +-- 8 files changed, 59 insertions(+), 16 deletions(-) diff --git a/.github/workflows/python-package.yml b/.github/workflows/python-package.yml index a50e5fcb..06d6d2d3 100644 --- a/.github/workflows/python-package.yml +++ b/.github/workflows/python-package.yml @@ -5,9 +5,9 @@ name: Python package on: push: - branches: ['master'] + branches: ['main'] pull_request: - branches: ['master'] + branches: ['main'] jobs: build: diff --git a/.github/workflows/sphinx-docs.yml b/.github/workflows/sphinx-docs.yml index ebf2cc72..fdc10f5c 100644 --- a/.github/workflows/sphinx-docs.yml +++ b/.github/workflows/sphinx-docs.yml @@ -28,11 +28,11 @@ jobs: echo $REF echo $EVENT_NAME echo ${{ github.event_name == 'push' }} - echo ${{ github.ref == 'refs/heads/master' }} - echo ${{ github.event_name == 'push' && github.ref == 'refs/heads/master' }} + echo ${{ github.ref == 'refs/heads/main' }} + echo ${{ github.event_name == 'push' && github.ref == 'refs/heads/main' }} - name: Deploy to GitHub Pages uses: JamesIves/github-pages-deploy-action@v4.4.1 - if: ${{ github.event_name == 'push' && github.ref == 'refs/heads/master' }} + if: ${{ github.event_name == 'push' && github.ref == 'refs/heads/main' }} with: GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} EVENT_NAME: ${{ github.event_name }} diff --git a/README.md b/README.md index 85dd67be..6a4cf4fd 100644 --- a/README.md +++ b/README.md @@ -79,7 +79,7 @@ or conda: $ conda install -c conda-forge dataretrieval -More examples of use are include in [`demos`](https://github.com/USGS-python/dataretrieval/tree/master/demos). +More examples of use are include in [`demos`](https://github.com/USGS-python/dataretrieval/tree/main/demos). ## Issue tracker diff --git a/code.json b/code.json index 9625f91e..cff66de8 100644 --- a/code.json +++ b/code.json @@ -3,9 +3,52 @@ "name": "dataretrieval", "organization": "U.S. Geological Survey", "description": "A Python package for discovering and retrieving water data from U.S. federal hydrologic web services.", - "version": "v1.0.2", + "version": "main", "status": "Development", + "permissions": { + "usageType": "openSource", + "licenses": [ + { + "name": "Public Domain, CC0-1.0", + "URL": "https://code.usgs.gov/water/dataretrieval-python/-/raw/main/LICENSE.md" + } + ] + }, + + "homepageURL": "https://code.usgs.gov/water/dataretrieval-python", + "downloadURL": "https://code.usgs.gov/water/dataretrieval-python/-/archive/main/dataretrieval-python-main.zip", + "disclaimerURL": "https://code.usgs.gov/water/dataretrieval-python/-/raw/main/DISCLAIMER.md", + "repositoryURL": "https://code.usgs.gov/water/dataretrieval-python.git", + "vcs": "git", + + "laborHours": 0, + + "tags": [ + "Python", + "USGS" + ], + + "languages": [ + "Python" + ], + + "contact": { + "name": "Timothy 0. Hodson", + "email": "thodson@usgs.gov" + }, + + "date": { + "metadataLastUpdated": "2024-09-17" + } + }, + { + "name": "dataretrieval", + "organization": "U.S. Geological Survey", + "description": "A Python package for discovering and retrieving water data from U.S. federal hydrologic web services.", + "version": "v1.0.2", + "status": "Production", + "permissions": { "usageType": "openSource", "licenses": [ @@ -39,7 +82,7 @@ }, "date": { - "metadataLastUpdated": "2022-02-13" + "metadataLastUpdated": "2024-08-30" } } ] diff --git a/docs/source/conf.py b/docs/source/conf.py index 30bf69bc..40bab739 100644 --- a/docs/source/conf.py +++ b/docs/source/conf.py @@ -39,8 +39,8 @@ # suffix of source documents source_suffix = '.rst' -# The master toctree document. -master_doc = 'index' +# The main toctree document. +main_doc = 'index' # The version info for the project you're documenting, acts as replacement for # |version| and |release|, also used in various other places throughout the @@ -122,7 +122,7 @@ r'https://streamstats.usgs.gov/streamstatsservices/#/', r'https://www.waterqualitydata.us/public_srsnames/', r'https://waterqualitydata.us', - r'https://github.com/USGS-python/dataretrieval/tree/master/demos/hydroshare', + r'https://github.com/USGS-python/dataretrieval/tree/main/demos/hydroshare', ] # Some notebooks have warnings, which nbsphinx should ignore diff --git a/docs/source/examples/index.rst b/docs/source/examples/index.rst index 3472001d..044360fa 100644 --- a/docs/source/examples/index.rst +++ b/docs/source/examples/index.rst @@ -25,7 +25,7 @@ project repository. .. _Hydroshare: https://www.hydroshare.org/resource/c97c32ecf59b4dff90ef013030c54264/ -.. _demos/hydroshare: https://github.com/DOI-USGS/dataretrieval-python/tree/master/demos/hydroshare +.. _demos/hydroshare: https://github.com/DOI-USGS/dataretrieval-python/tree/main/demos/hydroshare .. toctree:: :maxdepth: 1 diff --git a/docs/source/meta/installing.rst b/docs/source/meta/installing.rst index 8a205a67..34caf181 100644 --- a/docs/source/meta/installing.rst +++ b/docs/source/meta/installing.rst @@ -7,9 +7,9 @@ or ``conda``. Package dependencies are listed in the `requirements.txt`_ file, a full list of dependencies necessary for development are listed in the `requirements-dev.txt`_ file. -.. _requirements.txt: https://github.com/DOI-USGS/dataretrieval-python/blob/master/requirements.txt +.. _requirements.txt: https://github.com/DOI-USGS/dataretrieval-python/blob/main/requirements.txt -.. _requirements-dev.txt: https://github.com/DOI-USGS/dataretrieval-python/blob/master/requirements-dev.txt +.. _requirements-dev.txt: https://github.com/DOI-USGS/dataretrieval-python/blob/main/requirements-dev.txt User Installation diff --git a/docs/source/meta/license.rst b/docs/source/meta/license.rst index 975461be..f42ffe00 100644 --- a/docs/source/meta/license.rst +++ b/docs/source/meta/license.rst @@ -7,6 +7,6 @@ States Geological Survey, an agency of the United States Department of Interior. For more information, see the `LICENSE.md`_ file. See the `Disclaimer.md`_ file for more information about the disclaimer. -.. _LICENSE.md: https://github.com/DOI-USGS/dataretrieval-python/blob/master/LICENSE.md +.. _LICENSE.md: https://github.com/DOI-USGS/dataretrieval-python/blob/main/LICENSE.md -.. _Disclaimer.md: https://github.com/DOI-USGS/dataretrieval-python/blob/master/DISCLAIMER.md \ No newline at end of file +.. _Disclaimer.md: https://github.com/DOI-USGS/dataretrieval-python/blob/main/DISCLAIMER.md \ No newline at end of file