Metadata-Version: 2.1
Name: wordle
Version: 0.1.0
Summary: Create a wordcloud for a Git repository.
Home-page: https://github.com/domdfcoding/wordle
Author: Dominic Davis-Foster
Author-email: dominic@davis-foster.co.uk
License: GNU Lesser General Public License v3 or later (LGPLv3+)
Project-URL: Documentation, https://wordle.readthedocs.io
Project-URL: Issue Tracker, https://github.com/domdfcoding/wordle/issues
Project-URL: Source Code, https://github.com/domdfcoding/wordle
Platform: UNKNOWN
Classifier: Development Status :: 3 - Alpha
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: GNU Lesser General Public License v3 or later (LGPLv3+)
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3 :: Only
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: Implementation :: CPython
Classifier: Topic :: Software Development :: Libraries :: Python Modules
Classifier: Topic :: Utilities
Classifier: Typing :: Typed
Requires-Python: >=3.6
Requires-Dist: numpy
Requires-Dist: pygments
Requires-Dist: dulwich
Requires-Dist: wordcloud
Provides-Extra: all

****************
wordle
****************

.. start short_desc

**Create a wordcloud for a Git repository.**

.. end short_desc

Can also create wordclouds from directories of source files or a single source file.

.. start shields 

.. list-table::
	:stub-columns: 1
	:widths: 10 90

	* - Docs
	  - |docs| |docs_check|
	* - Tests
	  - |travis| |actions_windows| |actions_macos| |codefactor|
	* - PyPI
	  - |pypi-version| |supported-versions| |supported-implementations| |wheel|
	* - Activity
	  - |commits-latest| |commits-since| |maintained|
	* - Other
	  - |license| |language| |requires|

.. |docs| image:: https://img.shields.io/readthedocs/wordle/latest?logo=read-the-docs
	:target: https://wordle.readthedocs.io/en/latest/?badge=latest
	:alt: Documentation Status

.. |docs_check| image:: https://github.com/domdfcoding/wordle/workflows/Docs%20Check/badge.svg
	:target: https://github.com/domdfcoding/wordle/actions?query=workflow%3A%22Docs+Check%22
	:alt: Docs Check Status

.. |travis| image:: https://img.shields.io/travis/com/domdfcoding/wordle/master?logo=travis
	:target: https://travis-ci.com/domdfcoding/wordle
	:alt: Travis Build Status

.. |actions_windows| image:: https://github.com/domdfcoding/wordle/workflows/Windows%20Tests/badge.svg
	:target: https://github.com/domdfcoding/wordle/actions?query=workflow%3A%22Windows+Tests%22
	:alt: Windows Tests Status

.. |actions_macos| image:: https://github.com/domdfcoding/wordle/workflows/macOS%20Tests/badge.svg
	:target: https://github.com/domdfcoding/wordle/actions?query=workflow%3A%22macOS+Tests%22
	:alt: macOS Tests Status

.. |requires| image:: https://requires.io/github/domdfcoding/wordle/requirements.svg?branch=master
	:target: https://requires.io/github/domdfcoding/wordle/requirements/?branch=master
	:alt: Requirements Status

.. |codefactor| image:: https://img.shields.io/codefactor/grade/github/domdfcoding/wordle?logo=codefactor
	:target: https://www.codefactor.io/repository/github/domdfcoding/wordle
	:alt: CodeFactor Grade

.. |pypi-version| image:: https://img.shields.io/pypi/v/wordle
	:target: https://pypi.org/project/wordle/
	:alt: PyPI - Package Version

.. |supported-versions| image:: https://img.shields.io/pypi/pyversions/wordle
	:target: https://pypi.org/project/wordle/
	:alt: PyPI - Supported Python Versions

.. |supported-implementations| image:: https://img.shields.io/pypi/implementation/wordle
	:target: https://pypi.org/project/wordle/
	:alt: PyPI - Supported Implementations

.. |wheel| image:: https://img.shields.io/pypi/wheel/wordle
	:target: https://pypi.org/project/wordle/
	:alt: PyPI - Wheel

.. |license| image:: https://img.shields.io/github/license/domdfcoding/wordle
	:alt: License
	:target: https://github.com/domdfcoding/wordle/blob/master/LICENSE

.. |language| image:: https://img.shields.io/github/languages/top/domdfcoding/wordle
	:alt: GitHub top language

.. |commits-since| image:: https://img.shields.io/github/commits-since/domdfcoding/wordle/v0.1.0
	:target: https://github.com/domdfcoding/wordle/pulse
	:alt: GitHub commits since tagged version

.. |commits-latest| image:: https://img.shields.io/github/last-commit/domdfcoding/wordle
	:target: https://github.com/domdfcoding/wordle/commit/master
	:alt: GitHub last commit

.. |maintained| image:: https://img.shields.io/maintenance/yes/2020
	:alt: Maintenance

.. end shields

|

Examples
------------

.. image:: https://raw.githubusercontent.com/domdfcoding/wordle/master/examples/c_wordcloud.png

Further examples are shown in the "Examples" directory

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

.. start installation

``wordle`` can be installed from PyPI.

To install with ``pip``:

.. code-block:: bash

	$ python -m pip install wordle

.. end installation



