Skip to content

Commit

Permalink
Update code.json to include both dev and official versions (#165)
Browse files Browse the repository at this point in the history
* update code.json to include both dev and official versions

* switch master to main
  • Loading branch information
ehinman authored Sep 26, 2024
1 parent 35de892 commit baa65e5
Show file tree
Hide file tree
Showing 8 changed files with 59 additions and 16 deletions.
4 changes: 2 additions & 2 deletions .github/workflows/python-package.yml
Original file line number Diff line number Diff line change
Expand Up @@ -5,9 +5,9 @@ name: Python package

on:
push:
branches: ['master']
branches: ['main']
pull_request:
branches: ['master']
branches: ['main']

jobs:
build:
Expand Down
6 changes: 3 additions & 3 deletions .github/workflows/sphinx-docs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -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/[email protected]
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 }}
Expand Down
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down
47 changes: 45 additions & 2 deletions code.json
Original file line number Diff line number Diff line change
Expand Up @@ -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": "[email protected]"
},

"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": [
Expand Down Expand Up @@ -39,7 +82,7 @@
},

"date": {
"metadataLastUpdated": "2022-02-13"
"metadataLastUpdated": "2024-08-30"
}
}
]
6 changes: 3 additions & 3 deletions docs/source/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down Expand Up @@ -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
Expand Down
2 changes: 1 addition & 1 deletion docs/source/examples/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
4 changes: 2 additions & 2 deletions docs/source/meta/installing.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
4 changes: 2 additions & 2 deletions docs/source/meta/license.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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
.. _Disclaimer.md: https://github.com/DOI-USGS/dataretrieval-python/blob/main/DISCLAIMER.md

0 comments on commit baa65e5

Please sign in to comment.