Metadata-Version: 2.1
Name: ioos_metrics
Version: 0.1.0.dev0
Summary: Package to fetch various metrics for IOOS by the numbers
Maintainer: Filipe Fernandes
License: MIT License
        
        Copyright (c) 2021 Mathew Biddle
        
        Permission is hereby granted, free of charge, to any person obtaining a copy
        of this software and associated documentation files (the "Software"), to deal
        in the Software without restriction, including without limitation the rights
        to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
        copies of the Software, and to permit persons to whom the Software is
        furnished to do so, subject to the following conditions:
        
        The above copyright notice and this permission notice shall be included in all
        copies or substantial portions of the Software.
        
        THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
        IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
        FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
        AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
        LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
        OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
        SOFTWARE.
        
Project-URL: documentation, https://ioos.github.io/ioos_metrics
Project-URL: homepage, https://github.com/ioos/ioos_metrics
Project-URL: repository, https://github.com/ioos/ioos_metrics
Classifier: Programming Language :: Python :: 3 :: Only
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Requires-Python: >=3.10
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: bs4
Requires-Dist: ckanapi
Requires-Dist: fake-useragent
Requires-Dist: geopandas>=0.13.2
Requires-Dist: gliderpy
Requires-Dist: html5lib
Requires-Dist: joblib
Requires-Dist: lxml
Requires-Dist: pandas
Requires-Dist: pdfminer.six
Requires-Dist: pyarrow
Requires-Dist: requests

# ioos_by_the_numbers
Working on creating metrics for the [IOOS by the numbers](https://ioos.noaa.gov/about/ioos-by-the-numbers/)

Requirements:


## Website
Leveraged existing resources from https://github.com/noaa-fisheries-integrated-toolbox/toolbox_web_templating.

The webpages are built from the `website/` directory.

| File(s)                               | Description
|---------------------------------------|---------------------------------------------------------------
| `*_config.json`                       | configuration for what resources to present on the webpages.
| `create_asset_inventory_page.py`      | script to create https://ioos.github.io/ioos_metrics/asset_inventory.html
| `create_gts_atn_page.py`              | script to create https://ioos.github.io/ioos_metrics/gts_atn.html
| `create_gts_regional_landing_page.py` | script to create https://ioos.github.io/ioos_metrics/gts_regional.html
| `deploy/index.html`                   | html source for landing page https://ioos.github.io/ioos_metrics/index.html
| `deploy/static/main.css`              | css control for website.

## Development

To create the webpages on your local system
```bash
git clone https://github.com/ioos/ioos_metrics.git
cd ioos_metrics/website
python create_asset_inventory_page.py
python create_gts_atn_landing_page.py
python create_gts_regional_landing_page.py
```

All the webpages will be saved to `website/deploy`. You can view the local html files with a web browser for testing.

## Deployment

The website is generated using GitHub Actions and GitHub Pages. The python scripts, referenced above, are ran and the
directory `website/deploy` is then uploaded as an artifact for GitHub Pages to serve as a website.
This process is automatically ran with every push to the `main` branch. See [here](https://github.com/ioos/ioos_metrics/blob/main/.github/workflows/website_create_and_deploy.yml).
