{"id":21318991,"url":"https://github.com/emingenc/financial_app","last_synced_at":"2025-03-15T22:15:21.568Z","repository":{"id":198851889,"uuid":"701678717","full_name":"emingenc/financial_app","owner":"emingenc","description":null,"archived":false,"fork":false,"pushed_at":"2023-10-16T01:25:18.000Z","size":72,"stargazers_count":0,"open_issues_count":0,"forks_count":1,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-01-22T11:13:36.968Z","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":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/emingenc.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":"2023-10-07T08:44:40.000Z","updated_at":"2023-10-07T14:49:50.000Z","dependencies_parsed_at":null,"dependency_job_id":"c6a851e3-5779-4bca-9f6c-1367be5f8d41","html_url":"https://github.com/emingenc/financial_app","commit_stats":null,"previous_names":["emingenc/financial_app"],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/emingenc%2Ffinancial_app","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/emingenc%2Ffinancial_app/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/emingenc%2Ffinancial_app/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/emingenc%2Ffinancial_app/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/emingenc","download_url":"https://codeload.github.com/emingenc/financial_app/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":243796741,"owners_count":20349264,"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-11-21T19:30:54.601Z","updated_at":"2025-03-15T22:15:21.548Z","avatar_url":"https://github.com/emingenc.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"Configuration\n--------------\n\nReplace `.env.example` with real `.env`, changing placeholders\n\n```\nSECRET_KEY=changeme\nPOSTGRES_PORT=5432\nPOSTGRES_DB=financial_record\nPOSTGRES_PASSWORD=postgres\nPOSTGRES_USER=postgres\nDATABASE_URL=postgresql://postgres:postgres@localhost:5432/financial_record\n```\n\nRun in Docker\n-------------\n\n### !! Note:\n\nIf you want to run app in `Docker`, change host in `DATABASE_URL` in `.env` file to name of docker db service:\n\n`DATABASE_URL=postgresql://postgres:postgres@db:5432/financial_record`\n\nRun project in Docker:\n\n    $ make docker_build\n\nor \n\n    $ docker-compose up --build\n\n\nStop project in Docker:\n\n    $ make docker_down\n\n\n\nWeb routes\n----------\nAll routes are available on ``/`` or ``/redoc`` paths with Swagger or ReDoc.\n\n\nCase steps\n----------\n\nafter docker-compose up  go to http://localhost:5001 to swagger ui\n\n1. Create user with /api/v1/user/create-user endpoint\n2. Login with /api/v1/user/login endpoint\n3. add financial records with upload endpoint /api/v1/financial-records/upload with file 04-01-Financial Sample Data-1.csv\n4. get sum of gross sales \n5. register other user and try to see other user's financial records\n\n\n\n\n\nProject structure\n-----------------\nFiles related to application are in the ``main`` directory.\nApplication parts are:\n```text\nmain\n├── __init__.py\n├── api\n│   ├── __init__.py\n│   └── v1\n│       ├── __init__.py\n│       ├── router.py\n│       └── routes\n│           ├── __init__.py\n│           ├── status.py\n│           ├── financial_records.py\n│           └── user.py\n├── app.py\n├── core\n│   ├── __init__.py\n│   ├── config.py\n│   ├── dependencies.py\n│   ├── exceptions.py\n│   ├── logging.py\n│   ├── security.py\n│   └── settings\n│       ├── __init__.py\n│       ├── app.py\n│       └── base.py\n├── db\n│   ├── __init__.py\n│   ├── base.py\n│   ├── base_class.py\n│   ├── migrations\n│   │   ├── env.py\n│   │   ├── script.py.mako\n│   │   └── versions\n│   │       └── dfb75cfbf652_create_tables.py\n│   ├── repositories\n│   │   ├── __init__.py\n│   │   ├── base.py\n│   │   ├── financial_records.py\n│   │   └── users.py\n│   └── session.py\n├── models\n│   ├── __init__.py\n│   ├── financial_record.py\n│   └── user.py\n├── schemas\n│   ├── __init__.py\n│   ├── response.py\n│   ├── status.py\n│   ├── financial_records.py\n│   └── user.py\n├── services\n│   ├── __init__.py\n│   └── user.py\n└── utils\n    ├── __init__.py\n    └── financial_records.py\n```\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Femingenc%2Ffinancial_app","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Femingenc%2Ffinancial_app","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Femingenc%2Ffinancial_app/lists"}