{"id":16509550,"url":"https://github.com/pythonhubdev/owow-backend","last_synced_at":"2025-06-30T02:37:01.630Z","repository":{"id":251256824,"uuid":"836867740","full_name":"pythonhubdev/owow-backend","owner":"pythonhubdev","description":null,"archived":false,"fork":false,"pushed_at":"2024-09-10T13:43:10.000Z","size":1681,"stargazers_count":0,"open_issues_count":1,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-06-25T10:09:54.789Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"CSS","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/pythonhubdev.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,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2024-08-01T18:13:57.000Z","updated_at":"2024-09-10T13:49:56.000Z","dependencies_parsed_at":"2024-09-10T15:08:40.422Z","dependency_job_id":"2c127c57-cc16-42c9-906d-a1f4bd308740","html_url":"https://github.com/pythonhubdev/owow-backend","commit_stats":null,"previous_names":["pythonhubdev/owow-backend"],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/pythonhubdev/owow-backend","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/pythonhubdev%2Fowow-backend","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/pythonhubdev%2Fowow-backend/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/pythonhubdev%2Fowow-backend/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/pythonhubdev%2Fowow-backend/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/pythonhubdev","download_url":"https://codeload.github.com/pythonhubdev/owow-backend/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/pythonhubdev%2Fowow-backend/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":262699862,"owners_count":23350386,"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-11T15:51:06.793Z","updated_at":"2025-06-30T02:37:01.611Z","avatar_url":"https://github.com/pythonhubdev.png","language":"CSS","readme":"# OWOW Backend\n\nA Python backend service that leverages Predibase to extract and summarize key points from PDF, PPT, and DOCX files.\nSeamlessly integrates with your application to provide concise, actionable insights from document contents.\n\n# Run with UV\n\n- Install uv\n```bash\ncurl -sSf https://rye.astral.sh/get | bash\n```\n- Sync Packages\n```bash\nrye sync\n```\n- Run the project\n```bash\nrye run python -m owow_backend\n```\n\n## Docker\n\nYou can start the project with docker using this command:\n\n```bash\ndocker-compose up --build\n```\n\nIf you want to develop in docker with autoreload and exposed ports add `-f deploy/docker-compose.dev.yml` to your docker\ncommand.\nLike this:\n\n```bash\ndocker-compose -f docker-compose.yml -f deploy/docker-compose.dev.yml --project-directory . up --build\n```\n\nThis command exposes the web application on port 8000, mounts current directory and enables autoreload.\n\n```bash\ndocker-compose build\n```\n\n## Project structure\n\n```bash\n$ tree \"owow_backend\"\n1\n├── conftest.py  # Fixtures for all tests.\n├── db  # module contains db configurations\n│   ├── dao  # Data Access Objects. Contains different classes to interact with database.\n│   └── models  # Package contains different models for ORMs.\n├── __main__.py  # Startup script. Starts uvicorn.\n├── settings.py  # Main configuration settings for project.\n├── static  # Static content.\n├── tests  # Tests for project.\n└── web  # Package contains web server. Handlers, startup config.\n    ├── api  # Package with all handlers.\n    │   └── router.py  # Main router.\n    ├── application.py  # FastAPI application configuration.\n    └── lifespan.py  # Contains actions to perform on startup and shutdown.\n```\n\n## Configuration\n\nThis application can be configured with environment variables.\n\nYou can create `.env` file in the root directory and place all\nenvironment variables here.\n\nAn example of .env file:\n\n```bash\nRELOAD=\"True\"\nPORT=\"8000\"\nENVIRONMENT=\"dev\"\n```\n\n## Pre-commit\n\nTo install pre-commit simply run inside the shell:\n\n```bash\npre-commit install\n```\n\npre-commit is very useful to check your code before publishing it.\nIt's configured using .pre-commit-config.yaml file.\n\nBy default, it runs:\n\n* black (formats your code);\n* mypy (validates types);\n* ruff (spots possible bugs);\n\nYou can read more about pre-commit here: https://pre-commit.com/\n\n## Running tests\n\nIf you want to run it in docker, simply run:\n\n```bash\ndocker-compose run --build --rm api pytest -vv .\ndocker-compose down\n```\n\n1. Run the pytest.\n\n```bash\npytest -vv .\n```\n","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fpythonhubdev%2Fowow-backend","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fpythonhubdev%2Fowow-backend","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fpythonhubdev%2Fowow-backend/lists"}