Metadata-Version: 2.1
Name: cdfs
Version: 0.1.1
Summary: Continous Data File System
Home-page: https://github.com/fongant/python-cdfs
License: MIT
Author: Anthony Fong
Author-email: FongAnthonyM@gmail.com
Requires-Python: >=3.10,<4.0
Classifier: Development Status :: 1 - Planning
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Requires-Dist: click (>=8.0.3,<9.0.0)
Requires-Dist: dspobjects (>=0.2.0,<0.3.0)
Requires-Dist: framestructure (>=0.4.1,<0.5.0)
Requires-Dist: h5py (>=3.8.0,<4.0.0)
Requires-Dist: hdf5objects (>=0.3.1,<0.4.0)
Requires-Dist: numpy (>=1.24.3,<2.0.0)
Project-URL: Changelog, https://github.com/fongant/python-cdfs/releases
Project-URL: Documentation, https://python-cdfs.readthedocs.io
Project-URL: Repository, https://github.com/fongant/python-cdfs
Description-Content-Type: text/x-rst

cdfs
============

|PyPI| |Status| |Python Version| |License|

|Read the Docs| |Tests| |Codecov|

|pre-commit| |Black|

.. |PyPI| image:: https://img.shields.io/pypi/v/cdfs.svg
   :target: https://pypi.org/project/cdfs/
   :alt: PyPI
.. |Status| image:: https://img.shields.io/pypi/status/cdfs.svg
   :target: https://pypi.org/project/cdfs/
   :alt: Status
.. |Python Version| image:: https://img.shields.io/pypi/pyversions/cdfs
   :target: https://pypi.org/project/cdfs
   :alt: Python Version
.. |License| image:: https://img.shields.io/pypi/l/cdfs
   :target: https://opensource.org/licenses/MIT
   :alt: License
.. |Read the Docs| image:: https://img.shields.io/readthedocs/python-cdfs/latest.svg?label=Read%20the%20Docs
   :target: https://python-cdfs.readthedocs.io/
   :alt: Read the documentation at https://python-cdfs.readthedocs.io/
.. |Tests| image:: https://github.com/fongant/python-cdfs/workflows/Tests/badge.svg
   :target: https://github.com/fongant/cdfs/actions?workflow=Tests
   :alt: Tests
.. |Codecov| image:: https://codecov.io/gh/fongant/python-cdfs/branch/main/graph/badge.svg
   :target: https://codecov.io/gh/fongant/python-cdfs
   :alt: Codecov
.. |pre-commit| image:: https://img.shields.io/badge/pre--commit-enabled-brightgreen?logo=pre-commit&logoColor=white
   :target: https://github.com/pre-commit/pre-commit
   :alt: pre-commit
.. |Black| image:: https://img.shields.io/badge/code%20style-black-000000.svg
   :target: https://github.com/psf/black
   :alt: Black


Features
--------

* TODO


Requirements
------------

* TODO


Installation
------------

You can install *cdfs* via pip_ from PyPI_:

.. code:: console

   $ pip install cdfs


Usage
-----

Please see the `Command-line Reference <Usage_>`_ for details.


Contributing
------------

Contributions are very welcome.
To learn more, see the `Contributor Guide`_.


License
-------

Distributed under the terms of the `MIT license`_,
*cdfs* is free and open source software.


Issues
------

If you encounter any problems,
please `file an issue`_ along with a detailed description.


Credits
-------

This project was generated from `@cjolowicz`_'s `Hypermodern Python Cookiecutter`_ template.

.. _@cjolowicz: https://github.com/cjolowicz
.. _Cookiecutter: https://github.com/audreyr/cookiecutter
.. _MIT license: https://opensource.org/licenses/MIT
.. _PyPI: https://pypi.org/
.. _Hypermodern Python Cookiecutter: https://github.com/cjolowicz/cookiecutter-hypermodern-python
.. _file an issue: https://github.com/fongant/python-cdfs/issues
.. _pip: https://pip.pypa.io/
.. github-only
.. _Contributor Guide: CONTRIBUTING.rst
.. _Usage: https://python-cdfs.readthedocs.io/en/latest/usage.html

