{"id":22957080,"url":"https://github.com/kenmwaura1/python_news_updates","last_synced_at":"2026-05-10T05:14:15.019Z","repository":{"id":100856021,"uuid":"405026867","full_name":"KenMwaura1/Python_News_Updates","owner":"KenMwaura1","description":"A flask application that will help people list and preview news articles from various sources. Using the News Api","archived":false,"fork":false,"pushed_at":"2023-08-25T12:59:34.000Z","size":1950,"stargazers_count":2,"open_issues_count":1,"forks_count":0,"subscribers_count":2,"default_branch":"main","last_synced_at":"2025-02-07T16:39:17.314Z","etag":null,"topics":["bootstrap","flask","python-3"],"latest_commit_sha":null,"homepage":"https://zoo-news.herokuapp.com/","language":"Python","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/KenMwaura1.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,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2021-09-10T09:30:31.000Z","updated_at":"2023-08-20T08:23:55.000Z","dependencies_parsed_at":"2025-02-07T16:32:41.115Z","dependency_job_id":"be1d8d37-bb48-44ff-bacd-0ffc796501ec","html_url":"https://github.com/KenMwaura1/Python_News_Updates","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/KenMwaura1%2FPython_News_Updates","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/KenMwaura1%2FPython_News_Updates/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/KenMwaura1%2FPython_News_Updates/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/KenMwaura1%2FPython_News_Updates/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/KenMwaura1","download_url":"https://codeload.github.com/KenMwaura1/Python_News_Updates/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":246739084,"owners_count":20825880,"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":["bootstrap","flask","python-3"],"created_at":"2024-12-14T17:15:13.867Z","updated_at":"2026-05-10T05:14:14.935Z","avatar_url":"https://github.com/KenMwaura1.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Python_News_Updates\n[![forthebadge made-with-python](http://ForTheBadge.com/images/badges/made-with-python.svg)](https://www.python.org/)\n\nThis is a flask application that will help people list and preview news articles from various sources. Using the News Api\n\n![logo](app/static/images/Zoo-News.png)\n\n## Project Objectives\n\n* Your project should contain two models, one for the news source and one for the news article.\n* Your project must use views and routes.\n* Your project should consume the News API.\n* Your project must contain request(s) to the News API.\n* Your project should follow the proper folder structure.\n* Your application should be deployed to Heroku.\n\n## Technical Requirements\n\n1. The project should have a specs markdown file that displays the project's specifications. :heavy_check_mark:\n2. The model classes should have unittests to check for behaviour. The tests should pass. :heavy_check_mark:\n3. The project needs to be deployed to Heroku. :heavy_check_mark:\n4. The project should have clear commit messages. :heavy_check_mark:\n5. The project should be polished in a portfolio-quality state. :heavy_check_mark:\n\n## Showcase\n![screenshot of app running](app/static/images/Screenshot_113.png)\n\n## Live Site\n[link to deployed site](https://zoo-news.herokuapp.com/)\n\n## Setup Instructions / Installation\n### Getting Started\nThis app utilizes the [News API](https://newsapi.org/) to retrieve news sources and articles. \nInorder to properly run this app: \n 1. Go to [News API](https://newsapi.org) and create an account or login.\n 2. Get your Api key\n### Prerequisites \n- Python and pip (I am currently using 3.9.6) Any version above 3.5 should work.\n- News Api key \n- Git installed on your machine \n- Code editor/ IDE \n### Installation and Running the App\n1. Clone GitHub repository\n    ```shell\n    git clone https://github.com/KenMwaura1/Python_News_Updates\n    ```\n2. Change into the folder\n    ```shell\n   cd Python_News_Updates\n    ```\n3. Create a virtual environment\n   ```shell\n      python3 -m venv venv \n   ```\n   - Activate the virtual environment\n\n     `source ./bin/activate`\n\n   * If you are using [pyenv](https://github.com/pyenv/pyenv)\n\n      3a. Create a virtualenv\n   \n      ```\n          pyenv virtualenv python_news_updates\n      ```\n      3b. Activate the virtualenv\n   \n      ```\n      pyenv activate python_news_updates\n      ```\n4. Create a `.env` file and add your credentials\n\n   ```\n   touch .env \n   ```\n\n    OR Copy the included example\n    \n    ``` \n    cp .env-example .env \n    ```\n5. Add your credentials to the `.env` file\n6. Install the required dependencies\n   ```shell\n   pip install -r requirements.txt\n   ```\n7. Make the shell script executable\n    ```shell\n   chmod a+x ./start.sh\n    ```\n8. Run the app\n    ```shell\n   ./start.sh\n    ```\n   OR \n    run with the [flask-cli](https://flask.palletsprojects.com/en/2.0.x/cli/)\n    ```shell\n   flask run\n    ```\n\n## Tests \n* To run the tests:\n    ```shell \n  flask tests\n    ```\n\n## Technologies used\n\n* Python-3.9.6\n* Flask web framework\n* Bootstrap(Material Bootstrap 4)\n* HTML5\n* CSS3\n\n## Author\n\n[Ken Mwaura](https://github.com/KenMwaura1)\n\n## LICENSE\n\nMIT License\n\nCopyright (c) 2021 Kennedy Ngugi Mwaura\n\nPermission is hereby granted, free of charge, to any person obtaining a copy\nof this software and associated documentation files (the \"Software\"), to deal\nin the Software without restriction, including without limitation the rights\nto use, copy, modify, merge, publish, distribute, sublicense, and/or sell\ncopies of the Software, and to permit persons to whom the Software is\nfurnished to do so.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fkenmwaura1%2Fpython_news_updates","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fkenmwaura1%2Fpython_news_updates","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fkenmwaura1%2Fpython_news_updates/lists"}