From e22996eb92a6315625d5d7d556e64e61157ac732 Mon Sep 17 00:00:00 2001 From: Lauren Chambers Date: Mon, 4 Feb 2019 17:33:55 -0500 Subject: [PATCH 1/5] Update version numbers --- docs/source/conf.py | 4 ++-- setup.py | 2 +- 2 files changed, 3 insertions(+), 3 deletions(-) diff --git a/docs/source/conf.py b/docs/source/conf.py index 3698cff5a..66f94a990 100644 --- a/docs/source/conf.py +++ b/docs/source/conf.py @@ -63,9 +63,9 @@ # built documents. # # The short X.Y version. -version = '0.16.0' +version = '0.17' # The full version, including alpha/beta/rc tags. -release = '0.16.0' +release = '0.17.0' # The language for content autogenerated by Sphinx. Refer to documentation # for a list of supported languages. diff --git a/setup.py b/setup.py index 7ba734af4..90020aff4 100644 --- a/setup.py +++ b/setup.py @@ -2,7 +2,7 @@ from setuptools import setup from setuptools import find_packages -VERSION = '0.16.0' +VERSION = '0.17.0' AUTHORS = 'Matthew Bourque, Sara Ogaz, Joe Filippazzo, Bryan Hilbert, Misty Cracraft, Graham Kanarek' AUTHORS += 'Johannes Sahlmann, Lauren Chambers, Catherine Martlin' From 78bf4ce499c753eea27747314ef7d333d7e3a0a7 Mon Sep 17 00:00:00 2001 From: Lauren Chambers Date: Mon, 4 Feb 2019 17:35:16 -0500 Subject: [PATCH 2/5] Add (most) changes from 0.17.0 --- CHANGES.rst | 32 ++++++++++++++++++++++++++++++-- 1 file changed, 30 insertions(+), 2 deletions(-) diff --git a/CHANGES.rst b/CHANGES.rst index c6c884a2f..807e8ef94 100644 --- a/CHANGES.rst +++ b/CHANGES.rst @@ -1,5 +1,33 @@ -0.16.0 -====== +0.17.0 (2019-02-05) +=================== + +New Features +------------ + +Project & API Documentation +~~~~~~~~~~~~~~~~~~~~~~~~~~~ +- Added a wiki page for how to do a software release +- Added a wiki page with a checklist for contributors and reviewers +- Added a wiki page about the web server +- Defined specific variable value/type standards for JWST instruments and program/proposal identifiers in the Style Guide + +Web Application +~~~~~~~~~~~~~~~ +- Added authentication to all pages using the ``auth.mast`` service provided by the Archive Services Branch +- Implemented AJAX requests to load the ``thumbnails.html`` and ``archive.html`` pages +- Used regular expressions to restrict URLs +- Updated permissions in ``nginx`` settings to fix bug where dashboard page would not display +- Added a loading widget while thumbnails compile + +``jwql`` Repository +~~~~~~~~~~~~~~~~~~~ +- Added interface with the JWST DMS engineering database: ``utils.engineering_database`` +- Expanded ``utils.filename_parser`` to handle time series and DMS stage 3 file names +- Consolidated important constants in new ``utils.constants`` module + + +0.16.0 (2018-12-17) +=================== This is the first release of the new release procedures of ``jwql``. The development team is now developing in release-driven sprints, so future releases will be less frequent, but with more changes From 29bc28e2678d049f74eadad55d94459a6ffe34ad Mon Sep 17 00:00:00 2001 From: Lauren Chambers Date: Mon, 4 Feb 2019 17:35:35 -0500 Subject: [PATCH 3/5] Update CHANGES.rst to mimic Astropy --- CHANGES.rst | 206 +++++++++++++++++++++++++++------------------------- 1 file changed, 109 insertions(+), 97 deletions(-) diff --git a/CHANGES.rst b/CHANGES.rst index 807e8ef94..5f03ff844 100644 --- a/CHANGES.rst +++ b/CHANGES.rst @@ -33,241 +33,253 @@ This is the first release of the new release procedures of ``jwql``. The develo Changes since the ``0.15.3`` release include: -- Various updates and additions to the ``jwql`` ``conda`` environment: - - Updated ``bokeh`` to version 1.0 - - Updated ``django`` to fix security issues - - Added ``pandas`` as a dependency -- Various updates and additions to the project and API documentation: - - Added a project description in the API docs - - Added web app API docs -- Various changes to the web application: - - Made changes to the code to get it working on the web development server - - Added several REST API services - - Added API documentation button to the navbar and anded link to API documentation in the ``about`` page - - Added instrument-specific documentation button to the instrument landing pages - - Replaced ``monitor_mast`` donut charts with bar charts - - Removed dashboard and database query buttons from homepage - - Added form to homepage that allows user to view preview images for a given rootname or proposal number - - Changed URL patters to allow for separation between nominal web app and REST API service - - Added ``monitor_cron_jobs`` monitor that builds and renders a table displaying ``cron`` job execution status -- Various changes to the ``jwql`` repository: - - Added badges to the ``README`` - - Configured ``pyup`` service for the ``jwql`` repository via ``.pyup.yml`` file - - Added a separate ``requirement.txt`` file to keep track of requirements needed by ReadTheDocs and the ``pyup`` service - - Added various ``jwql`` presentations in separate ``presentations/`` directory -- Other various code changes: - - Changed ``logging_functions.py`` to be more conservative on when to write log files to the production area - - Added ``plotting.py`` module (and supporting unit tests), which stores various plotting-related functions - - -0.15.3 -====== +New Features +------------ + +``jwql`` ``conda`` Environment +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +- Updated ``bokeh`` to version 1.0 +- Updated ``django`` to fix security issues +- Added ``pandas`` as a dependency + +Project & API Documentation +~~~~~~~~~~~~~~~~~~~~~~~~~~~ +- Added a project description in the API docs +- Added web app API docs + +Web Application +~~~~~~~~~~~~~~~ +- Made changes to the code to get it working on the web development server +- Added several REST API services +- Added API documentation button to the navbar and anded link to API documentation in the ``about`` page +- Added instrument-specific documentation button to the instrument landing pages +- Replaced ``monitor_mast`` donut charts with bar charts +- Removed dashboard and database query buttons from homepage +- Added form to homepage that allows user to view preview images for a given rootname or proposal number +- Changed URL patters to allow for separation between nominal web app and REST API service +- Added ``monitor_cron_jobs`` monitor that builds and renders a table displaying ``cron`` job execution status + +``jwql`` Repository +~~~~~~~~~~~~~~~~~~~ +- Added badges to the ``README`` +- Configured ``pyup`` service for the ``jwql`` repository via ``.pyup.yml`` file +- Added a separate ``requirement.txt`` file to keep track of requirements needed by ReadTheDocs and the ``pyup`` service +- Added various ``jwql`` presentations in separate ``presentations/`` directory + +Other Changes +~~~~~~~~~~~~~ +- Changed ``logging_functions.py`` to be more conservative on when to write log files to the production area +- Added ``plotting.py`` module (and supporting unit tests), which stores various plotting-related functions + + +0.15.3 (2018-09-18) +=================== - Added ``.readthedocs.yml``, which configures the ``jwql`` project documentation with ReadtheDocs -0.15.2 -====== +0.15.2 (2018-09-11) +=================== - Reorganized the ``jwql`` repository into a structure that better incorporates instrument-specific monitoring scripts -0.15.1 -====== +0.15.1 (2018-09-10) +=================== - Added ``.pep8speaks.yml``, which configures the ``pep8speaks`` service for the ``jwql`` repository -0.15.0 -====== +0.15.0 (2018-08-29) +=================== - Added ``monitor_template.py``, which serves as a template with examples for instrument-specific monitors that we may write one day -0.14.1 -====== +0.14.1 (2018-08-28) +=================== - Moved all of the ``jwql`` web app code into the ``jwql`` package proper -0.14.0 -====== +0.14.0 (2018-08-27) +=================== - Added a feature to ``generate_preview_images`` and ``preview_image`` that creates mosaicked preview images for NIRCam when applicable -0.13.1 -====== +0.13.1 (2018-08-24) +=================== - Changed the way ``monitor_mast`` and ``monitor_filesystem`` ``bokeh`` plots are saved and displayed in the web application, from using ``html`` to using embedded ``boken`` components - Added some logging to ``monitor_filesystem`` and ``monitor_mast`` -0.13.0 -====== +0.13.0 (2018-08-23) +=================== - Added ``database_interface.py`` and supporting documentation; this module enables the creation and maintenance of database tables in the ``jwqldb`` ``postgresql`` database - Added the ``anomalies`` table in ``database_interface.py`` -0.12.2 -====== +0.12.2 (2018-08-22) +=================== - Fixed some minor formatting issues with the ``sphinx`` docs for ``monitor_filesystem`` and ``monitor_mast`` -0.12.1 -====== +0.12.1 (2018-08-20) +=================== - Added ``ipython`` to the ``jwql`` environment -0.12.0 -====== +0.12.0 (2018-08-16) +=================== - Added a prototype of the ``django`` web application via the ``website/`` directory -0.11.6 -====== +0.11.6 (2018-07-31) +=================== - Added the ``jwql`` code of conduct -0.11.5 -====== +0.11.5 (2018-07-24) +=================== - Changes to ``monitor_filesystem``, namely adding ``sphinx`` docs and adding a plot that shows the total file sizes and counts broken down by instrument -0.11.4 -====== +0.11.4 (2018-07-10) +=================== - Renamed instances of ``dbmonitor`` to ``monitor_mast`` to be more consistent with ``monitor_filesystem`` -0.11.3 -====== +0.11.3 (2018-07-10) +=================== - Removed the ``_static`` file from the ``html_static_paths`` parameters in the ``conf.py`` of the ``sphinx`` docs to avoid unnecessary warnings when trying to build the ``sphinx`` docs -0.11.2 -====== +0.11.2 (2018-06-22) +=================== - Changed the default value for the ``verbose`` option from ``True`` to ``False`` in ``permissions.set_permissions`` -0.11.1 -====== +0.11.1 (2018-06-22) +=================== - Added unit tests for ``preview_images.py`` -0.11.0 -====== +0.11.0 (2018-06-22) +=================== - Added ``logging.logging_functions.py``, which provides a way to log the execution of modules -0.10.4 -====== +0.10.4 (2018-06-22) +=================== - Added an update to the version of ``django`` for use by the web application -0.10.3 -====== +0.10.3 (2018-06-22) +=================== - Fixed the ``Jenkinsfile`` to use ``name`` for ``build_mode`` -0.10.2 -====== +0.10.2 (2018-06-14) +=================== - Changed ``setup.py`` to adhere to ``PEP-8`` standards -0.10.1 -====== +0.10.1 (2018-06-02) +=================== - Added ``sphinx`` API documentation for ``db_monitor.py`` and ``test_db_monitor.py`` -0.10.0 -====== +0.10.0 (2018-05-31) +=================== - Added ``monitor_filesystem.py``, which provides stats files and ``bokeh`` plots that describe the content of the MAST data cache -0.9.0 -===== +0.9.0 (2018-05-31) +================== - Added ``db_monitor.py`` and supporting tests; this module creates ``bokeh`` plots and returns tables to describe the contents of the MAST database -0.8.0 -===== +0.8.0 (2018-05-15) +================== - Added the ``generate_preview_images`` module, which generates preview images and thumbnails for all files in the filesystem -0.7.2 -===== +0.7.2 (2018-05-14) +================== - Added a new ``jupyter`` notebook that identifies keywords that are in the MAST skipped list and also exist in the headers of multiple extensions -0.7.1 -===== +0.7.1 (2018-05-04) +================== - Changed the structure of the API docs, separating the modules into their own ``.rst`` files -0.7.0 -===== +0.7.0 (2018-04-19) +================== - Added a ``filename_parser`` function in a ``utils.py`` module that returns a dictionary of elements contained in a given JWST filename -0.6.0 -===== +0.6.0 (2018-04-17) +================== - Added API documentation build using ``sphinx``; the documentation is located in the ``docs`` directory -0.5.0 -===== +0.5.0 (2018-04-02) +================== - Added ``permissions.py`` and ``test_permissions.py``, which are modules to help manage file and directory permissions -0.4.1 -===== +0.4.1 (2018-03-30) +================== - Changed the ``README`` to describe how to clone the ``jwql`` repository using two-factor authentication/``sftp`` -0.4.0 -===== +0.4.0 (2018-03-28) +================== - Added ``preview_image.py``, a module for generating a preview image for a given JWST observation -0.3.0 -===== +0.3.0 (2018-03-28) +================== - Added package structure to the ``jwql`` repository, making it an installable package -0.2.0 -===== +0.2.0 (2018-02-20) +================== - Added a ``README`` file that describes how to install and contribute to the ``jwql`` repository - Added an ``environment.yml`` file that contains the ``jwqldev`` environment -0.1.0 -===== +0.1.0 (2018-01-31) +================== - Added the ``jwql`` style guide. From d341b3582355f54a87a8d3d80bc0b05dffe7ab13 Mon Sep 17 00:00:00 2001 From: Matthew Bourque Date: Tue, 5 Feb 2019 09:48:06 -0500 Subject: [PATCH 4/5] Minor phrasing changes and moved bug fix to separate "Bug Fixes" section --- CHANGES.rst | 15 +++++++++++---- 1 file changed, 11 insertions(+), 4 deletions(-) diff --git a/CHANGES.rst b/CHANGES.rst index 5f03ff844..a9fefe5f2 100644 --- a/CHANGES.rst +++ b/CHANGES.rst @@ -7,16 +7,15 @@ New Features Project & API Documentation ~~~~~~~~~~~~~~~~~~~~~~~~~~~ - Added a wiki page for how to do a software release -- Added a wiki page with a checklist for contributors and reviewers -- Added a wiki page about the web server +- Added a wiki page with a checklist for contributors and reviewers of pull requests +- Added a wiki page about how the web server is configured - Defined specific variable value/type standards for JWST instruments and program/proposal identifiers in the Style Guide Web Application ~~~~~~~~~~~~~~~ - Added authentication to all pages using the ``auth.mast`` service provided by the Archive Services Branch - Implemented AJAX requests to load the ``thumbnails.html`` and ``archive.html`` pages -- Used regular expressions to restrict URLs -- Updated permissions in ``nginx`` settings to fix bug where dashboard page would not display +- Used regular expressions to restrict URLs to specific patterns - Added a loading widget while thumbnails compile ``jwql`` Repository @@ -25,6 +24,14 @@ Web Application - Expanded ``utils.filename_parser`` to handle time series and DMS stage 3 file names - Consolidated important constants in new ``utils.constants`` module +Bug Fixes +--------- + +Web Application +~~~~~~~~~~~~~~~ + +- Updated permissions in ``nginx`` settings to fix bug where dashboard page would not display + 0.16.0 (2018-12-17) =================== From 2e5bb2b6f622434e9d390313e068c1d4d3574a54 Mon Sep 17 00:00:00 2001 From: Lauren Chambers Date: Tue, 5 Feb 2019 10:02:52 -0500 Subject: [PATCH 5/5] Appeasing pep8speaks --- docs/source/conf.py | 5 ++--- setup.py | 9 +++++---- 2 files changed, 7 insertions(+), 7 deletions(-) diff --git a/docs/source/conf.py b/docs/source/conf.py index 66f94a990..5bb22c349 100644 --- a/docs/source/conf.py +++ b/docs/source/conf.py @@ -90,7 +90,6 @@ todo_include_todos = False - # -- Options for HTML output ---------------------------------------------- # The theme to use for HTML and HTML Help pages. See the documentation for @@ -115,7 +114,7 @@ # # This is required for the alabaster theme # refs: http://alabaster.readthedocs.io/en/latest/installation.html#sidebars -#html_sidebars = {} +# html_sidebars = {} # -- Options for HTMLHelp output ------------------------------------------ @@ -172,4 +171,4 @@ (master_doc, 'jwql', 'jwql Documentation', author, 'jwql', 'One line description of project.', 'Miscellaneous'), -] \ No newline at end of file +] diff --git a/setup.py b/setup.py index 90020aff4..63f6c9cbe 100644 --- a/setup.py +++ b/setup.py @@ -4,10 +4,11 @@ VERSION = '0.17.0' -AUTHORS = 'Matthew Bourque, Sara Ogaz, Joe Filippazzo, Bryan Hilbert, Misty Cracraft, Graham Kanarek' -AUTHORS += 'Johannes Sahlmann, Lauren Chambers, Catherine Martlin' +AUTHORS = 'Matthew Bourque, Sara Ogaz, Joe Filippazzo, Bryan Hilbert, Misty Cracraft, ' +AUTHORS += 'Graham Kanarek, Johannes Sahlmann, Lauren Chambers, Catherine Martlin' -REQUIRES = ['astroquery', 'bokeh==1.0.1', 'django==2.1.2', 'matplotlib', 'numpy', 'python-dateutil', 'sphinx', 'sphinx-automodapi', 'sqlalchemy'] +REQUIRES = ['astroquery', 'bokeh==1.0.1', 'django==2.1.2', 'matplotlib', 'numpy', + 'python-dateutil', 'sphinx', 'sphinx-automodapi', 'sqlalchemy'] setup( name='jwql', @@ -23,4 +24,4 @@ install_requires=REQUIRES, include_package_data=True, include_dirs=[np.get_include()], - ) \ No newline at end of file +)