Unofficial Inoreader client
Project description
Unofficial Inoreader Client
An async Python client for the Inoreader API that provides easy access to your RSS feeds, subscriptions, and content management.
Features
- Async/await support: built with aiohttp for efficient async operations
- Type safety: full type hints and Pydantic models for data validation
- Easy authentication: automatic API key management
- Tag management: read, star, like, and organize your articles
- Custom tags: create and manage your own tags
Installation
Install directly from GitHub:
pip install git+https://github.com/aryadovoy/inocli.git
Or by uv:
uv add "git+https://github.com/aryadovoy/inocli.git"
Quick Start
1. Setup Configuration
Create a .env file with your Inoreader credentials:
INOREADER_APP_ID=your_app_id
INOREADER_APP_KEY=your_app_key
INOREADER_EMAIL=your_email@example.com
INOREADER_PASSWORD=your_password
2. Basic Usage
import asyncio
from inocli import InoreaderClient, InoreaderConfig
async def main():
# Load configuration from environment variables
config = InoreaderConfig.get()
# Create client (automatically handles authentication)
client = await InoreaderClient.create(config)
try:
# Get user information
user_info = await client.get_user_info()
print(f"Welcome, {user_info.user_name}!")
# Get all subscriptions
subscriptions = await client.get_subscriptions()
print(f"You have {len(subscriptions.subscriptions)} subscriptions")
# Get latest content
content = await client.get_content()
print(f"Found {len(content.items)} items")
finally:
await client.close()
# Run the example
asyncio.run(main())
Inoreader API Documentation
For more details on the Inoreader API, refer to the official documentation: Inoreader API Documentation
License
This project is licensed under the MIT License.
Contributing
Contributions are welcome! Please feel free to submit a Pull Request.
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file inocli-0.2.0.tar.gz.
File metadata
- Download URL: inocli-0.2.0.tar.gz
- Upload date:
- Size: 5.9 kB
- Tags: Source
- Uploaded using Trusted Publishing? Yes
- Uploaded via: uv/0.9.21 {"installer":{"name":"uv","version":"0.9.21","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"24.04","id":"noble","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":true}
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
98db333aac48216a57a9263f4307a1d183a040be9b8d7cf8271a969b39de410a
|
|
| MD5 |
5ef2842634b8788bed652b8a38d2625d
|
|
| BLAKE2b-256 |
6294e9a0ab653f29d7950606d15e693dec3675ec4534f1fd78b4c8c36fe7b757
|
File details
Details for the file inocli-0.2.0-py3-none-any.whl.
File metadata
- Download URL: inocli-0.2.0-py3-none-any.whl
- Upload date:
- Size: 5.7 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? Yes
- Uploaded via: uv/0.9.21 {"installer":{"name":"uv","version":"0.9.21","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"24.04","id":"noble","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":true}
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
942259322538b514912f036cb907e1099ea1b221be39b3efd2222c588b7354a9
|
|
| MD5 |
d88f83fdd96be4192f3547ad7a391f89
|
|
| BLAKE2b-256 |
bf5435db0ba382ca6fd0f281e83520f248be5a69e244201c93af028136a898ab
|