Metadata-Version: 2.1
Name: pysmooth
Version: 1.0.1
Summary: Pysmooth: a Python implementation of R's stats::smooth Tukey's (running median) smoother
Home-page: https://github.com/mcsmith/pysmooth
License: GPL-3.0
Author: Miles Smith
Author-email: mileschristiansmith@gmail.com
Requires-Python: >=3.8,<=3.10
Classifier: Development Status :: 4 - Beta
Classifier: License :: OSI Approved :: GNU General Public License v3 (GPLv3)
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Requires-Dist: click (>=8.0.1,<9.0.0)
Requires-Dist: hypothesis (>=6.27.1,<7.0.0)
Requires-Dist: nox-poetry (>=0.9.0,<0.10.0)
Requires-Dist: numpy (>=1.21.4,<2.0.0)
Requires-Dist: rich (>=10.14.0,<11.0.0)
Requires-Dist: typer (>=0.4.0,<0.5.0)
Project-URL: Changelog, https://github.com/mcsmith/pysmooth/releases
Project-URL: Documentation, https://pysmooth.readthedocs.io
Project-URL: Repository, https://github.com/mcsmith/pysmooth
Description-Content-Type: text/x-rst

Pysmooth
==========

A Python implementation of R's stats::smooth() Tukey's (running median) smoother

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

|Read the Docs| |Tests| |Codecov|

|pre-commit| |Black|

.. |PyPI| image:: https://img.shields.io/pypi/v/pysmooth.svg
   :target: https://pypi.org/project/pysmooth/
   :alt: PyPI
.. |Status| image:: https://img.shields.io/pypi/status/pysmooth.svg
   :target: https://pypi.org/project/pysmooth/
   :alt: Status
.. |Python Version| image:: https://img.shields.io/pypi/pyversions/pysmooth
   :target: https://pypi.org/project/pysmooth
   :alt: Python Version
.. |License| image:: https://img.shields.io/pypi/l/pysmooth
   :target: https://opensource.org/licenses/GPL-3.0
   :alt: License
.. |Read the Docs| image:: https://img.shields.io/readthedocs/pysmooth/latest.svg?label=Read%20the%20Docs
   :target: https://pysmooth.readthedocs.io/
   :alt: Read the documentation at https://pysmooth.readthedocs.io/
.. |Tests| image:: https://github.com/mcsmith/pysmooth/workflows/Tests/badge.svg
   :target: https://github.com/mcsmith/pysmooth/actions?workflow=Tests
   :alt: Tests
.. |Codecov| image:: https://codecov.io/gh/mcsmith/pysmooth/branch/main/graph/badge.svg
   :target: https://codecov.io/gh/mcsmith/pysmooth
   :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
  - Replace code C/R-style coding with more Pythonic methods


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

* TODO


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

You can install *Pysmooth* via pip_ from PyPI_:

.. code:: console

   $ pip install pysmooth


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 `GPL 3.0 license`_,
*Pysmooth* 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
.. _GPL 3.0 license: https://opensource.org/licenses/GPL-3.0
.. _PyPI: https://pypi.org/
.. _Hypermodern Python Cookiecutter: https://github.com/cjolowicz/cookiecutter-hypermodern-python
.. _file an issue: https://github.com/mcsmith/pysmooth/issues
.. _pip: https://pip.pypa.io/
.. github-only
.. _Contributor Guide: CONTRIBUTING.rst
.. _Usage: https://pysmooth.readthedocs.io/en/latest/usage.html

