{"id":16177879,"url":"https://github.com/hifly81/hirss","last_synced_at":"2025-04-07T11:28:35.036Z","repository":{"id":68321743,"uuid":"402326854","full_name":"hifly81/hirss","owner":"hifly81","description":"Transform web contents in RSS feeds","archived":false,"fork":false,"pushed_at":"2024-01-29T11:37:34.000Z","size":18,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":2,"default_branch":"main","last_synced_at":"2025-02-13T14:17:24.529Z","etag":null,"topics":["apache-commons","jetty","jsoup","pf4j","rss","rss-aggregator","rss-feed","rss-feed-parser","rss-generator","scraping-websites"],"latest_commit_sha":null,"homepage":"","language":"Java","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/hifly81.png","metadata":{"files":{"readme":"README.adoc","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"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":"2021-09-02T07:16:43.000Z","updated_at":"2024-01-29T11:39:26.000Z","dependencies_parsed_at":"2024-10-10T05:20:21.951Z","dependency_job_id":"392eb18a-03fd-418c-b891-ae36c17932cd","html_url":"https://github.com/hifly81/hirss","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/hifly81%2Fhirss","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/hifly81%2Fhirss/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/hifly81%2Fhirss/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/hifly81%2Fhirss/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/hifly81","download_url":"https://codeload.github.com/hifly81/hirss/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":247643033,"owners_count":20972021,"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":["apache-commons","jetty","jsoup","pf4j","rss","rss-aggregator","rss-feed","rss-feed-parser","rss-generator","scraping-websites"],"created_at":"2024-10-10T05:11:01.339Z","updated_at":"2025-04-07T11:28:35.003Z","avatar_url":"https://github.com/hifly81.png","language":"Java","funding_links":[],"categories":[],"sub_categories":[],"readme":"= Transform documents in RSS feeds\n\nhirss allows to transform no RSS documents/info in rss feeds\n\n== Compile\n\nYou need _Apache Maven version 3.x_\n\nFrom root directory open a terminal and execute:\n\n[source,bash]\n----\nmvn clean compile assembly:single\n----\n\nA jar file, _hirss-1.0.jar_ will be created in _target/_ folder.\n\n== Run\n\nOpen a terminal and execute:\n\n[source,bash]\n----\njava -jar target/hirss-1.0.jar\n----\n\nA new HTTP Server listening by default on port _1225_ will start and, depending on the plugins created,\nRSS XML files will be generated in _$HOME/.hirss/rss_ folder\n\nJust add the name of the rss feed (file) generated inside _$HOME/.hirss/rss_ folder in your rss feed reader;\n\nexample: _http://127.0.0.1:1225/b10a8db164e0754105b7a99be72e3fe5_\n\n== Configuration\n\nConfiguration is defined in _hirss.properties_; you can override these parameters:\n\n[source,bash]\n----\n#binding address of HTTP Server\nbinding_address=127.0.0.1\n#binding port of HTTP Server\nport=1225\n#max concurrent HTTP request\nmax_threads=50\n#default folder where RSS XML are generated\nrss_folder=.hirss/rss\n#interval in milliseconds to upload the RSS\nrss_update_period=5000\n#timeout in seconds to establish a connection to the source\nrss_connect_timeout=25000\n\n----\n\n== Plugin\n\nYou can create plugins simply adding a java class annotated with _@Extension_ and implementing the interface _SimpleRssDoc_.\n\n@Extension\n\n[source,java]\n----\npublic class HelloWorld implements SimpleRssDoc {\n    .....\n}\n----\n\nYour class must fetch data from somewhere (web scraping as an example) and returning an instance of java object _org.hifly.hirss.model.Rss_\n\nFor an example look at the definition of class _plugin/HelloWorld.java_\n\nAfter creating your plugin simply recompile the entire project and run it.\n\nThe plugin will be automatically discovered and a new RSS XML file will be generated with your feeds.\n\n== Third-Party Libraries\n\n - pf4j : https://github.com/decebals/pf4j\n - jsoup: http://jsoup.org\n - ROME: http://rometools.github.io/rome\n - jetty: http://eclipse.org/jetty\n - apache commons: http://commons.apache.org\n - apache commons codec: http://commons.apache.org/proper/commons-codec\n - slf4j: http://www.slf4j.org","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fhifly81%2Fhirss","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fhifly81%2Fhirss","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fhifly81%2Fhirss/lists"}