Metadata-Version: 2.4
Name: feedwriter
Version: 0.4.0
Summary: Create podcast RSS feeds.
License-Expression: LGPL-3.0-only
Project-URL: Repository, https://github.com/alexbsmith5/feedwriter
Classifier: Programming Language :: Python :: 3
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: Programming Language :: Python :: 3.14
Classifier: Operating System :: OS Independent
Requires-Python: >=3.10
Description-Content-Type: text/markdown
License-File: LICENSE
Dynamic: license-file

# feedwriter

[![tests](https://github.com/alexbsmith5/feedwriter/actions/workflows/tests.yaml/badge.svg)](https://github.com/alexbsmith5/feedwriter/actions/workflows/tests.yaml)
[![PyPI Version](https://img.shields.io/pypi/v/feedwriter)](https://pypi.org/project/feedwriter/)
![PyPI Python Version](https://img.shields.io/pypi/pyversions/feedwriter)

A Python library to generate podcast RSS feeds.

## Supported Clients

This library has functions which are supported on the following podcast players:

- [Apple Podcasts](https://www.apple.com/apple-podcasts/) and players that pull their feeds from the Apple Podcasts Directory.
  - [Overcast](https://overcast.fm/)
  - [Castro](https://castro.fm/)
- [PSP Certified players](https://podstandards.org/)
  - [Pocket Casts](https://pocketcasts.com/)
  - [Podcast Guru](https://podcastguru.io/)
  - [Many more](https://podstandards.org/) (scroll down to "Podcast Players" section)

## Docs

Documentation is found [here](docs/build/markdown/index.md).

I would recommend starting with the [quickstart](#quickstart), and from there going to the [tags page](docs/build/markdown/tags.md) to find the functions for a specific tag.

For more information on the `PodcastFeed` and `Feed` classes, you can find their respective API documentation below:

- [`PodcastFeed`](docs/build/markdown/podcastfeed_api.md)
- [`Feed`](docs/build/markdown/feed_api.md)

## Quickstart

Install `feedwriter` from [pypi](https://pypi.org/project/feedwriter/).

```bash
pip install feedwriter
```

Below is a code snippet with a simple example of how to use the library. The comments should serve as a short explanation of what is being run.

```python
# import class from library
from feedwriter import PodcastFeed

# create PodcastFeed object
feed = PodcastFeed()

# add title of show
feed.title("Example")

# create post with title and guid
feed.new_post(title="Lorem ipsum", guid="1234")

# create empty post and add tags later
feed.new_post()
feed.post_title("Lorem ipsum dolor")
feed.post_duration(1800)

# write object to file
feed.write("feed.xml")
```
