Metadata-Version: 2.4
Name: tsgettoolbox_cdec
Version: 27.0.1
Summary: Will get time series from different sources on the internet
Author-email: Tim Cera <tim@cerazone.net>
License-Expression: BSD-3-Clause
Project-URL: bitbucket, https://bitbucket.org/timcera/tsgettoolbox_cdec/src/main/
Project-URL: documentation, https://timcera.bitbucket.io/tsgettoolbox/docs/index.html#tsgettoolbox-documentation
Project-URL: github, https://github.com/timcera/tsgettoolbox_cdec
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: cltoolbox>=4.0.4
Requires-Dist: dateparser
Requires-Dist: numpy
Requires-Dist: openpyxl
Requires-Dist: pandas[excel]
Requires-Dist: pint
Requires-Dist: pint-pandas
Requires-Dist: pydantic>=2
Requires-Dist: scipy
Requires-Dist: tabulate
Requires-Dist: tsgettoolbox>=27.0.0
Dynamic: license-file

.. image:: https://img.shields.io/coveralls/github/timcera/tsgettoolbox_cdec
    :alt: Test Coverage
    :target: https://coveralls.io/r/timcera/tsgettoolbox_cdec?branch=master
    :height: 20

.. image:: https://img.shields.io/pypi/v/tsgettoolbox_cdec
    :alt: Latest release
    :target: https://pypi.python.org/pypi/tsgettoolbox_cdec/
    :height: 20

.. image:: https://img.shields.io/pypi/l/tsgettoolbox_cdec
    :alt: BSD-3 clause license
    :target: https://pypi.python.org/pypi/tsgettoolbox_cdec/
    :height: 20

.. image:: https://img.shields.io/pypi/pyversions/tsgettoolbox_cdec
    :alt: PyPI - Python Version
    :target: https://pypi.org/project/tsgettoolbox_cdec/
    :height: 20

tsgettoolbox_cdec - Quick Guide
===============================
The 'tsgettoolbox_cdec' 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_cdec will work with
Python and 3.10+.

Documentation
-------------
Reference documentation is at `tsgettoolbox CDEC API`_.

Installation
------------
At the command line::

    $ pip install tsgettoolbox_cdec

    OR

    $ conda install -c conda-forge tsgettoolbox_cdec

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 'coops', type 'tsgettoolbox
coops --help'.

+-------------+---------+--------+---------+----------+-----------------------+
| Sub-command | Spatial | Time   | Type    | Time     | Description           |
|             | Extent  | Extent |         | Interval |                       |
+=============+=========+========+=========+==========+=======================+
| cdec        | US/CA   | varies | station | E,H,D,M  | California Department |
|             |         |        |         |          | of Water Resources    |
+-------------+---------+--------+---------+----------+-----------------------+

+-------------------+-------------+
| Time Interval     | Description |
| Code              |             |
+===================+=============+
| E                 | Event       |
+-------------------+-------------+
| 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
    df = tsgettoolbox.cdec("PRA", start_date="2000-01-01", end_date="2000-02-01")
    print(df.head())

Refer to the API Documentation at `tsgettoolbox CDEC API`_.

Usage Summary - Command Line
----------------------------

    tsgettoolbox cdec --start_date 2000-01-01 --end_date 2000-02-01 "PRA" > output.csv

Refer to the command line documentation at `tsgettoolbox CLI`_.

Development
~~~~~~~~~~~
Development is managed on bitbucket or github.
https://bitbucket.org/timcera/tsgettoolbox_cdec/overview.
https://github.com/timcera/tsgettoolbox_cdec

.. _tsgettoolbox_documentation: https://timcera.bitbucket.io/linked_pkg_dirs/tsgettoolbox/docs/index.html#tsgettoolbox-documentation
.. _tsgettoolbox CLI: https://timcera.bitbucket.io/linked_pkg_dirs/tsgettoolbox/docs/command_line.html
.. _tsgettoolbox CDEC API: https://timcera.bitbucket.io/linked_pkg_dirs/tsgettoolbox/docs/_function_autosummary/tsgettoolbox.cdec.html
