freshrss-api 1.0.1

Easy to use python api to get data from FreshRSS

FreshRSS Python API Client

A Python client for interacting with the FreshRSS Fever API. This library provides an easy-to-use interface for fetching items, marking items as read/unread, and managing feeds and categories in your FreshRSS instance.

Features

• Authentication: Securely authenticate with your FreshRSS instance using your username and API password or environment variables.
• Item Management: Fetch all items, unread items, or saved items. Mark items as read or unread.
• Feeds & Groups: Retrieve all feeds and groups (categories) from your FreshRSS instance.
• Pagination: Efficiently fetch large numbers of items with pagination and customizable timeouts.
• Type Safety: Optional type checking with beartype for improved code reliability.
• Environment Variables: Configure the client using environment variables for easier integration with CI/CD pipelines and containerized environments.

Installation

You can install the FreshRSS API client via pip:

pip install freshrss-api

Usage

Environment Variables

The FreshRSS API client supports the following environment variables:

• FRESHRSS_PYTHON_API_HOST: Your FreshRSS instance URL (e.g., "https://freshrss.example.net")
• FRESHRSS_PYTHON_API_USERNAME: Your FreshRSS username
• FRESHRSS_PYTHON_API_PASSWORD: Your FreshRSS API password
• FRESHRSS_PYTHON_API_VERIFY_SSL: Whether to verify SSL certificates ("true", "1", "yes" for True, anything else for False)

These environment variables can be used instead of passing parameters directly to the constructor.

Initialization

To start using the FreshRSS API client, initialize it with your FreshRSS instance URL, username, and API password.

from freshrss_api import FreshRSSAPI

# Initialize the client with direct parameters
client = FreshRSSAPI(
    host="https://freshrss.example.net",
    username="your_username",
    password="your_api_password"
)

# Or use environment variables
# export FRESHRSS_PYTHON_API_HOST="https://freshrss.example.net"
# export FRESHRSS_PYTHON_API_USERNAME="your_username"
# export FRESHRSS_PYTHON_API_PASSWORD="your_api_password"
# export FRESHRSS_PYTHON_API_VERIFY_SSL="true"
client = FreshRSSAPI()  # Will use environment variables

Fetching Items

You can fetch all items, unread items, or saved items using the appropriate methods.

# Fetch all items
all_items = client.get_all_items()

# Fetch unread items
unread_items = client.get_unreads()

# Fetch saved items
saved_items = client.get_saved()

Marking Items

Mark items as read or unread using the set_mark method.

# Mark an item as read
client.set_mark(as_="read", id=12345)

# Mark an item as unread
client.set_mark(as_="unread", id=12345)

Managing Feeds and Groups

Fetch all feeds or groups (categories) from your FreshRSS instance.

# Get all feeds
feeds = client.get_feeds()

# Get all groups
groups = client.get_groups()

Pagination and Timeouts

When fetching large numbers of items, you can control the timeout and maximum number of items fetched.

# Fetch up to 1000 items with a timeout of 60 seconds
items = client.get_all_items(timeout=60, n_max=1000, verbose=True)

API Details

This library interacts with the FreshRSS Fever API, which is a simplified API for mobile access and third-party integrations. The API endpoints are well-documented and provide access to most features of FreshRSS.

For more details on the Fever API, refer to the official documentation.

License

This project is licensed under the GNU General Public License v3.0 (GPLv3). See the LICENSE file for more details.

Contributing

Contributions are welcome! Please open an issue or submit a pull request if you have any improvements or bug fixes.

Acknowledgements

This project was inspired by the need for a simple and reliable Python client for the FreshRSS Fever API. Thanks to the FreshRSS team for their work on this excellent RSS aggregator!

Contact

For any questions or issues, please open an issue on GitHub.