Metadata-Version: 2.1
Name: econoplots
Version: 0.1.2
Summary: Formats Matplotlib plots into the style of The Economist
Author-email: Dylan Penn <dylan.penn@vt.edu>
License: Copyright (c) 2022 Dylan Penn
        
        Permission is hereby granted, free of charge, to any person obtaining
        a copy of this software and associated documentation files (the
        "Software"), to deal in the Software without restriction, including
        without limitation the rights to use, copy, modify, merge, publish,
        distribute, sublicense, and/or sell copies of the Software, and to
        permit persons to whom the Software is furnished to do so, subject to
        the following conditions:
        
        The above copyright notice and this permission notice shall be
        included in all copies or substantial portions of the Software.
        
        THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
        EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
        MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
        NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
        LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
        OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
        WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
Project-URL: Homepage, https://github.com/dylan906/econoplots
Classifier: Programming Language :: Python :: 3
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Requires-Python: >=3.7
Description-Content-Type: text/markdown
License-File: LICENSE

# Description
This project helps create Matplotlib plots in the style of *The Economist*. Only some plot styles are supported (line plots are the only style that works right now) and there are some stylistic differences from *The Economist* for the sake of convenience/laziness. 

# Users Guide
- Install fonts (see below) before using any functions.
- The main function you will use is `converter.convert2Econo()`, which takes a Matplotlib `Axes` and returns and `Axes` that is formatted nicely.
    - First generate a Matplotlib `Axes` in any way you like, then pass it into `convert2Econo()`-- then presto you have an Econoplot!

# How to install fonts
- Copy .ttf file here: "~\\.local\share\fonts"
- Delete the matplotlib cache here (it will automatically be recreated): "~\\.cache\matplotlib"
