{"id":26339261,"url":"https://github.com/m4tice/py-prj-tmpl","last_synced_at":"2026-05-14T20:02:26.662Z","repository":{"id":191983970,"uuid":"685808785","full_name":"m4tice/py-prj-tmpl","owner":"m4tice","description":"Empty Python project template with custom workflow","archived":false,"fork":false,"pushed_at":"2025-03-23T02:10:54.000Z","size":36,"stargazers_count":1,"open_issues_count":2,"forks_count":0,"subscribers_count":1,"default_branch":"master","last_synced_at":"2025-10-26T14:42:38.211Z","etag":null,"topics":["ci","continuous-integration","continuous-testing","github-actions","project-template-repo","pylint","pytest"],"latest_commit_sha":null,"homepage":"","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/m4tice.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,"zenodo":null,"notice":null,"maintainers":null,"copyright":null,"agents":null,"dco":null,"cla":null}},"created_at":"2023-09-01T04:01:52.000Z","updated_at":"2025-03-23T02:21:08.000Z","dependencies_parsed_at":"2023-09-01T21:57:00.027Z","dependency_job_id":"51cecf0f-11fa-44da-b8c6-84fd57c818a3","html_url":"https://github.com/m4tice/py-prj-tmpl","commit_stats":null,"previous_names":["m4tice/py-prj-tmpl"],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/m4tice/py-prj-tmpl","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/m4tice%2Fpy-prj-tmpl","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/m4tice%2Fpy-prj-tmpl/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/m4tice%2Fpy-prj-tmpl/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/m4tice%2Fpy-prj-tmpl/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/m4tice","download_url":"https://codeload.github.com/m4tice/py-prj-tmpl/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/m4tice%2Fpy-prj-tmpl/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":33041204,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-05-13T13:14:54.681Z","status":"online","status_checked_at":"2026-05-14T02:00:06.663Z","response_time":57,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"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":["ci","continuous-integration","continuous-testing","github-actions","project-template-repo","pylint","pytest"],"created_at":"2025-03-16T03:16:55.438Z","updated_at":"2026-05-14T20:02:26.626Z","avatar_url":"https://github.com/m4tice.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Introduction  \nThis Git repo serves as a template for a newly started Python Project.  \nOutline:  \n* Git commit message  \n* Environment handling  \n* Project structure management  \n* Pytest  \n* SQL Database handling  \n* Web Development  \n* Pylint  \n\n\n**1. Git commit message**  \nPlease start the commit message with the following tags:  \n\n* Create new file \n```\ncreate: \u003cmessage\u003e  \n```\n* Add new code \n```\nadd: \u003cmessage\u003e  \n```\n* Update file / code\n```\nupdate: \u003cmessage\u003e\n```\n* Remove file / code\n```\nremove: \u003cmessasge\u003e\n```  \n\n\n**2. Environment handling**  \n* Command to create new python virtual environment\n```\npython\u003cversion\u003e -m venv \u003cvirtual-environment-name\u003e\n```  \n\n* Command to activate created virtual environment\n```\n.venv\\Scripts\\activate.bat\n```  \n\n* Command to install libraries listed in requirements.txt\n```\npip install -r requirements.txt\n```  \n\n* Command to export existing libraries to requirements.txt\n```\npip freeze \u003e requirements.txt\n```  \n\n\n**3. Project structure management**  \nRun init_structure.bat to create the desire project structure.  \n\n\n**4. Pytest**  \nCommand to run pytest\n```\npytest -vv\n```  \n\n\n**5. SQL Database handling**  \nReference: [m4tice-python-sqlite3](https://github.com/m4tice/python-sqlite3)  \n\n\n**6. Web Development**  \nCommand to run flask application\n```\nflask run\n```\nor in debug mode\n```\nflask run --debug\n```  \n\nCommand to run fastapi application\nwith fastapi[standard]\n```\nfastapi dev main.py\n```\nor\n```\nuvicorn main:app --reload\n```  \n\n\n**7. Pylint**  \nGithub's commitment to this project is managed with Pylint.  \nPylint warnings will prevent the commit until all the warnings are resolved.  \nIn case you cannot resolve the warning, leave the following comment at the end of the same line  \n\n    # pylint: disable=\u003cpylint-warning-1\u003e, \u003cpylint-warning-2\u003e, etc.\n\nFor example:  \n* Pylint warning:  \n    ```\n    Line too long (145/100) Pylint(C0301:line-too-long)  \n    ```  \n\n* To disable it:  \n    ```\n    # pylint: disable=line-too-long  \n    ```  \n\nIn case you want to disable pylint check with the whole file, put the following comment at the beginning of the *.py module:  \n\n* Pylint \u003c 0.25:  \n    ```\n    # pylint: disable-all  \n    ```  \n\n* Pylint 0.26.1 -\u003e:  \n    ```\n    # pylint: skip-file  \n    ```\n\nYou might not like it, but that's my preference to keep things in place ;)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fm4tice%2Fpy-prj-tmpl","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fm4tice%2Fpy-prj-tmpl","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fm4tice%2Fpy-prj-tmpl/lists"}