Metadata-Version: 2.4
Name: devanagari-fonts
Version: 0.1.0
Summary: Bundled Devanagari font files with a small Python API for discovery and paths.
Author-email: Nishant Mishrea <nisantamisra00@gmail.com>
License-Expression: MIT
Project-URL: Homepage, https://github.com/nishantaMishra/devanagari-fonts
Project-URL: Repository, https://github.com/nishantaMishra/devanagari-fonts
Project-URL: Issues, https://github.com/nishantaMishra/devanagari-fonts/issues
Keywords: devanagari,fonts,typography,hindi,marathi,sanskrit
Classifier: Development Status :: 3 - Alpha
Classifier: Intended Audience :: Developers
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3 :: Only
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.13
Classifier: Topic :: Multimedia :: Graphics
Classifier: Topic :: Text Processing :: Fonts
Classifier: Typing :: Typed
Requires-Python: >=3.9
Description-Content-Type: text/markdown
License-File: LICENSE
Provides-Extra: dev
Requires-Dist: build>=1.2; extra == "dev"
Requires-Dist: pytest>=8.0; extra == "dev"
Requires-Dist: twine>=5.0; extra == "dev"
Dynamic: license-file

# devanagari-fonts

`devanagari-fonts` bundles Devanagari font files and exposes a small Python API for listing families, locating files, and passing font paths to libraries such as Pillow, Matplotlib, ReportLab, or WeasyPrint.

## Installation

Install from GitHub:

```bash
pip install git+https://github.com/nishantaMishra/devanagari-fonts.git
```

After the package is published to PyPI, it can be installed with:

```bash
pip install devanagari-fonts
```

## Usage

```python
from devanagari_fonts import families, font_path, fonts

print(families())
print(fonts("Hind"))

path = font_path("Hind", style="Regular")
print(path)
```

The package includes `.ttf` and `.otf` font files. Each font family keeps its bundled upstream license file alongside the font files under `devanagari_fonts/fonts/`.

## API

- `families()`: return available font family names.
- `fonts(family=None)`: return `Font` records for all fonts, or for one family.
- `font_files(family=None)`: return filesystem paths for available font files.
- `get_font(family, name=None, style=None)`: return a single matching `Font`.
- `font_path(family, name=None, style=None)`: return the filesystem path for a single matching font.

## License

The Python package code is distributed under the MIT License. Bundled fonts are distributed under their own upstream licenses, included beside each font family.
