Metadata-Version: 2.4
Name: bykml
Version: 1.6.0
Summary: the bykml library
Author-email: Byron - Lloyd Wakeman <lloydwakemanbyron@gmail.com>
License: Copyright © 2024 bykml
        
        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.
Keywords: feed,bykml,tutorial
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3
Requires-Python: >=3.9
Description-Content-Type: text/markdown
License-File: LICENCE
Requires-Dist: xmltodict
Provides-Extra: dev
Requires-Dist: build; extra == "dev"
Requires-Dist: pytest; extra == "dev"
Requires-Dist: ruff; extra == "dev"
Requires-Dist: python-semantic-release; extra == "dev"
Dynamic: license-file

## Introduction

**bykml** is a library for reading, writing, and updating KML files.
It uses dictionaries to make replacing values and adding KML elements simple.

## Documentation

The `kmlfactory` module inside the `bykml` package provides:

- `KmlFactory` class
- `placemark_template` function

These are used to create placemarks and add them to a KML structure.

## Install

```bash
pip install bykml
```

## Dependencies

- [xmltodict](https://pypi.org/project/xmltodict/)

## Limitations

Because Python dictionaries can only hold one value per key, lists must be used when a KML tag needs multiple child items.

For example, a `Folder` containing multiple placemarks must represent those placemarks as a list.
Support for more flexible nested structures is currently under review.

For release history, see [CHANGELOG.md](./CHANGELOG.md).
