tsgettoolbox-ncei 27.0.0__tar.gz

tsgettoolbox_ncei-27.0.0/.deepsource.toml

@@ -0,0 +1,8 @@
+version = 1
+
+[[analyzers]]
+enabled = true
+name = "python"
+
+[analyzers.meta]
+runtime_version = "3.8.x"

tsgettoolbox_ncei-27.0.0/.pre-commit-config.yaml

@@ -0,0 +1,87 @@
+---
+# See https://pre-commit.com for more information
+# See https://pre-commit.com/hooks.html for more hooks
+
+exclude: |
+    (?x)^(
+        .*\.dods|
+        .*\.dmr|
+        .*\.dmd|
+        .*\.wdm|
+        .*\.hbn
+        )$
+
+repos:
+    - repo: https://github.com/pre-commit/pre-commit-hooks
+      rev: v6.0.0
+      hooks:
+          - id: check-case-conflict
+          - id: check-docstring-first
+          - id: check-executables-have-shebangs
+          - id: check-json
+          - id: check-merge-conflict
+          - id: check-shebang-scripts-are-executable
+          - id: check-toml
+          - id: check-xml
+          - id: end-of-file-fixer
+            exclude: notebooks/tstoolbox_plot_bash.sh
+          - id: mixed-line-ending
+          - id: trailing-whitespace
+            exclude: notebooks/tstoolbox_plot_bash.sh
+
+    - repo: https://github.com/astral-sh/ruff-pre-commit
+      # Ruff version.
+      rev: v0.16.9
+      hooks:
+          # Run the linter.
+          - id: ruff
+            types_or: [python, pyi, jupyter]
+            args: [--fix]
+          # Run the formatter.
+          - id: ruff-format
+            types_or: [python, pyi, jupyter]
+
+    - repo: https://github.com/pappasam/toml-sort
+      rev: v0.25.0
+      hooks:
+          - id: toml-sort-fix
+            args: [--in-place, --spaces-indent-inline-array, '4']
+
+    - repo: https://github.com/adrienverge/yamllint.git
+      rev: v1.38.0
+      hooks:
+          - id: yamllint
+            args: [--format, parsable, --strict]
+
+    - repo: https://github.com/jumanjihouse/pre-commit-hook-yamlfmt
+      rev: 0.2.3
+      hooks:
+          - id: yamlfmt
+
+    - repo: https://github.com/jumanjihouse/pre-commit-hooks
+      rev: 3.0.0
+      hooks:
+          - id: shellcheck
+            args: [-s, bash]
+
+    - repo: https://github.com/lovesegfault/beautysh
+      rev: v6.4.3
+      hooks:
+          - id: beautysh
+            args: [--indent-size, '4']
+
+    - repo: https://github.com/asottile/blacken-docs
+      rev: 1.20.0
+      hooks:
+          - id: blacken-docs
+
+    - repo: https://github.com/asottile/pyupgrade
+      rev: v3.21.2
+      hooks:
+          - id: pyupgrade
+
+    - repo: https://github.com/commitizen-tools/commitizen
+      rev: v4.19.0
+      hooks:
+          - id: commitizen
+            stages: [commit-msg]

tsgettoolbox_ncei-27.0.0/.sourcery.yaml

@@ -0,0 +1,77 @@
+---
+# 🪄 This is your project's Sourcery configuration file.
+
+# You can use it to get Sourcery working in the way you want, such as
+# ignoring specific refactorings, skipping directories in your project,
+# or writing custom rules.
+
+# 📚 For a complete reference to this file, see the documentation at
+# https://docs.sourcery.ai/Configuration/Project-Settings/
+
+# This file was auto-generated by Sourcery on 2023-11-19 at 01:27.
+
+version: '1'  # The schema version of this config file
+
+ignore:  # A list of paths or files which Sourcery will ignore.
+    - .git
+    - venv
+    - .venv
+    - env
+    - .env
+    - .tox
+    - node_modules
+    - vendor
+
+rule_settings:
+    enable:
+        - default
+    disable: []  # A list of rule IDs Sourcery will never suggest.
+    rule_types:
+        - refactoring
+        - suggestion
+        - comment
+    # A string specifying the lowest Python version your project supports.
+    # Sourcery will not suggest refactorings requiring a higher Python version.
+    python_version: '3.8'
+
+# rules:  # A list of custom rules Sourcery will include in its analysis.
+# - id: no-print-statements
+#   description: Do not use print statements in the test directory.
+#   pattern: print(...)
+#   language: python
+#   replacement:
+#   condition:
+#   explanation:
+#   paths:
+#     include:
+#     - test
+#     exclude:
+#     - conftest.py
+#   tests: []
+#   tags: []
+
+# rule_tags: {} # Additional rule tags.
+
+# metrics:
+#   quality_threshold: 25.0
+
+# github:
+#   labels: []
+#   ignore_labels:
+#   - sourcery-ignore
+#   request_review: author
+#   sourcery_branch: sourcery/{base_branch}
+
+# clone_detection:
+#   min_lines: 3
+#   min_duplicates: 2
+#   identical_clones_only: false
+
+# proxy:
+#   url:
+#   ssl_certs_file:
+#   no_ssl_verify: false
+
+# coding_assistant:
+#   project_description: ''
+#   enabled:

tsgettoolbox_ncei-27.0.0/AUTHORS.rst

@@ -0,0 +1,4 @@
+
+Authors
+=======
+Tim Cera, P.E.

tsgettoolbox_ncei-27.0.0/BADGES.rst

@@ -0,0 +1,19 @@
+.. image:: https://img.shields.io/coveralls/github/timcera/tsgettoolbox
+    :alt: Test Coverage
+    :target: https://coveralls.io/r/timcera/tsgettoolbox?branch=master
+    :height: 20
+
+.. image:: https://img.shields.io/pypi/v/tsgettoolbox.svg
+    :alt: Latest release
+    :target: https://pypi.python.org/pypi/tsgettoolbox/
+    :height: 20
+
+.. image:: https://img.shields.io/pypi/l/tsgettoolbox.svg
+    :alt: BSD-3 clause license
+    :target: https://pypi.python.org/pypi/tsgettoolbox/
+    :height: 20
+
+.. image:: https://img.shields.io/pypi/pyversions/tsgettoolbox
+    :alt: PyPI - Python Version
+    :target: https://pypi.org/project/tsgettoolbox/
+    :height: 20

tsgettoolbox_ncei-27.0.0/CITATION.cff

@@ -0,0 +1,30 @@
+# This CITATION.cff file was generated with cffinit.
+# Visit https://bit.ly/cffinit to generate yours today!
+
+cff-version: 1.2.0
+title: tsgettoolbox
+message: >-
+  If you use this software, please cite it using the
+  metadata from this file.
+type: software
+authors:
+  - given-names: Timothy
+    family-names: Cera
+    email: tim@cerazone.net
+    orcid: 'https://orcid.org/0000-0003-4613-7697'
+repository-code: 'https://github.com/timcera/tsgettoolbox'
+url: 'https://timcera.bitbucket.io'
+repository: 'https://bitbucket.org/timcera/tsgettoolbox'
+repository-artifact: 'https://pypi.org/project/tsgettoolbox/'
+abstract: >-
+  tsgettoolbox is a small Python library for downloading and
+  reformatting hydrologic and meteorologic time-series data
+  from various internet sources.
+keywords:
+  - time-series
+  - uri
+  - url
+  - hydrology
+  - meteorology
+  - rest
+license: BSD-3-Clause

tsgettoolbox_ncei-27.0.0/CONTRIBUTING.rst

@@ -0,0 +1,115 @@
+============
+Contributing
+============
+Contributions are welcome, and they are greatly appreciated! Every
+little bit helps, and credit will always be given.
+
+You can contribute in many ways:
+
+Types of Contributions
+----------------------
+
+Report Bugs
+~~~~~~~~~~~
+Report bugs at https://github.com/timcera/tsgettoolbox_ncei
+
+If you are reporting a bug, please include:
+
+* Your operating system name and version.
+* Any details about your local setup that might be helpful in troubleshooting.
+* Detailed steps to reproduce the bug.
+
+Fix Bugs
+~~~~~~~~
+Look through the github issues for bugs. Anything tagged with "bug" is open to
+whoever wants to implement it.
+
+Implement Features
+~~~~~~~~~~~~~~~~~~
+Look through the github issues for features. Anything tagged with "feature" is
+open to whoever wants to implement it.
+
+Write Documentation
+~~~~~~~~~~~~~~~~~~~
+tsgettoolbox_ncei could always use more documentation, whether as part of the
+official tsgettoolbox_ncei docs or in docstrings.
+
+Submit Feedback
+~~~~~~~~~~~~~~~
+The best way to send feedback is to file an issue at
+https://github.com/timcera/tsgettoolbox_ncei
+
+If you are proposing a feature:
+
+* Explain in detail how it would work.
+* Keep the scope as narrow as possible, to make it easier to implement.
+* Remember that this is a volunteer-driven project, and that contributions
+  are welcome :)
+
+Get Started!
+------------
+Ready to contribute? Here's how to set up `tsgettoolbox_ncei` for local development.
+
+1. Fork the `tsgettoolbox_ncei` repo at
+   https://github.com/timcera/tsgettoolbox_ncei
+
+2. Clone your fork locally::
+
+    $ git clone git@github.com:your_github_login/tsgettoolbox_ncei.git
+
+3. Create a virtual python environment with `pip` or `conda` (whatever you
+   prefer) and activate it, and install `tsgettoolbox_ncei` in development
+   mode::
+
+    #     Using conda would be something like this:
+    $ conda create -n tsgettoolbox_ncei python=3.11
+    $ conda activate tsgettoolbox_ncei
+    $ cd tsgettoolbox_ncei/
+
+    #     The following command will list all the dependencies that will be
+    #     installed, but not actually install them.
+    $ python -m pip install --dry-run -e .
+
+    #     Use conda to install the dependencies listed above, excluding
+    #     tsgettoolbox_ncei itself. For example:
+    $ conda install -c conda-forge numpy pandas
+
+    #     Now install tsgettoolbox_ncei in development mode.
+    $ python -m pip install -e .
+
+4. For linting, reformatting, and testing you also need to install ruff and
+   pytest::
+
+    $ conda install -c conda-forge ruff pytest
+
+5. Create a branch for local development::
+
+    $ git checkout -b name-of-your-bugfix-or-feature
+
+    Now you can make your changes locally.
+
+6. When you're done making changes, check that your changes pass pytest, the
+   ruff linter and ruff formatter.::
+
+    $ ruff check -f --select "I" .
+    $ ruff format .
+    $ pytest
+
+7. Commit your changes and push your branch to github::
+
+    $ git add .  # or choose the specific files you want to add
+    $ git commit -m "Your detailed description of your changes."
+    $ git push origin name-of-your-bugfix-or-feature
+
+8. Submit a pull request through the github website.
+
+Pull Request Guidelines
+-----------------------
+
+Before you submit a pull request, check that it meets these guidelines:
+
+1. The pull request should include tests.
+2. If the pull request adds functionality, the docs should be updated. Put
+   your new functionality into a function with a docstring, and add the
+   feature to the list in README.rst.
+3. The pull request should work for Python 3.10 and above.

tsgettoolbox_ncei-27.0.0/LICENSE.txt

@@ -0,0 +1,24 @@
+Copyright (c) 2013, Tim Cera
+All rights reserved.
+
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions are met:
+    * Redistributions of source code must retain the above copyright notice,
+      this list of conditions and the following disclaimer.
+    * Redistributions in binary form must reproduce the above copyright notice,
+      this list of conditions and the following disclaimer in the documentation
+      and/or other materials provided with the distribution.
+    * Neither the name tsgettoolbox nor the names of its contributors may be
+      used to endorse or promote products derived from this software without
+      specific prior written permission.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
+ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
+WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDERS OR CONTRIBUTORS BE LIABLE
+FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
+SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
+CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
+OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

tsgettoolbox_ncei-27.0.0/MANIFEST.in

@@ -0,0 +1,50 @@
+include *.cff
+include *.in
+include *.md
+include *.rst
+include *.toml
+include *.txt
+include *.yaml
+include .gitmodules
+recursive-include docs *.bat
+recursive-include docs *.png
+recursive-include docs *.py
+recursive-include docs *.rst
+recursive-include docs Makefile
+recursive-include notebooks *.csv
+recursive-include notebooks *.ipynb
+recursive-include notebooks *.png
+recursive-include notebooks *.py
+recursive-include notebooks *.sh
+recursive-include src *.bat
+recursive-include src *.csv
+recursive-include src *.dat
+recursive-include src *.hbn
+recursive-include src *.in
+recursive-include src *.md
+recursive-include src *.plt
+recursive-include src *.rst
+recursive-include src *.sh
+recursive-include src *.toml
+recursive-include src *.txt
+recursive-include src *.wdm
+recursive-include src *.xlsx
+recursive-include src *.yaml
+recursive-include src *.yml
+recursive-include src Makefile
+recursive-include src *.py
+
+recursive-exclude tests *.cfm
+recursive-exclude tests *.csv
+recursive-exclude tests *.data
+recursive-exclude tests *.dly
+recursive-exclude tests *.htm
+recursive-exclude tests *.html
+recursive-exclude tests *.img
+recursive-exclude tests *.jp2
+recursive-exclude tests *.json
+recursive-exclude tests *.py
+recursive-exclude tests *.tar
+recursive-exclude tests *.txt
+recursive-exclude tests *.xml
+recursive-exclude tests *.zip

tsgettoolbox_ncei-27.0.0/PKG-INFO

@@ -0,0 +1,182 @@
+Metadata-Version: 2.4
+Name: tsgettoolbox_ncei
+Version: 27.0.0
+Summary: Plugin for tsgettoolbox to access NOAA National Centers for Environmental Information (NCEI) data.
+Author-email: Tim Cera <tim@cerazone.net>
+License-Expression: BSD-3-Clause
+Project-URL: bitbucket, https://bitbucket.org/timcera/tsgettoolbox_ncei/src/main/
+Project-URL: documentation, https://timcera.bitbucket.io/tsgettoolbox/docs/index.html#tsgettoolbox-documentation
+Project-URL: github, https://github.com/timcera/tsgettoolbox_ncei
+Keywords: rest,time-series,uri,url,web_services
+Classifier: Development Status :: 5 - Production/Stable
+Classifier: Environment :: Console
+Classifier: Intended Audience :: Developers
+Classifier: Intended Audience :: End Users/Desktop
+Classifier: Intended Audience :: Science/Research
+Classifier: Natural Language :: English
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3 :: Only
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Programming Language :: Python :: 3.14
+Classifier: Topic :: Scientific/Engineering :: Information Analysis
+Classifier: Topic :: Scientific/Engineering
+Classifier: Topic :: Software Development :: Libraries :: Python Modules
+Requires-Python: >=3.10
+Description-Content-Type: text/x-rst
+License-File: LICENSE.txt
+Requires-Dist: numpy
+Requires-Dist: pandas
+Requires-Dist: platformdirs
+Requires-Dist: requests
+Requires-Dist: tsgettoolbox>=27.0.0
+Dynamic: license-file
+
+.. image:: https://img.shields.io/coveralls/github/timcera/tsgettoolbox_ncei
+    :alt: Test Coverage
+    :target: https://coveralls.io/r/timcera/tsgettoolbox_ncei?branch=master
+    :height: 20
+
+.. image:: https://img.shields.io/pypi/v/tsgettoolbox_ncei
+    :alt: Latest release
+    :target: https://pypi.python.org/pypi/tsgettoolbox_ncei/
+    :height: 20
+
+.. image:: https://img.shields.io/pypi/l/tsgettoolbox_ncei
+    :alt: BSD-3 clause license
+    :target: https://pypi.python.org/pypi/tsgettoolbox_ncei/
+    :height: 20
+
+.. image:: https://img.shields.io/pypi/pyversions/tsgettoolbox_ncei
+    :alt: PyPI - Python Version
+    :target: https://pypi.org/project/tsgettoolbox_ncei/
+    :height: 20
+
+tsgettoolbox_ncei - Quick Guide
+===============================
+The 'tsgettoolbox_ncei' is a plugin-in for 'tsgettoolbox' that supplies
+a command line interface and Python library to get time-series data from the
+California Data Exchange Center (CDEC).  The tsgettoolbox_ncei will work with
+Python and 3.10+.
+
+Documentation
+-------------
+Reference documentation is at `tsgettoolbox NCEI API`_.
+
+Installation
+------------
+At the command line::
+
+    $ pip install tsgettoolbox_ncei
+
+    OR
+
+    $ conda install -c conda-forge tsgettoolbox_ncei
+
+Usage Summary - Command Line
+----------------------------
+Just run 'tsgettoolbox --help' to get a list of subcommands.  To get detailed
+help for a particular sub-command, for instance 'ncei', type 'tsgettoolbox
+ncei --help'.
+
++-----------------+---------+--------+---------+----------+-----------------------+
+| Sub-command     | Spatial | Time   | Type    | Time     | Description           |
+|                 | Extent  | Extent |         | Interval |                       |
++=================+=========+========+=========+==========+=======================+
+| ncei_ghcnd_ftp  | global  | varies | station | D        | NCEI Global           |
+|                 |         |        |         |          | Historical            |
+|                 |         |        |         |          | Climatology Network - |
+|                 |         |        |         |          | Daily (GHCND) from    |
+|                 |         |        |         |          | FTP server.           |
++-----------------+---------+--------+---------+----------+-----------------------+
+| ncei_ghcnd      | global  | varies | station | D        | NCEI Global           |
+|                 |         |        |         |          | Historical            |
+|                 |         |        |         |          | Climatology Network - |
+|                 |         |        |         |          | Daily (GHCND) from    |
+|                 |         |        |         |          | web services.         |
++-----------------+---------+--------+---------+----------+-----------------------+
+| ncei_gsod       | global  | varies | station | D        | NCEI Global Summary   |
+|                 |         |        |         |          | of the Day (GSOD)     |
++-----------------+---------+--------+---------+----------+-----------------------+
+| ncei_gsom       | global  | varies | station | M        | NCEI Global Summary   |
+|                 |         |        |         |          | of the Month (GSOM)   |
++-----------------+---------+--------+---------+----------+-----------------------+
+| ncei_gsoy       | global  | varies | station | A        | NCEI Global Summary   |
+|                 |         |        |         |          | of Year               |
++-----------------+---------+--------+---------+----------+-----------------------+
+| ncei_normal_ann | global  | varies | station | A        | NCEI annual normals   |
++-----------------+---------+--------+---------+----------+-----------------------+
+| ncei_normal_dly | global  | varies | station | D        | NCEI daily normals    |
++-----------------+---------+--------+---------+----------+-----------------------+
+| ncei_normal_hly | global  | varies | station | H        | NCEI hourly normals   |
++-----------------+---------+--------+---------+----------+-----------------------+
+| ncei_normal_mly | global  | varies | station | M        | NCEI monthly normals  |
++-----------------+---------+--------+---------+----------+-----------------------+
+| ncei_precip_15  | global  | varies | station | 15T      | NCEI 15 minute        |
+|                 |         |        |         |          | precipitation         |
++-----------------+---------+--------+---------+----------+-----------------------+
+| ncei_precip_hly | global  | varies | station | H        | NCEI hourly           |
+|                 |         |        |         |          | precipitation         |
++-----------------+---------+--------+---------+----------+-----------------------+
+| ncei_annual     | global  | varies | station | A        | NCEI annual data      |
+|                 |         |        |         |          | summaries             |
++-----------------+---------+--------+---------+----------+-----------------------+
+| ncei_ghcndms    | global  | varies | station | M        | NCEI GHCND Monthly    |
+|                 |         |        |         |          | Summaries (GHCNDMS)   |
++-----------------+---------+--------+---------+----------+-----------------------+
+| ncei_ish        | global  | varies | station | H        | NCEI Integrated       |
+|                 |         |        |         |          | Surface hourly        |
++-----------------+---------+--------+---------+----------+-----------------------+
+
++-------------------+-------------+
+| Time Interval     | Description |
+| Code              |             |
++===================+=============+
+| T                 | Minute      |
++-------------------+-------------+
+| H                 | Hourly      |
++-------------------+-------------+
+| D                 | Daily       |
++-------------------+-------------+
+| M                 | Monthly     |
++-------------------+-------------+
+| A                 | Annual      |
++-------------------+-------------+
+
+Usage Summary - Python Library
+------------------------------
+To use the tsgettoolbox in a project::
+
+    from tsgettoolbox import tsgettoolbox
+    start_date = "2010-01-01"
+    end_date = "2013-01-01"
+    df = tsgettoolbox.ncei_precip_hly(
+        "COOP:087440",
+        start_date=start_date,
+        end_date=end_date,
+    )
+    print(df.head())
+
+Refer to the API Documentation at `tsgettoolbox NCEI API`_.
+
+Usage Summary - Command Line
+----------------------------
+
+    tsgettoolbox ncei_precip_hly \
+        "COOP:087440" \
+        --start_date="2010-01-01" \
+        --end_date="2013-01-01" > output.csv
+
+Refer to the command line documentation at `tsgettoolbox NCEI CLI`_.
+
+Development
+~~~~~~~~~~~
+Development is managed on bitbucket or github.
+https://bitbucket.org/timcera/tsgettoolbox_ncei/overview.
+https://github.com/timcera/tsgettoolbox_ncei
+
+.. _tsgettoolbox_documentation: https://timcera.bitbucket.io/linked_pkg_dirs/tsgettoolbox/docs/index.html
+.. _tsgettoolbox NCEI API: https://timcera.bitbucket.io/linked_pkg_dirs/tsgettoolbox/docs/_function_autosummary/tsgettoolbox.ncei_annual.html
+.. _tsgettoolbox NCEI CLI: https://timcera.bitbucket.io/linked_pkg_dirs/tsgettoolbox/docs/command_line.html#ncei-annual