yay

Author: sctech-tr

README.md

@@ -1,2 +1,176 @@
 # rsstools
-tools for managing rss feeds in python
+
+A powerful Python tool for creating, editing, and managing RSS feeds with both programmatic and command-line interfaces.
+
+## Features
+
+- Create new RSS feeds with all required elements
+- Add, update, and remove items from feeds
+- Load and save RSS feeds to XML files
+- Validate feed structure and required elements
+- Command-line interface for easy management
+- Support for optional elements like author and publication date
+- JSON export capability for feed items
+
+## Installation
+
+### Dependencies
+
+First, ensure you have Python 3.7 or higher installed. This package requires the following dependencies:
+
+```
+click>=8.0.0
+```
+
+### Installing via pip (recommended)
+
+1. Run this command:
+```bash
+pip install rsstools
+```
+
+### Installing via pyz
+
+1. Download the latest pyz from the releases tab.
+2. Run:
+
+```bash
+pip install rsstools.pyz
+```
+
+### Installing from source
+
+This package requires the following dependencies:
+```
+click>=8.0.0
+```
+
+1. Clone the repository:
+```bash
+git clone https://github.com/sctech-tr/rsstools.git
+cd rsstools
+```
+
+2. Install the package:
+```bash
+pip install .
+```
+
+## Usage
+
+### Command Line Interface
+
+1. Create a new RSS feed:
+```bash
+rsstools create -t "My Blog" -l "https://myblog.com" -d "My personal blog" -o feed.xml
+```
+
+2. Add an item to the feed:
+```bash
+rsstools add feed.xml \
+-t "First Post" \
+-l "https://myblog.com/first" \
+-d "My first post" \
+-a "John Doe" \
+-p "2024-10-18T12:00:00"
+```
+
+3. List all items in a feed:
+```bash
+rsstools list feed.xml
+```
+
+4. Export items to JSON:
+```bash
+rsstools list feed.xml -o items.json
+```
+
+5. Update an item:
+```bash
+rsstools update feed.xml "https://myblog.com/first" -t "Updated Post Title"
+```
+
+6. Remove an item:
+```bash
+rsstools remove feed.xml "https://myblog.com/first"
+```
+
+### Python API
+
+```python
+
+from rsstools import RSSFeedCreator
+from datetime import datetime
+
+# Create a new feed
+feed = RSSFeedCreator(
+    title="My Blog",
+    link="https://myblog.com",
+    description="My personal blog about technology"
+)
+
+# Add an item
+feed.add_item(
+    title="First Post",
+    link="https://myblog.com/first-post",
+    description="This is my first blog post",
+    author="John Doe",
+    pub_date=datetime.now()
+)
+
+# Save the feed
+feed.save("blog_feed.xml")
+
+# Load an existing feed
+feed.load("blog_feed.xml")
+
+# Update an item
+feed.update_item(
+    guid="https://myblog.com/first-post",
+    title="Updated First Post"
+)
+
+# Remove an item
+feed.remove_item(guid="https://myblog.com/first-post")
+
+# Get all items
+items = feed.get_items()
+```
+
+## Contributing
+
+1. Fork the repository
+2. Open a PR
+
+## License
+
+This project is licensed under the GPL-3.0 License - see the LICENSE file for details.
+
+## Error Handling
+
+The package uses custom exceptions (`RSSToolsError`) for error handling. Always wrap your code in try-except blocks when using the API:
+
+```python
+from rsstools import RSSFeedCreator, RSSToolsError
+
+try:
+    feed = RSSFeedCreator("My Blog", "https://myblog.com", "My blog description")
+    feed.save("feed.xml")
+except RSSToolsError as e:
+    print(f"Error: {str(e)}")
+```
+
+## Common Issues and Solutions
+
+1. **Invalid Feed Structure**: Ensure your RSS feed follows the standard RSS 2.0 format.
+2. **File Permissions**: Make sure you have write permissions in the directory where you're saving the feed.
+3. **Date Format**: When using the CLI, provide dates in ISO format (YYYY-MM-DDTHH:MM:SS).
+
+## Getting Help
+
+Use the `--help` flag with any command to see available options:
+```bash
+rsstools --help
+rsstools create --help
+rsstools add --help
+```

pyproject.toml

@@ -0,0 +1,3 @@
+[build-system]
+requires = ["setuptools", "wheel"]
+build-backend = "setuptools.build_meta

rsstools/__init__.py

@@ -0,0 +1,5 @@
+from .feed_creator import RSSFeedCreator
+from .exceptions import RSSToolsError
+
+__version__ = "0.1.0"
+__all__ = ["RSSFeedCreator", "RSSToolsError"]

rsstools/__main__.py

@@ -0,0 +1,4 @@
+from rsstools.cli import main
+
+if __name__ == '__main__':
+    main()

rsstools/cli.py

@@ -0,0 +1,127 @@
+import click
+import json
+from datetime import datetime
+from .feed_creator import RSSFeedCreator
+from .exceptions import RSSToolsError
+
+@click.group()
+def cli():
+    """RSS Feed Creator and Editor - Create and manage RSS feeds easily."""
+    pass
+
+@cli.command()
+@click.option('--title', '-t', required=True, help='Feed title')
+@click.option('--link', '-l', required=True, help='Feed link')
+@click.option('--description', '-d', required=True, help='Feed description')
+@click.option('--output', '-o', required=True, help='Output file path')
+def create(title, link, description, output):
+    """Create a new RSS feed."""
+    try:
+        feed = RSSFeedCreator(title, link, description)
+        feed.save(output)
+        click.echo(f"Successfully created RSS feed: {output}")
+    except RSSToolsError as e:
+        click.echo(f"Error: {str(e)}", err=True)
+
+@cli.command()
+@click.argument('feed_file')
+@click.option('--title', '-t', required=True, help='Item title')
+@click.option('--link', '-l', required=True, help='Item link')
+@click.option('--description', '-d', required=True, help='Item description')
+@click.option('--author', '-a', help='Item author')
+@click.option('--pub-date', '-p', help='Publication date (ISO format)')
+def add(feed_file, title, link, description, author, pub_date):
+    """Add a new item to an RSS feed."""
+    try:
+        feed = RSSFeedCreator("", "", "")
+        feed.load(feed_file)
+        
+        pub_date_obj = None
+        if pub_date:
+            pub_date_obj = datetime.fromisoformat(pub_date)
+            
+        feed.add_item(
+            title=title,
+            link=link,
+            description=description,
+            author=author,
+            pub_date=pub_date_obj
+        )
+        
+        feed.save(feed_file)
+        click.echo(f"Successfully added item to feed: {title}")
+    except RSSToolsError as e:
+        click.echo(f"Error: {str(e)}", err=True)
+
+@cli.command()
+@click.argument('feed_file')
+@click.argument('guid')
+def remove(feed_file, guid):
+    """Remove an item from an RSS feed by its GUID."""
+    try:
+        feed = RSSFeedCreator("", "", "")
+        feed.load(feed_file)
+        
+        if feed.remove_item(guid):
+            feed.save(feed_file)
+            click.echo(f"Successfully removed item with GUID: {guid}")
+        else:
+            click.echo(f"Item with GUID {guid} not found")
+    except RSSToolsError as e:
+        click.echo(f"Error: {str(e)}", err=True)
+
+@cli.command()
+@click.argument('feed_file')
+@click.argument('guid')
+@click.option('--title', '-t', help='New title')
+@click.option('--link', '-l', help='New link')
+@click.option('--description', '-d', help='New description')
+@click.option('--author', '-a', help='New author')
+def update(feed_file, guid, title, link, description, author):
+    """Update an item in the RSS feed."""
+    try:
+        feed = RSSFeedCreator("", "", "")
+        feed.load(feed_file)
+        
+        updates = {}
+        if title:
+            updates['title'] = title
+        if link:
+            updates['link'] = link
+        if description:
+            updates['description'] = description
+        if author:
+            updates['author'] = author
+            
+        if feed.update_item(guid, **updates):
+            feed.save(feed_file)
+            click.echo(f"Successfully updated item with GUID: {guid}")
+        else:
+            click.echo(f"Item with GUID {guid} not found")
+    except RSSToolsError as e:
+        click.echo(f"Error: {str(e)}", err=True)
+
+@cli.command()
+@click.argument('feed_file')
+@click.option('--output', '-o', help='Output JSON file (optional)')
+def list(feed_file, output):
+    """List all items in an RSS feed."""
+    try:
+        feed = RSSFeedCreator("", "", "")
+        feed.load(feed_file)
+        items = feed.get_items()
+        
+        if output:
+            with open(output, 'w') as f:
+                json.dump(items, f, indent=2)
+            click.echo(f"Items exported to: {output}")
+        else:
+            for item in items:
+                click.echo("\n--- Item ---")
+                for key, value in item.items():
+                    click.echo(f"{key}: {value}")
+    except RSSToolsError as e:
+        click.echo(f"Error: {str(e)}", err=True)
+
+def main():
+    cli()

rsstools/exceptions.py

@@ -0,0 +1,3 @@
+class RSSToolsError(Exception):
+    """Base exception for RSSTools."""
+    pass