Metadata-Version: 2.1
Name: mplruler
Version: 0.0.1
Summary: ruler for matplotlib's figure
Author: 15b3
License: MIT License
        
        Copyright (c) 2024 strawberry beach sandals
        
        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/15b3/mplruler
Project-URL: Issues, https://github.com/15b3/mplruler/issues
Classifier: Programming Language :: Python :: 3
Classifier: License :: OSI Approved :: MIT License
Requires-Python: >=3.6
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: matplotlib
Requires-Dist: numpy
Provides-Extra: dev
Requires-Dist: pytest; extra == "dev"
Requires-Dist: flake8; extra == "dev"
Requires-Dist: mypy; extra == "dev"
Requires-Dist: black; extra == "dev"
Requires-Dist: isort; extra == "dev"

# mplruler

This is an auxiliary library for displaying rulers and grids in matplotlib's Figure.

Although they do not remain on the final figure, auxiliary lines and scales make it easy to grasp the position and size of the figure and make adjustments smoothly.

`mlpruler` has two functions.

* `add_ruler`
  * Display ruler in inches

![ruler](./images/ruler.png)

* `add_grid`
  * Displays grid lines in fraction

![grid](./images/grid.png)


## Example

With grid lines, it is easy to keep track of the width and position of the axes.

![both](./images/both.png)


## Installation

```
pip install mplruler
```
