diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml index fab0e074..ea2200b8 100644 --- a/.pre-commit-config.yaml +++ b/.pre-commit-config.yaml @@ -10,7 +10,7 @@ repos: - id: double-quote-string-fixer - repo: https://github.com/ambv/black - rev: 21.6b0 + rev: 21.9b0 hooks: - id: black @@ -29,7 +29,7 @@ repos: hooks: - id: seed-isort-config - repo: https://github.com/pre-commit/mirrors-isort - rev: v5.8.0 + rev: v5.9.3 hooks: - id: isort @@ -39,7 +39,7 @@ repos: # - id: prettier - repo: https://github.com/nbQA-dev/nbQA - rev: 0.13.0 + rev: 1.1.1 hooks: - id: nbqa-black additional_dependencies: [black==20.8b1] diff --git a/portal/_extensions/truncatehtml.py b/portal/_extensions/truncatehtml.py new file mode 100644 index 00000000..e9f4e06f --- /dev/null +++ b/portal/_extensions/truncatehtml.py @@ -0,0 +1,179 @@ +#!/usr/bin/env python + +# Copyright (c) 2015 Eric Entzel + +# 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. + +from __future__ import print_function + +END = -1 + +# HTML5 void-elements that do not require a closing tag +# https://html.spec.whatwg.org/multipage/syntax.html#void-elements +VOID_ELEMENTS = ( + 'area', + 'base', + 'br', + 'col', + 'embed', + 'hr', + 'img', + 'input', + 'link', + 'meta', + 'param', + 'source', + 'track', + 'wbr', +) + + +class UnbalancedError(Exception): + pass + + +class OpenTag: + def __init__(self, tag, rest=''): + self.tag = tag + self.rest = rest + + def as_string(self): + return '<' + self.tag + self.rest + '>' + + +class CloseTag(OpenTag): + def as_string(self): + return '' + + +class SelfClosingTag(OpenTag): + pass + + +class Tokenizer: + def __init__(self, input): + self.input = input + self.counter = 0 # points at the next unconsumed character of the input + + def __next_char(self): + self.counter += 1 + return self.input[self.counter] + + def next_token(self): + try: + char = self.input[self.counter] + self.counter += 1 + if char == '&': + return self.__entity() + elif char != '<': + return char + elif self.input[self.counter] == '/': + self.counter += 1 + return self.__close_tag() + else: + return self.__open_tag() + except IndexError: + return END + + def __entity(self): + """Return a token representing an HTML character entity. + Precondition: self.counter points at the charcter after the & + Postcondition: self.counter points at the character after the ; + """ + char = self.input[self.counter] + entity = ['&'] + while char != ';': + entity.append(char) + char = self.__next_char() + entity.append(';') + self.counter += 1 + return ''.join(entity) + + def __open_tag(self): + """Return an open/close tag token. + Precondition: self.counter points at the first character of the tag name + Postcondition: self.counter points at the character after the + """ + char = self.input[self.counter] + tag = [] + rest = [] + while char != '>' and char != ' ': + tag.append(char) + char = self.__next_char() + while char != '>': + rest.append(char) + char = self.__next_char() + if self.input[self.counter - 1] == '/': + self.counter += 1 + return SelfClosingTag(''.join(tag), ''.join(rest)) + elif ''.join(tag) in VOID_ELEMENTS: + self.counter += 1 + return SelfClosingTag(''.join(tag), ''.join(rest)) + else: + self.counter += 1 + return OpenTag(''.join(tag), ''.join(rest)) + + def __close_tag(self): + """Return an open/close tag token. + Precondition: self.counter points at the first character of the tag name + Postcondition: self.counter points at the character after the + """ + char = self.input[self.counter] + tag = [] + while char != '>': + tag.append(char) + char = self.__next_char() + self.counter += 1 + return CloseTag(''.join(tag)) + + +def truncate(str, target_len, ellipsis=''): + """Returns a copy of str truncated to target_len characters, + preserving HTML markup (which does not count towards the length). + Any tags that would be left open by truncation will be closed at + the end of the returned string. Optionally append ellipsis if + the string was truncated.""" + stack = [] # open tags are pushed on here, then popped when the matching close tag is found + retval = [] # string to be returned + length = 0 # number of characters (not counting markup) placed in retval so far + tokens = Tokenizer(str) + tok = tokens.next_token() + while tok != END: + if length >= target_len and tok == ' ': + retval.append(ellipsis) + break + if tok.__class__.__name__ == 'OpenTag': + stack.append(tok) + retval.append(tok.as_string()) + elif tok.__class__.__name__ == 'CloseTag': + if stack[-1].tag == tok.tag: + stack.pop() + retval.append(tok.as_string()) + else: + raise UnbalancedError(tok.as_string()) + elif tok.__class__.__name__ == 'SelfClosingTag': + retval.append(tok.as_string()) + else: + retval.append(tok) + length += 1 + tok = tokens.next_token() + while len(stack) > 0: + tok = CloseTag(stack.pop().tag) + retval.append(tok.as_string()) + return ''.join(retval) diff --git a/portal/_extensions/yaml_gallery_generator.py b/portal/_extensions/yaml_gallery_generator.py index 3aab6ac8..a4b7b4e8 100644 --- a/portal/_extensions/yaml_gallery_generator.py +++ b/portal/_extensions/yaml_gallery_generator.py @@ -3,6 +3,7 @@ from textwrap import dedent import yaml +from truncatehtml import truncate def _tag_in_item(item, tag_str=None): @@ -117,7 +118,9 @@ def build_from_items(items, filename, title='Gallery', subtitle=None, menu_html= short_description = item['description'] modal_str = '' else: - short_description = item['description'][:max_descr_len] + ' ...more' + short_description = truncate( + item['description'], max_descr_len, ellipsis=' ...more' + ) modal_str = f"""
diff --git a/portal/_static/thumbnails/ptss-builtinpackage.jpeg b/portal/_static/thumbnails/ptss-builtinpackage.jpeg new file mode 100644 index 00000000..c79bf3a7 Binary files /dev/null and b/portal/_static/thumbnails/ptss-builtinpackage.jpeg differ diff --git a/portal/_static/thumbnails/ptss-cartopy.jpeg b/portal/_static/thumbnails/ptss-cartopy.jpeg new file mode 100644 index 00000000..9ac30119 Binary files /dev/null and b/portal/_static/thumbnails/ptss-cartopy.jpeg differ diff --git a/portal/_static/thumbnails/ptss-dask1.jpeg b/portal/_static/thumbnails/ptss-dask1.jpeg new file mode 100644 index 00000000..d22bdd4c Binary files /dev/null and b/portal/_static/thumbnails/ptss-dask1.jpeg differ diff --git a/portal/_static/thumbnails/ptss-dask2.jpeg b/portal/_static/thumbnails/ptss-dask2.jpeg new file mode 100644 index 00000000..bb7805dd Binary files /dev/null and b/portal/_static/thumbnails/ptss-dask2.jpeg differ diff --git a/portal/_static/thumbnails/ptss-datadict.jpeg b/portal/_static/thumbnails/ptss-datadict.jpeg new file mode 100644 index 00000000..cbbd4da8 Binary files /dev/null and b/portal/_static/thumbnails/ptss-datadict.jpeg differ diff --git a/portal/_static/thumbnails/ptss-firstpackage.jpeg b/portal/_static/thumbnails/ptss-firstpackage.jpeg new file mode 100644 index 00000000..ff3b8d1f Binary files /dev/null and b/portal/_static/thumbnails/ptss-firstpackage.jpeg differ diff --git a/portal/_static/thumbnails/ptss-geocatcomp.jpeg b/portal/_static/thumbnails/ptss-geocatcomp.jpeg new file mode 100644 index 00000000..70848a04 Binary files /dev/null and b/portal/_static/thumbnails/ptss-geocatcomp.jpeg differ diff --git a/portal/_static/thumbnails/ptss-geocatplot.jpeg b/portal/_static/thumbnails/ptss-geocatplot.jpeg new file mode 100644 index 00000000..632b9581 Binary files /dev/null and b/portal/_static/thumbnails/ptss-geocatplot.jpeg differ diff --git a/portal/_static/thumbnails/ptss-git.png b/portal/_static/thumbnails/ptss-git.png new file mode 100644 index 00000000..70f8dad0 Binary files /dev/null and b/portal/_static/thumbnails/ptss-git.png differ diff --git a/portal/_static/thumbnails/ptss-jupyter.jpeg b/portal/_static/thumbnails/ptss-jupyter.jpeg new file mode 100644 index 00000000..4232e3ad Binary files /dev/null and b/portal/_static/thumbnails/ptss-jupyter.jpeg differ diff --git a/portal/_static/thumbnails/ptss-matplotlib.jpeg b/portal/_static/thumbnails/ptss-matplotlib.jpeg new file mode 100644 index 00000000..010d3d6d Binary files /dev/null and b/portal/_static/thumbnails/ptss-matplotlib.jpeg differ diff --git a/portal/_static/thumbnails/ptss-numpy.jpeg b/portal/_static/thumbnails/ptss-numpy.jpeg new file mode 100644 index 00000000..7df8748b Binary files /dev/null and b/portal/_static/thumbnails/ptss-numpy.jpeg differ diff --git a/portal/_static/thumbnails/ptss-oop.jpeg b/portal/_static/thumbnails/ptss-oop.jpeg new file mode 100644 index 00000000..f4c847b1 Binary files /dev/null and b/portal/_static/thumbnails/ptss-oop.jpeg differ diff --git a/portal/_static/thumbnails/ptss-pandas.jpeg b/portal/_static/thumbnails/ptss-pandas.jpeg new file mode 100644 index 00000000..e6ed06f9 Binary files /dev/null and b/portal/_static/thumbnails/ptss-pandas.jpeg differ diff --git a/portal/_static/thumbnails/ptss-txtfile.jpeg b/portal/_static/thumbnails/ptss-txtfile.jpeg new file mode 100644 index 00000000..1e9585ac Binary files /dev/null and b/portal/_static/thumbnails/ptss-txtfile.jpeg differ diff --git a/portal/_static/thumbnails/ptss-writingfx.jpeg b/portal/_static/thumbnails/ptss-writingfx.jpeg new file mode 100644 index 00000000..73922e0d Binary files /dev/null and b/portal/_static/thumbnails/ptss-writingfx.jpeg differ diff --git a/portal/_static/thumbnails/ptss-xarray1.jpeg b/portal/_static/thumbnails/ptss-xarray1.jpeg new file mode 100644 index 00000000..b0146c37 Binary files /dev/null and b/portal/_static/thumbnails/ptss-xarray1.jpeg differ diff --git a/portal/_static/thumbnails/ptss-xarray2.jpeg b/portal/_static/thumbnails/ptss-xarray2.jpeg new file mode 100644 index 00000000..1b832bcf Binary files /dev/null and b/portal/_static/thumbnails/ptss-xarray2.jpeg differ diff --git a/portal/gallery.yaml b/portal/gallery.yaml index f202373c..7703e0f3 100644 --- a/portal/gallery.yaml +++ b/portal/gallery.yaml @@ -213,6 +213,8 @@ - cartopy formats: - gallery + domains: + - data visualization - title: Contextily Documentation url: https://contextily.readthedocs.io @@ -299,6 +301,8 @@ - geocat-viz formats: - gallery + domains: + - data visualization - title: GeoPandas Documentation url: https://geopandas.org @@ -353,6 +357,8 @@ - hvPlot formats: - tutorial + domains: + - data visualization - title: hvPlot Gallery url: https://hvplot.holoviz.org/reference/index.html @@ -367,6 +373,8 @@ - hvPlot formats: - gallery + domains: + - data visualization - title: Ipyleaflet url: https://ipyleaflet.readthedocs.io @@ -393,6 +401,8 @@ - matplotlib formats: - documentation + domains: + - data visualization - title: Matplotlib Tutorial url: https://matplotlib.org/stable/tutorials/index.html @@ -406,6 +416,8 @@ - matplotlib formats: - tutorial + domains: + - data visualization - title: Matplotlib Gallery url: https://matplotlib.org/stable/gallery/index.html @@ -419,6 +431,8 @@ - matplotlib formats: - gallery + domains: + - data visualization - title: MetPy url: https://unidata.github.io/MetPy/latest/index.html @@ -849,3 +863,299 @@ - climate science - physical oceanography - data science + +- title: Your First Python Tutorial - Reading in a .txt File + url: https://youtu.be/Jog7ybd6amw + description: | + Recording from the Python Tutorial Seminar Series designed to teach you Python, not package specific syntax. This lessons covers setting up a work environment and opening a .txt file. The content to follow along with this video is hosted on the Xdev Python Tutorial website. + authors: + - name: Project Pythia + - name: Julia Kent + affiliation: NCAR + affiliation_url: https://ncar.ucar.edu/ + thumbnail: /_static/thumbnails/ptss-txtfile.jpeg + tags: + packages: + - pure python + formats: + - video + +- title: Your First Python Tutorial - Creating a Data Dictionary + url: https://youtu.be/5z6-t62x7Xs + description: | + Recording from the Python Tutorial Seminar Series designed to teach you Python, not package specific syntax. This lessons covers creating a data dictionary. The content to follow along with this video is hosted on the Xdev Python Tutorial website. + authors: + - name: Project Pythia + - name: Julia Kent + affiliation: NCAR + affiliation_url: https://ncar.ucar.edu/ + thumbnail: /_static/thumbnails/ptss-datadict.jpeg + tags: + packages: + - pure python + formats: + - video + +- title: Your First Python Tutorial - Writing Functions + url: https://youtu.be/BerEf_3CsL8 + description: | + Recording from the Python Tutorial Seminar Series designed to teach you Python, not package specific syntax. This lessons covers how to write and call functions in Python. The content to follow along with this video is hosted on the Xdev Python Tutorial website. + authors: + - name: Project Pythia + - name: Julia Kent + affiliation: NCAR + affiliation_url: https://ncar.ucar.edu/ + thumbnail: /_static/thumbnails/ptss-writingfx.jpeg + tags: + packages: + - pure python + formats: + - video + +- title: Your First Python Tutorial - Creating Your Own Package + url: https://youtu.be/6lbbTwGFcTc + description: | + Recording from the Python Tutorial Seminar Series designed to teach you Python, not package specific syntax. This lessons covers how to create and call modules and packages. The content to follow along with this video is hosted on the Xdev Python Tutorial website. + authors: + - name: Project Pythia + - name: Julia Kent + affiliation: NCAR + affiliation_url: https://ncar.ucar.edu/ + thumbnail: /_static/thumbnails/ptss-firstpackage.jpeg + tags: + packages: + - pure python + formats: + - video + +- title: Your First Python Tutorial - Using a Built-In Package and Publishing Your Package + url: https://youtu.be/44QUMCh2ZHU + description: | + Recording from the Python Tutorial Seminar Series designed to teach you Python, not package specific syntax. This lessons covers how to use your first external buil-in package, `math`, and how to publish your package. The content to follow along with this video is hosted on the Xdev Python Tutorial website. + authors: + - name: Project Pythia + - name: Julia Kent + affiliation: NCAR + affiliation_url: https://ncar.ucar.edu/ + thumbnail: /_static/thumbnails/ptss-builtinpackage.jpeg + tags: + packages: + - pure python + formats: + - video + +- title: Python Tutorial Seminar Series - Jupyter Notebooks + url: https://youtu.be/xSzXvwzFsDU + description: | + Recording from the Python Tutorial Seminar Series introducing JupyterLab and Jupyter Notebooks. + authors: + - name: Project Pythia + - name: Kevin Paul + affiliation: NCAR + affiliation_url: https://ncar.ucar.edu/ + thumbnail: /_static/thumbnails/ptss-jupyter.jpeg + tags: + packages: + - jupyter + formats: + - video + +- title: Python Tutorial Seminar Series - Numpy + url: https://youtu.be/kstc-6uz7AQ + description: | + Recording from the Python Tutorial Seminar Series introducing the Python Package `numpy`. The content to follow along with this video is hosted on this Numpy Google Collab. + authors: + - name: Project Pythia + - name: A Kootz + affiliation: NCAR + affiliation_url: https://ncar.ucar.edu/ + thumbnail: /_static/thumbnails/ptss-numpy.jpeg + tags: + packages: + - numpy + formats: + - video + +- title: Python Tutorial Seminar Series - Matplotlib + url: https://youtu.be/EiPRIdHQEmE + description: | + Recording from the Python Tutorial Seminar Series introducing the Python Package `matplotlib`. The content to follow along with this video is hosted on this Matplotlib Tutorial GitHub Repository. + authors: + - name: Project Pythia + - name: Anissa Zacharias + affiliation: NCAR + affiliation_url: https://ncar.ucar.edu/ + thumbnail: /_static/thumbnails/ptss-matplotlib.jpeg + tags: + packages: + - matplotlib + formats: + - video + domains: + - data visualization + +- title: Python Tutorial Seminar Series - Object Oriented Programming + url: https://youtu.be/GEFnL8C62u8 + description: | + Recording from the Python Tutorial Seminar Series introducing Object Oriented Programming. The content to follow along with this video is hosted in this Object Oriented Programming Tutorial GitHub Repository. + authors: + - name: Project Pythia + - name: A Kootz + affiliation: NCAR + affiliation_url: https://ncar.ucar.edu/ + thumbnail: /_static/thumbnails/ptss-oop.jpeg + tags: + formats: + - video + +- title: Python Tutorial Seminar Series - Cartopy + url: https://youtu.be/ivmd3RluMiw + description: | + Recording from the Python Tutorial Seminar Series introducing the Python Package `cartopy`. The content to follow along with this video is hosted in this Cartopy Tutorial GitHub Repository. + authors: + - name: Project Pythia + - name: Michaela Sizemore + affiliation: NCAR + affiliation_url: https://ncar.ucar.edu/ + thumbnail: /_static/thumbnails/ptss-cartopy.jpeg + tags: + packages: + - matplotlib + - cartopy + formats: + - video + domains: + - data visualization + +- title: Python Tutorial Seminar Series - Git and GitHub + url: https://youtu.be/fYkPn0Nttlg + description: | + Recording from the Python Tutorial Seminar Series introducing the tools Git and GitHub. The content to follow along with this tutorial is hosted in this Git and GitHub Demo GitHub Repository. + authors: + - name: Project Pythia + - name: Kevin Paul + affiliation: NCAR + affiliation_url: https://ncar.ucar.edu/ + thumbnail: /_static/thumbnails/ptss-git.png + tags: + packages: + - git + formats: + - video + +- title: Python Tutorial Seminar Series - Pandas + url: https://youtu.be/BsV3ek7qsiM + description: | + Recording from the Python Tutorial Seminar Series introducing the Python Package `pandas`. The content to follow along with this video is hosted in this Pandas Tutorial GitHub Repository. + authors: + - name: Project Pythia + - name: Max Grover + affiliation: NCAR + affiliation_url: https://ncar.ucar.edu/ + - name: Drew Camron + affiliation: NCAR + affiliation_url: https://ncar.ucar.edu/ + thumbnail: /_static/thumbnails/ptss-pandas.jpeg + tags: + packages: + - pandas + formats: + - video + +- title: Python Tutorial Seminar Series - Xarray Part 1 + url: https://youtu.be/Ss4ryKukhi4 + description: | + Recording from the Python Tutorial Seminar Series introducing the Python Package `xarray`. This is the first lesson of a two part series. The content to follow along with this video is hosted in this Xarray Tutorial GitHub Repository. + authors: + - name: Project Pythia + - name: Anderson Banihirwe + affiliation: NCAR + affiliation_url: https://ncar.ucar.edu/ + thumbnail: /_static/thumbnails/ptss-xarray1.jpeg + tags: + packages: + - xarray + formats: + - video + +- title: Python Tutorial Seminar Series - Xarray Part 2 + url: https://youtu.be/2H_4drBwORY + description: | + Recording from the Python Tutorial Seminar Series introducing the Python Package `xarray`. This is the second lesson of a two part series. The content to follow along with this video is hosted in this Xarray Tutorial GitHub Repository. + authors: + - name: Project Pythia + - name: Anderson Banihirwe + affiliation: NCAR + affiliation_url: https://ncar.ucar.edu/ + thumbnail: /_static/thumbnails/ptss-xarray2.jpeg + tags: + packages: + - xarray + formats: + - video + +- title: Python Tutorial Seminar Series - Dask Part 1 + url: https://youtu.be/wn-QM6QUB_U + description: | + Recording from the Python Tutorial Seminar Series introducing the Python Package `dask`. This is the first lesson of a two part series. The content to follow along with this video is hosted in this Xarray Tutorial GitHub Repository. + authors: + - name: Project Pythia + - name: Anderson Banihirwe + affiliation: NCAR + affiliation_url: https://ncar.ucar.edu/ + thumbnail: /_static/thumbnails/ptss-dask1.jpeg + tags: + packages: + - dask + formats: + - video + +- title: Python Tutorial Seminar Series - Dask Part 2 + url: https://youtu.be/yn4_-1pHC5k + description: | + Recording from the Python Tutorial Seminar Series introducing the Python Package `dask`. This is the second lesson of a two part series. The content to follow along with this video is hosted in this Xarray Tutorial GitHub Repository. + authors: + - name: Project Pythia + - name: Anderson Banihirwe + affiliation: NCAR + affiliation_url: https://ncar.ucar.edu/ + thumbnail: /_static/thumbnails/ptss-dask2.jpeg + tags: + packages: + - dask + formats: + - video + +- title: Python Tutorial Seminar Series - Plotting with GeoCAT + url: https://youtu.be/It231le1fAU + description: | + Recording from the Python Tutorial Seminar Series introducing advanced plotting techniques and highlighting tools developed by GeoCAT. The content to follow along with this video is hosted in this Plotting with GeoCat GitHub Repository. + authors: + - name: Project Pythia + - name: Anissa Zacharias + affiliation: NCAR + affiliation_url: https://ncar.ucar.edu/ + thumbnail: /_static/thumbnails/ptss-geocatplot.jpeg + tags: + packages: + - geocat-viz + formats: + - video + domains: + - data visualization + +- title: Python Tutorial Seminar Series - GeoCAT-Comp + url: https://www.youtube.com/watch?v=uiWDQKI8YTQ&t=6s + description: | + Recording from the Python Tutorial Seminar Series introducing `geocat-comp`. The content to follow along with this video is hosted in this GeoCat-Comp GitHub Repository. + authors: + - name: Project Pythia + - name: A Kootz + affiliation: NCAR + affiliation_url: https://ncar.ucar.edu/ + thumbnail: /_static/thumbnails/ptss-geocatcomp.jpeg + tags: + packages: + - geocat-comp + formats: + - video diff --git a/setup.cfg b/setup.cfg index b9622c7d..693fc40e 100644 --- a/setup.cfg +++ b/setup.cfg @@ -7,7 +7,7 @@ select = B,C,E,F,W,T4,B9 [isort] known_first_party= -known_third_party=bs4,frontmatter,markdown_it,pydantic,sphinx,yaml +known_third_party=bs4,frontmatter,markdown_it,pydantic,sphinx,truncatehtml,yaml multi_line_output=3 include_trailing_comma=True force_grid_wrap=0