From 41be74767227aecd114c079dba2e842dde2403c9 Mon Sep 17 00:00:00 2001 From: "Angeline G. Burrell" Date: Wed, 13 Sep 2023 16:17:47 -0400 Subject: [PATCH 1/9] DOC: updated code of conduct Fixed wording in code of conduct so that the phrasing makes more sense. --- CODE_OF_CONDUCT.md | 13 ++++++------- 1 file changed, 6 insertions(+), 7 deletions(-) diff --git a/CODE_OF_CONDUCT.md b/CODE_OF_CONDUCT.md index 3271638..09b61af 100644 --- a/CODE_OF_CONDUCT.md +++ b/CODE_OF_CONDUCT.md @@ -55,13 +55,12 @@ project may be further defined and clarified by project maintainers. ## Enforcement Instances of abusive, harassing, or otherwise unacceptable behavior may be -reported by contacting the project team at pysat.developers@gmail.com -(PACKAGENAME SPECIFIC EMAIL MAY BE USED HERE). The -project team will review and investigate all complaints, and will respond in a -way that it deems appropriate to the circumstances. The project team is -obligated to maintain confidentiality with regard to the reporter of an -incident. Further details of specific enforcement policies may be posted -separately. +reported by contacting the project team at pysat.developers@gmail.com. The +(PACKAGENAME SPECIFIC EMAIL MAY BE USED HERE) project team will review and +investigate all complaints, and will respond in a way that it deems appropriate +to the circumstances. The project team is obligated to maintain confidentiality +with regard to the reporter of an incident. Further details of specific +enforcement policies may be posted separately. Project maintainers who do not follow or enforce the Code of Conduct in good faith may face temporary or permanent repercussions as determined by other From 5edfcb90fe2815dd7bb8e74536f3c52e26ba30ee Mon Sep 17 00:00:00 2001 From: "Angeline G. Burrell" Date: Wed, 13 Sep 2023 16:32:57 -0400 Subject: [PATCH 2/9] DOC: update contrubuting Updated the contributing guidelines to include a more detailed Issues section. --- CONTRIBUTING.md | 43 +++++++++++++++++++++++++++++-------------- 1 file changed, 29 insertions(+), 14 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index caaa0f5..cf64e13 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -2,8 +2,8 @@ Contributing ============ Bug reports, feature suggestions, and other contributions are greatly -appreciated! pysat is a community-driven project and welcomes both feedback and -contributions. +appreciated! pysat and (PROJECT NAME) are community-driven projects that +welcome both feedback and contributions. Come join us on Slack! An invitation to the pysat workspace is available in the 'About' section of the @@ -13,13 +13,27 @@ are generally held fortnightly. Short version ------------- -* Submit bug reports and feature requests at +* Submit bug reports, feature requests, and questions at [GitHub](https://github.com/pysat/PACKAGENAME/issues) * Make pull requests to the ``develop`` branch +Issues +------ + +Bug reports, questions, and feature requests should all be made as GitHub +Issues. Templates are provided for each type of issue, to help you include +all the necessary information. + +Questions +^^^^^^^^^ + +Not sure how something works? Ask away! The more information you provide, the +easier the question will be to answer. You can also interact with the pysat +developers on our [slack channel](https://pysat.slack.com). + Bug reports ------------ +^^^^^^^^^^^ When [reporting a bug](https://github.com/pysat/PACKAGENAME/issues) please include: @@ -31,12 +45,12 @@ include: * Detailed steps to reproduce the bug Feature requests and feedback ------------------------------ +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ The best way to send feedback is to file an issue at [GitHub](https://github.com/pysat/PACKAGENAME/issues). -If you are proposing a feature: +If you are proposing a new feature or a change in something that already exists: * Explain in detail how it would work. @@ -94,8 +108,8 @@ To set up `PACKAGENAME` for local development: Note that pysat uses the `flake-docstrings` and `hacking` packages to ensure standards in docstring formatting. - -6. Update/add documentation (in ``docs``), if relevant +6. Update/add documentation (in ``docs``). Even if you don't think it's + relevant, check to see if any existing examples have changed. 7. Add your name to the .zenodo.json file as an author @@ -133,11 +147,11 @@ For merging, you should: 4. Ensure that all checks passed (current checks include Github Actions and Coveralls) -If you don't have all the necessary Python versions available locally or -have trouble building all the testing environments, you can rely on -GitHub Actions to run the tests for each change you add in the pull -request. Because testing here will delay tests by other developers, -please ensure that the code passes all tests on your local system first. +If you don't have all the necessary Python versions available locally or have +trouble building all the testing environments, you can rely on GitHub Actions to +run the tests for each change you add in the pull request. Because testing here +will delay tests by other developers, please ensure that the code passes all +tests on your local system first. Project Style Guidelines @@ -167,7 +181,8 @@ These include: * All classes should have `__repr__` and `__str__` functions * Docstrings use `Note` instead of `Notes` * Try to avoid creating a try/except statement where except passes -* Use setup_method (or setup_class) and teardown_method (or teardown_class) in test classes +* Use setup_method (or setup_class) and teardown_method (or teardown_class) in + test classes * Use pytest parametrize in test classes when appropriate * Use pysat testing utilities when appropriate * Provide testing class methods with informative failure statements and From d3137036e557922576dabff4261f8696d0ff50f8 Mon Sep 17 00:00:00 2001 From: "Angeline G. Burrell" Date: Wed, 13 Sep 2023 16:37:05 -0400 Subject: [PATCH 3/9] DOC: updated README Improved grammer in readme. --- README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 8c0cdc0..f4a2931 100644 --- a/README.md +++ b/README.md @@ -73,5 +73,5 @@ pysat.utils.registry.register('PACKAGENAME.instruments.EX_INST') inst = pysat.Instrument('EX', 'INST') ``` -The package include analysis tools as well. Detailed examples are in the -documentation (LINK TO READTHEDOCS). +The package also includes analysis tools. Detailed examples are in the +[documentation](LINK TO READTHEDOCS). From f43c50bb5a6650e07cc0cfaa82d8a691224b9843 Mon Sep 17 00:00:00 2001 From: "Angeline G. Burrell" Date: Wed, 13 Sep 2023 16:48:09 -0400 Subject: [PATCH 4/9] BUG: fixed toml Fixed the toml example by adding missing quotation marks. --- pyproject.toml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/pyproject.toml b/pyproject.toml index 1e2e7ec..c44dd59 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -3,7 +3,7 @@ requires = ["setuptools >= 38.6", "pip >= 10"] build-backend = "setuptools.build_meta" [project] -name = PACKAGENAME +name = "PACKAGENAME" version = "0.0.1" description = 'pysat support for DATA OR ANALYSIS' readme = "README.md" From 7e31380e3468da28988e1765476251504f390c8a Mon Sep 17 00:00:00 2001 From: "Angeline G. Burrell" Date: Wed, 13 Sep 2023 16:54:03 -0400 Subject: [PATCH 5/9] DOC: updated pull request template Added a linting box to the template. --- .github/pull_request_template.md | 6 +++++- 1 file changed, 5 insertions(+), 1 deletion(-) diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md index bdbd8ab..af9c63d 100644 --- a/.github/pull_request_template.md +++ b/.github/pull_request_template.md @@ -24,7 +24,10 @@ or test files is frequently very useful. Please also list any relevant details for your test configuration. - Test A -- Test B + +``` +Test B +``` ## Test Configuration * Operating system: Hal @@ -36,6 +39,7 @@ for your test configuration. - [ ] Make sure you are merging into the ``develop`` (not ``main``) branch - [ ] My code follows the style guidelines of this project - [ ] I have performed a self-review of my own code +- [ ] I have linted the files updated in this pull request - [ ] I have commented my code, particularly in hard-to-understand areas - [ ] I have made corresponding changes to the documentation - [ ] My changes generate no new warnings From 58f2e77fb0eba44a8f83300b84322c6f019c494f Mon Sep 17 00:00:00 2001 From: "Angeline G. Burrell" Date: Wed, 13 Sep 2023 17:05:39 -0400 Subject: [PATCH 6/9] TST: updated test templates Updated the comments in the test templates. --- .github/workflows/docs.yml | 5 +++-- .github/workflows/main.yml | 5 +++-- .github/workflows/pip_rc_install.yml | 7 ++++--- .github/workflows/pysat_rc.yml | 7 ++++--- 4 files changed, 14 insertions(+), 10 deletions(-) diff --git a/.github/workflows/docs.yml b/.github/workflows/docs.yml index 65dbbdb..75be31d 100644 --- a/.github/workflows/docs.yml +++ b/.github/workflows/docs.yml @@ -1,5 +1,6 @@ -# This workflow will install Python dependencies, run tests and lint with a variety of Python versions -# For more information see: https://help.github.com/actions/language-and-framework-guides/using-python-with-github-actions +# This workflow will install Python dependencies, run tests and lint with a +# variety of Python versions. For more information see: +# https://help.github.com/actions/language-and-framework-guides/using-python-with-github-actions name: Documentation Check diff --git a/.github/workflows/main.yml b/.github/workflows/main.yml index 8ad1738..4f1688c 100644 --- a/.github/workflows/main.yml +++ b/.github/workflows/main.yml @@ -1,5 +1,6 @@ -# This workflow will install Python dependencies, run tests and lint with a variety of Python versions -# For more information see: https://help.github.com/actions/language-and-framework-guides/using-python-with-github-actions +# This workflow will install Python dependencies, run tests and lint with a +# variety of Python versions. For more information see: +# https://help.github.com/actions/language-and-framework-guides/using-python-with-github-actions name: Pytest with Flake8 diff --git a/.github/workflows/pip_rc_install.yml b/.github/workflows/pip_rc_install.yml index adc3f41..7de9ba5 100644 --- a/.github/workflows/pip_rc_install.yml +++ b/.github/workflows/pip_rc_install.yml @@ -1,6 +1,7 @@ -# This workflow will install Python dependencies and the latest RC of pysatNASA from test pypi. -# This test should be manually run before an RC is officially approved and versioned. -# For more information see: https://help.github.com/actions/language-and-framework-guides/using-python-with-github-actions +# This workflow will install Python dependencies and the latest RC of +# PROJECTNAME from test pypi. This test should be manually run before an RC is +# officially approved and versioned. For more information see: +# https://help.github.com/actions/language-and-framework-guides/using-python-with-github-actions name: Test install of latest RC from pip diff --git a/.github/workflows/pysat_rc.yml b/.github/workflows/pysat_rc.yml index d9d44b4..baf6edd 100644 --- a/.github/workflows/pysat_rc.yml +++ b/.github/workflows/pysat_rc.yml @@ -1,5 +1,6 @@ -# This workflow will install Python dependencies, run tests and lint with a variety of Python versions -# For more information see: https://help.github.com/actions/language-and-framework-guides/using-python-with-github-actions +# This workflow will install Python dependencies, run tests and lint with a +# variety of Python versions. For more information see: +# https://help.github.com/actions/language-and-framework-guides/using-python-with-github-actions name: Test with latest pysat RC @@ -11,7 +12,7 @@ jobs: strategy: fail-fast: false matrix: - os: [ubuntu-latest, macos-latest, windows-latest] + os: ["ubuntu-latest", "macos-latest", "windows-latest"] python-version: ["3.10"] name: Python ${{ matrix.python-version }} on ${{ matrix.os }} From 4678452d127b828a2d40ed1ad364e4107dfd8938 Mon Sep 17 00:00:00 2001 From: "Angeline G. Burrell" Date: Wed, 13 Sep 2023 17:09:57 -0400 Subject: [PATCH 7/9] ENH: added init example Added an example init file. --- PACKAGENAME/__init__.py | 14 ++++++++++++++ 1 file changed, 14 insertions(+) create mode 100644 PACKAGENAME/__init__.py diff --git a/PACKAGENAME/__init__.py b/PACKAGENAME/__init__.py new file mode 100644 index 0000000..d7b2197 --- /dev/null +++ b/PACKAGENAME/__init__.py @@ -0,0 +1,14 @@ +"""Core library for PACKAGENAME. + +DESCRIPTION. + +""" + +try: + from importlib import metadata +except ImportError: + import importlib_metadata as metadata + +from PACKAGENAME import instruments # noqa F401 + +__version__ = metadata.version('PACKAGENAME') From 2d85ec8112fca4fad81ae6af3a32a3fdf27ce52c Mon Sep 17 00:00:00 2001 From: "Angeline G. Burrell" Date: Thu, 14 Sep 2023 10:15:41 -0400 Subject: [PATCH 8/9] DOC: updated conf.py Added logo to the HTML theme options. --- docs/conf.py | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/conf.py b/docs/conf.py index 810c678..0f29055 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -22,6 +22,7 @@ import os from pyproject_parser import PyProject import sys + sys.path.insert(0, os.path.abspath('..')) # -- Project information - Replace PACKAGENAME, ETC with appropriate package information --- @@ -111,8 +112,7 @@ # Theme options are theme-specific and customize the look and feel of a theme # further. For a list of options available for each theme, see the # documentation. -# -# html_theme_options = {} +html_theme_options = {'logo_only': True} # Add any paths that contain custom static files (such as style sheets) here, # relative to this directory. They are copied after the builtin static files, From a8c48863c2ff1e82f9e0460c88263dc451b7683b Mon Sep 17 00:00:00 2001 From: "Angeline G. Burrell" Date: Thu, 14 Sep 2023 10:15:57 -0400 Subject: [PATCH 9/9] DOC: updated links Removed duplicate links to the 'GitHub' text. --- CONTRIBUTING.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index cf64e13..6325f7e 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -47,8 +47,8 @@ include: Feature requests and feedback ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ -The best way to send feedback is to file an issue at -[GitHub](https://github.com/pysat/PACKAGENAME/issues). +The best way to send feedback is to file an +[issue](https://github.com/pysat/PACKAGENAME/issues). If you are proposing a new feature or a change in something that already exists: