Metadata-Version: 2.1
Name: nbpreview
Version: 0.1.0
Summary: nbpreview
Home-page: https://github.com/paw-lu/nbpreview
License: MIT
Author: Paulo S. Costa
Author-email: Paulo.S.Costa5@gmail.com
Requires-Python: >=3.7.0,<4.0.0
Classifier: Development Status :: 3 - Alpha
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Requires-Dist: Jinja2 (>=3.0.1,<4.0.0)
Requires-Dist: Pillow (>=8.3.1,<9.0.0)
Requires-Dist: Pygments (>=2.10.0,<3.0.0)
Requires-Dist: html2text (>=2020.1.16,<2021.0.0)
Requires-Dist: httpx (>=0.19.0,<0.20.0)
Requires-Dist: importlib-metadata (>=4.8.1,<5.0.0); python_version < "3.8"
Requires-Dist: ipython (>=7.27.0,<8.0.0)
Requires-Dist: lxml (>=4.6.3,<5.0.0)
Requires-Dist: nbformat (>=5.1.2,<6.0.0)
Requires-Dist: pylatexenc (>=2.10,<3.0)
Requires-Dist: rich (>=10.9.0,<11.0.0)
Requires-Dist: terminedia (>=0.4.1,<0.5.0)
Requires-Dist: typer (>=0.4.0,<0.5.0)
Requires-Dist: types-click (>=7.1.5,<8.0.0)
Requires-Dist: typing-extensions (>=3.10.0,<4.0.0)
Project-URL: Changelog, https://github.com/paw-lu/nbpreview/releases
Project-URL: Documentation, https://nbpreview.readthedocs.io
Project-URL: Repository, https://github.com/paw-lu/nbpreview
Description-Content-Type: text/x-rst

nbpreview
=========

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

|Read the Docs| |Tests| |Codecov|

|pre-commit| |Black|

.. |PyPI| image:: https://img.shields.io/pypi/v/nbpreview.svg
   :target: https://pypi.org/project/nbpreview/
   :alt: PyPI
.. |Status| image:: https://img.shields.io/pypi/status/nbpreview.svg
   :target: https://pypi.org/project/nbpreview/
   :alt: Status
.. |Python Version| image:: https://img.shields.io/pypi/pyversions/nbpreview
   :target: https://pypi.org/project/nbpreview
   :alt: Python Version
.. |License| image:: https://img.shields.io/pypi/l/nbpreview
   :target: https://opensource.org/licenses/MIT
   :alt: License
.. |Read the Docs| image:: https://img.shields.io/readthedocs/nbpreview/latest.svg?label=Read%20the%20Docs
   :target: https://nbpreview.readthedocs.io/
   :alt: Read the documentation at https://nbpreview.readthedocs.io/
.. |Tests| image:: https://github.com/paw-lu/nbpreview/workflows/Tests/badge.svg
   :target: https://github.com/paw-lu/nbpreview/actions?workflow=Tests
   :alt: Tests
.. |Codecov| image:: https://codecov.io/gh/paw-lu/nbpreview/branch/main/graph/badge.svg
   :target: https://codecov.io/gh/paw-lu/nbpreview
   :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

A terminal viewer for Jupyter notebooks.

Features
--------

* Render accurate(ish) Jupyter notebooks in your terminal.
  Like cat (or bat) for ipynb files.


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

* Python 3.7


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

You can install *nbpreview* via pip_ from PyPI_:

.. code:: console

   $ pip install nbpreview


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`_,
*nbpreview* 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/paw-lu/nbpreview/issues
.. _pip: https://pip.pypa.io/
.. github-only
.. _Contributor Guide: CONTRIBUTING.rst
.. _Usage: https://nbpreview.readthedocs.io/en/latest/usage.html

