{"id":21008162,"url":"https://github.com/ediwang/syndicationfeedreaderwriter","last_synced_at":"2025-05-15T02:31:53.574Z","repository":{"id":174588326,"uuid":"652446905","full_name":"EdiWang/SyndicationFeedReaderWriter","owner":"EdiWang","description":"Continue to maintain dotnet/SyndicationFeedReaderWriter","archived":false,"fork":false,"pushed_at":"2024-11-13T01:45:48.000Z","size":457,"stargazers_count":5,"open_issues_count":0,"forks_count":1,"subscribers_count":2,"default_branch":"master","last_synced_at":"2024-11-13T02:30:48.129Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"C#","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/EdiWang.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":"CODE-OF-CONDUCT.md","threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2023-06-12T05:15:24.000Z","updated_at":"2024-11-13T01:45:52.000Z","dependencies_parsed_at":"2024-11-13T03:15:30.907Z","dependency_job_id":null,"html_url":"https://github.com/EdiWang/SyndicationFeedReaderWriter","commit_stats":null,"previous_names":["ediwang/syndicationfeedreaderwriter"],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/EdiWang%2FSyndicationFeedReaderWriter","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/EdiWang%2FSyndicationFeedReaderWriter/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/EdiWang%2FSyndicationFeedReaderWriter/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/EdiWang%2FSyndicationFeedReaderWriter/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/EdiWang","download_url":"https://codeload.github.com/EdiWang/SyndicationFeedReaderWriter/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":225324165,"owners_count":17456460,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-11-19T09:11:42.785Z","updated_at":"2025-05-15T02:31:53.568Z","avatar_url":"https://github.com/EdiWang.png","language":"C#","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Edi.SyndicationFeed.ReaderWriter\n\n[![.NET Build and Pack](https://github.com/EdiWang/SyndicationFeedReaderWriter/actions/workflows/dotnet.yml/badge.svg)](https://github.com/EdiWang/SyndicationFeedReaderWriter/actions/workflows/dotnet.yml)\n\n\u003e The original repo https://github.com/dotnet/SyndicationFeedReaderWriter was archived long time ago. I created this repo to continue maintain the project.\n\n`Edi.SyndicationFeed.ReaderWriter` (original `Microsoft.SyndicationFeed.ReaderWriter`) provides lightweight forward-only read/write APIs (similar to .NET XmlReader) to simplify operations with RSS 2.0 ([spec](http://cyber.harvard.edu/rss/rss.html)) and Atom ([spec](https://tools.ietf.org/html/rfc4287)) syndication feeds. It offers extensiblity to support custom feed elements and formatting. The workflow is async on demand, which enables this library to be used on syndication feeds of arbitrary size or stream latency.\n\n### Requirements:\n* [Visual Studio 2022](https://www.visualstudio.com/vs/whatsnew/)\n\n### Supports:\n* .NET 8.0\n* .NET 9.0\n\n### Building:\n* The solution will build in Visual Studio 2022 after cloning.\n\n### Running Tests:\n* Open the solution in Visual Studio 2022.\n* Build the Tests project.\n* Open the Test Explorer and click \"Run All\" or run each test individually.\n\n# Examples\nExamples can be found [here](examples).\n\n### Create an RssReader and Read a Feed ###\n```cs\nusing (var xmlReader = XmlReader.Create(filePath, new XmlReaderSettings() { Async = true }))\n{\n    var feedReader = new RssFeedReader(xmlReader);\n\n    while(await feedReader.Read())\n    {\n        switch (feedReader.ElementType)\n        {\n            // Read category\n            case SyndicationElementType.Category:\n                ISyndicationCategory category = await feedReader.ReadCategory();\n                break;\n\n            // Read Image\n            case SyndicationElementType.Image:\n                ISyndicationImage image = await feedReader.ReadImage();\n                break;\n\n            // Read Item\n            case SyndicationElementType.Item:\n                ISyndicationItem item = await feedReader.ReadItem();\n                break;\n\n            // Read link\n            case SyndicationElementType.Link:\n                ISyndicationLink link = await feedReader.ReadLink();\n                break;\n\n            // Read Person\n            case SyndicationElementType.Person:\n                ISyndicationPerson person = await feedReader.ReadPerson();\n                break;\n\n            // Read content\n            default:\n                ISyndicationContent content = await feedReader.ReadContent();\n                break;\n        }\n    }\n}\n```\n\n### Create an RssWriter and Write an Rss Item ###\n```cs\nvar sw = new StringWriterWithEncoding(Encoding.UTF8);\n\nusing (XmlWriter xmlWriter = XmlWriter.Create(sw, new XmlWriterSettings() { Async = true, Indent = true }))\n{\n    var writer = new RssFeedWriter(xmlWriter);\n      \n    // Create item\n    var item = new SyndicationItem()\n    {\n        Title = \"Rss Writer Avaliable\",\n        Description = \"The new Rss Writer is now available as a NuGet Package!\",\n        Id = \"https://www.nuget.org/packages/Microsoft.SyndicationFeed.ReaderWriter\",\n        Published = DateTimeOffset.UtcNow\n    };\n\n    item.AddCategory(new SyndicationCategory(\"Technology\"));\n    item.AddContributor(new SyndicationPerson(\"test\", \"test@mail.com\"));\n\n    await writer.Write(item);\n    xmlWriter.Flush();\n}\n\nclass StringWriterWithEncoding : StringWriter\n{\n    private readonly Encoding _encoding;\n\n    public StringWriterWithEncoding(Encoding encoding)\n    {\n        this._encoding = encoding;\n    }\n\n    public override Encoding Encoding {\n        get { return _encoding; }\n    }\n}\n```\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fediwang%2Fsyndicationfeedreaderwriter","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fediwang%2Fsyndicationfeedreaderwriter","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fediwang%2Fsyndicationfeedreaderwriter/lists"}