https://github.com/jfreissmann/mpllegends
Customizable standalone matplotlib legends
https://github.com/jfreissmann/mpllegends
data-science matplotlib plotting python visualization
Last synced: 28 days ago
JSON representation
Customizable standalone matplotlib legends
- Host: GitHub
- URL: https://github.com/jfreissmann/mpllegends
- Owner: jfreissmann
- License: mit
- Created: 2024-06-05T09:35:00.000Z (about 2 years ago)
- Default Branch: main
- Last Pushed: 2024-06-27T14:28:41.000Z (about 2 years ago)
- Last Synced: 2024-06-27T17:35:09.301Z (about 2 years ago)
- Topics: data-science, matplotlib, plotting, python, visualization
- Language: Python
- Homepage:
- Size: 30.3 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# mpllegends
Customizable standalone matplotlib legends.
## Installation
For now, only direct download from the [GitHub Repository](https://github.com/jfreissmann/heatpumps) is supported, so just clone it locally or download a ZIP file of the code. If you are using [Miniforge](https://github.com/conda-forge/miniforge), you can create and activate a clean environment like this:
```
conda create -n my_new_env python=3.11
```
```
conda activate my_new_env
```
If you want to build the package locally and install it, you should use these commands from the root directory of the repository:
```
python install flit
```
```
flit buil
```
```
python -m pip install .
```
If you want to use an editable version of the package, e.g. if you want to contribute to the project and test your own changes, skip the commands above and use this one:
```
python -m pip install -e "path/to/the/mpllengends/dir/"
```
## Usage
```python
from mpllegends.entries import Line, Marker, Rectangle
from mpllegends.legend import Legend
legend = Legend(
ncol=3, borderpad=0.5, fontweight='bold', fontsize='large',
columnspacing=1.5
)
legend.add_entry(Line(label='Test Line', color='r'))
legend.add_entry(
Marker(
label='Test Marker', marker='o', markersize=12,
facecolor='b', edgecolor='g'
)
)
legend.add_entry(Rectangle(label='Test Rect', color='#111111'))
legend.create()
legend.save('example_legend.pdf')
legend.save('example_legend.png', dpi=300)
legend.show()
```
## License
See the `LICENSE` file for further information.