{"id":16526242,"url":"https://github.com/sbathgate/article-summarizer","last_synced_at":"2026-04-13T13:32:38.049Z","repository":{"id":49713610,"uuid":"273536608","full_name":"sbathgate/article-summarizer","owner":"sbathgate","description":"Asynchronous RESTful API built with Python and FastAPI. Utilizes Newspaper3k to provide real-time text summarization from a given URL.","archived":false,"fork":false,"pushed_at":"2021-06-10T15:48:36.000Z","size":51,"stargazers_count":2,"open_issues_count":3,"forks_count":1,"subscribers_count":0,"default_branch":"master","last_synced_at":"2025-04-04T20:17:27.389Z","etag":null,"topics":["black","docker","fastapi","flake8","github-actions","heroku","isort","makefile","pytest","python","restful-api","test-driven-development"],"latest_commit_sha":null,"homepage":"http://summarizer.shaunb.ca/docs","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/sbathgate.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2020-06-19T16:14:09.000Z","updated_at":"2022-11-03T22:51:50.000Z","dependencies_parsed_at":"2022-09-13T01:35:18.259Z","dependency_job_id":null,"html_url":"https://github.com/sbathgate/article-summarizer","commit_stats":null,"previous_names":[],"tags_count":1,"template":false,"template_full_name":null,"purl":"pkg:github/sbathgate/article-summarizer","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/sbathgate%2Farticle-summarizer","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/sbathgate%2Farticle-summarizer/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/sbathgate%2Farticle-summarizer/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/sbathgate%2Farticle-summarizer/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/sbathgate","download_url":"https://codeload.github.com/sbathgate/article-summarizer/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/sbathgate%2Farticle-summarizer/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":31754955,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-04-13T13:27:56.013Z","status":"ssl_error","status_checked_at":"2026-04-13T13:21:23.512Z","response_time":93,"last_error":"SSL_connect returned=1 errno=0 peeraddr=140.82.121.5:443 state=error: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"can_crawl_api":true,"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":["black","docker","fastapi","flake8","github-actions","heroku","isort","makefile","pytest","python","restful-api","test-driven-development"],"created_at":"2024-10-11T17:26:45.512Z","updated_at":"2026-04-13T13:32:38.023Z","avatar_url":"https://github.com/sbathgate.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Article Summarizer\r\n\u003e Article Summarizer is an asynchronous RESTful API built with Python and FastAPI. It utilizes Newspaper3k to provide real-time text summarization from a given URL. \r\n\r\n![CI/CD](https://github.com/sbathgate/fastapi-tdd-docker/workflows/CI%20CD/badge.svg?branch=master)\r\n\r\n## Development setup\r\n\r\nFirst, install the system dependencies:\r\n* [docker](https://docs.docker.com/)\r\n* [docker-compose](https://docs.docker.com/compose/)\r\n* [git](https://git-scm.com/)\r\n* [make](https://www.gnu.org/software/make/)\r\n\r\nSecond, download the source code\r\n```sh\r\ngit clone https://github.com/sbathgate/fastapi-tdd-docker.git\r\ncd fastapi-tdd-docker/\r\n```\r\n\r\nThird, build the project image. \r\n```sh\r\nmake build\r\n```\r\n\r\n## Technologies\r\n* Python 3.8\r\n* FastAPI \r\n* PostgreSQL\r\n* Heroku\r\n* Gunicorn \r\n* Tortoise-ORM \r\n* Newspaper3k\r\n* Pytest\r\n* Black \r\n* Flake8\r\n* iSort\r\n\r\n## File Structure\r\n### Within the download you'll find the following directories and files:\r\n```\r\n├── .github\r\n│   └── workflows\r\n│       └── main.yml\r\n├── .gitignore\r\n├── README.md\r\n├── docker-compose.yml\r\n├── makefile\r\n├── project\r\n│   ├── .coverage\r\n│   ├── .coveragerc\r\n│   ├── .dockerignore\r\n│   ├── Dockerfile\r\n│   ├── Dockerfile.prod\r\n│   ├── app\r\n│   │   ├── __init__.py\r\n│   │   ├── api\r\n│   │   │   ├── __init__.py\r\n│   │   │   ├── crud.py\r\n│   │   │   ├── ping.py\r\n│   │   │   └── summaries.py\r\n│   │   ├── config.py\r\n│   │   ├── db.py\r\n│   │   ├── main.py\r\n│   │   ├── models\r\n│   │   │   ├── __init__.py\r\n│   │   │   ├── pydantic.py\r\n│   │   │   └── tortoise.py\r\n│   │   └── summarizer.py\r\n│   ├── db\r\n│   │   ├── Dockerfile\r\n│   │   └── create.sql\r\n│   ├── entrypoint.sh\r\n│   ├── htmlcov\r\n│   ├── requirements-dev.txt\r\n│   ├── requirements.txt\r\n│   ├── setup.cfg\r\n│   └── tests\r\n│       ├── __init__.py\r\n│       ├── conftest.py\r\n│       ├── test_ping.py\r\n│       ├── test_summaries.py\r\n│       └── test_summaries_unit.py\r\n└── release.sh\r\n```\r\n\r\n## Release History\r\n\r\n* 0.1.0\r\n    * Initial release\r\n\r\n## Acknowledgements\r\nThis project wouldn't have been possible without the excellent [Test-Driven Development with FastAPI and Docker course](https://testdriven.io/courses/tdd-fastapi/) developed by [Michael Herman](https://mherman.org/) on [testdriven.io](https://testdriven.io). You can also find a free tutorial on their blog [Developing and Testing an Asynchronous API with FastAPI and Pytest](https://testdriven.io/blog/fastapi-crud/).\r\n\r\n## Contributing\r\n\r\n1. Fork it (\u003chttps://github.com/sbathgate/article-summarizer/fork\u003e)\r\n2. Create your feature branch (`git checkout -b feature/fooBar`)\r\n3. Commit your changes (`git commit -am 'Add some fooBar'`)\r\n4. Push to the branch (`git push origin feature/fooBar`)\r\n5. Create a new Pull Request\r\n\r\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsbathgate%2Farticle-summarizer","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fsbathgate%2Farticle-summarizer","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsbathgate%2Farticle-summarizer/lists"}