{"id":16318115,"url":"https://github.com/scorphus/rss-reader","last_synced_at":"2025-05-13T17:16:06.296Z","repository":{"id":208615584,"uuid":"718839584","full_name":"scorphus/rss-reader","owner":"scorphus","description":null,"archived":false,"fork":false,"pushed_at":"2023-11-22T10:19:20.000Z","size":29,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":2,"default_branch":"main","last_synced_at":"2025-02-16T20:28:01.017Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"bsd-3-clause","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/scorphus.png","metadata":{"files":{"readme":"README.md","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}},"created_at":"2023-11-14T22:33:38.000Z","updated_at":"2023-11-22T10:27:55.000Z","dependencies_parsed_at":"2023-11-22T12:42:38.704Z","dependency_job_id":null,"html_url":"https://github.com/scorphus/rss-reader","commit_stats":null,"previous_names":["scorphus/rss-reader"],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/scorphus%2Frss-reader","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/scorphus%2Frss-reader/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/scorphus%2Frss-reader/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/scorphus%2Frss-reader/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/scorphus","download_url":"https://codeload.github.com/scorphus/rss-reader/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":253990503,"owners_count":21995776,"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-10-10T22:10:00.836Z","updated_at":"2025-05-13T17:16:06.265Z","avatar_url":"https://github.com/scorphus.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"# rss-reader [![Build Status][build-badge]][action-link] [![Coverage Status][codecov-badge]][codecov-link] [![Maintainability][codeclimate-badge]][codeclimate-link] [![Code Quality][codacy-badge]][codacy-link]\n\nrss-reader provides an API to serve users with RSS feeds.\n\n## Installation\n\nTo install, follow these steps:\n\n1.  Create a Python virtual environment using your preferred choice ([pyenv][]\n    is recommended)\n2.  With the recently created virtual environment activated, install the package\n    with the following command:\n\n    ```shell\n    make setup\n    ```\n\n\u003e _Note: rss-reader requires Python 3.10 or newer._\n\n## Database\n\nrss-reader uses PostgreSQL to store its date. Provide the database connection\nURL via the `RSS_READER_DATABASE_URL` environment variable. For instance:\n\n```\nexport RSS_READER_DATABASE_URL=\"postgresql://postgres:postgres@localhost:5432/rss_reader\"\n```\n\nThen proceed to create the tables:\n\n```shell\nmake create-tables\n```\n\n## Running locally\n\nOnce the package is installed, run the API with the following:\n\n```shell\nmake run\n```\n\nOr with debug level logging:\n\n```shell\nLOG_LEVEL=DEBUG make run\n```\n\nThe API should be available at http://localhost:8000\n\n## Accessing the API\n\nThe API documentation is available at http://localhost:8000/docs and provides\ndetails on how to interact with the API.\n\n## Running tests\n\n1. Run tests with:\n    ```shell\n    make test\n    ```\n2. And check code coverage with:\n    ```shell\n    make coverage\n    open htmlcov/index.html\n    ```\n\n## Extra\n\n1. To see all available make targets:\n    ```shell\n    make list\n    ```\n\n[pyenv]: https://github.com/pyenv/pyenv\n\n## License\n\nCode in this repository is distributed under the terms of the BSD 3-Clause\nLicense (BSD-3-Clause).\n\nSee [LICENSE][] for details.\n\n[build-badge]: https://github.com/scorphus/rss-reader/workflows/Python/badge.svg\n[action-link]: https://github.com/scorphus/rss-reader/actions?query=workflow%3APython\n[codecov-badge]: https://codecov.io/gh/scorphus/rss-reader/graph/badge.svg?token=MD0pKnNybT\n[codecov-link]: https://codecov.io/gh/scorphus/rss-reader\n[codeclimate-badge]: https://api.codeclimate.com/v1/badges/cde7b675db4cca078ee1/maintainability\n[codeclimate-link]: https://codeclimate.com/github/scorphus/rss-reader/maintainability\n[codacy-badge]: https://app.codacy.com/project/badge/Grade/c683c6cc5fa14aecb600c4e37a1285f9\n[codacy-link]: https://app.codacy.com/gh/scorphus/rss-reader/dashboard?utm_source=gh\u0026utm_medium=referral\u0026utm_content=\u0026utm_campaign=Badge_grade\n[LICENSE]: LICENSE\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fscorphus%2Frss-reader","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fscorphus%2Frss-reader","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fscorphus%2Frss-reader/lists"}