Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/pauleveritt/storytime

Develop web components visually with testing and docs.
https://github.com/pauleveritt/storytime

Last synced: 9 days ago
JSON representation

Develop web components visually with testing and docs.

Awesome Lists containing this project

README

        

Storytime
=========

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

|Read the Docs| |Tests| |Codecov|

|pre-commit| |Black|

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

.. code:: console

$ pip install storytime

Usage
-----

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

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

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

License
-------

Distributed under the terms of the `MIT license`_,
*Storytime* 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/pauleveritt/storytime/issues
.. _pip: https://pip.pypa.io/
.. github-only
.. _Contributor Guide: CONTRIBUTING.rst
.. _Usage: https://storytime.readthedocs.io/en/latest/usage.html