{"id":21026627,"url":"https://github.com/jeremiegince/pythonproject-template","last_synced_at":"2026-02-07T18:00:51.991Z","repository":{"id":218259680,"uuid":"745985155","full_name":"JeremieGince/PythonProject-Template","owner":"JeremieGince","description":"Python Template with uv","archived":false,"fork":false,"pushed_at":"2025-11-05T14:45:31.000Z","size":469,"stargazers_count":1,"open_issues_count":1,"forks_count":1,"subscribers_count":1,"default_branch":"main","last_synced_at":"2026-01-02T05:03:02.167Z","etag":null,"topics":["docker","poetry-python","python3","template-project","uv"],"latest_commit_sha":null,"homepage":"","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/JeremieGince.png","metadata":{"files":{"readme":"README.md","changelog":"change_project_attributes.py","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,"zenodo":null,"notice":null,"maintainers":null,"copyright":null,"agents":null,"dco":null,"cla":null}},"created_at":"2024-01-20T18:35:11.000Z","updated_at":"2025-11-02T15:17:56.000Z","dependencies_parsed_at":"2024-11-19T11:56:09.892Z","dependency_job_id":"0b551299-4f57-40ed-a921-5938b9174012","html_url":"https://github.com/JeremieGince/PythonProject-Template","commit_stats":null,"previous_names":["jeremiegince/pythonproject-template"],"tags_count":3,"template":true,"template_full_name":null,"purl":"pkg:github/JeremieGince/PythonProject-Template","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/JeremieGince%2FPythonProject-Template","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/JeremieGince%2FPythonProject-Template/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/JeremieGince%2FPythonProject-Template/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/JeremieGince%2FPythonProject-Template/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/JeremieGince","download_url":"https://codeload.github.com/JeremieGince/PythonProject-Template/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/JeremieGince%2FPythonProject-Template/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":29202959,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-02-07T17:44:10.191Z","status":"ssl_error","status_checked_at":"2026-02-07T17:44:07.936Z","response_time":63,"last_error":"SSL_connect returned=1 errno=0 peeraddr=140.82.121.6: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":["docker","poetry-python","python3","template-project","uv"],"created_at":"2024-11-19T11:45:33.352Z","updated_at":"2026-02-07T18:00:51.920Z","avatar_url":"https://github.com/JeremieGince.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"# PythonProject-Template\n\n[![Star on GitHub](https://img.shields.io/github/stars/JeremieGince/PythonProject-Template.svg?style=social)](https://github.com/JeremieGince/PythonProject-Template/stargazers)\n[![GitHub forks](https://img.shields.io/github/forks/JeremieGince/PythonProject-Template?style=social)](https://github.com/JeremieGince/PythonProject-Template/network/members)\n[![Python 3.6](https://img.shields.io/badge/python-3.10-blue.svg)](https://www.python.org/downloads/release/python-310/)\n[![downloads](https://img.shields.io/pypi/dm/MatchCake)](https://pypi.org/project/MatchCake)\n[![PyPI version](https://img.shields.io/pypi/v/MatchCake)](https://pypi.org/project/MatchCake)\n[![License](https://img.shields.io/badge/License-Apache_2.0-blue.svg)](LICENSE)\n\n![Tests Workflow](https://github.com/JeremieGince/PythonProject-Template/actions/workflows/tests.yml/badge.svg)\n![Dist Workflow](https://github.com/JeremieGince/PythonProject-Template/actions/workflows/build_dist.yml/badge.svg)\n![Doc Workflow](https://github.com/JeremieGince/PythonProject-Template/actions/workflows/docs.yml/badge.svg)\n[![Code style: black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/psf/black)\n[![Imports: isort](https://img.shields.io/badge/%20imports-isort-%231674b1?style=flat\u0026labelColor=ef8336)](https://pycqa.github.io/isort/)\n\n\n# Description\n\nThis is a template for a Python project. \nIt includes a basic project structure, a Dockerfile, a requirements.txt file a README.md file, etc.\nThe goal of this template is to provide a starting point for a Python project. Once you have cloned this repository, \nyou can start by changing the `attributes` of the project using the `change_project_attributes.py` script with\nthe following command:\n```bash\npython change_project_attributes.py --help\n```\n\nThen you can start developing your project by adding your code to the `src` directory.\n\n\nThe project is constituted by the following parts:\n\n- **/.github**: This directory contains the GitHub Actions workflows that are responsible for\n  - running the tests: `.github/workflows/tests.yml`\n  - build the distribution: `.github/workflows/build_dist.yml`\n  - build the documentation: `.github/workflows/docs.yml`\n- **/data**: This directory will contain the data that will be used and generated by the project.\n- **/dist**: This directory will contain the distribution of the project.\n- **/docs**: This directory will contain the documentation of the project.\n- **/images**: This directory will contain the images that will be used in the README.md file or in the documentation.\n- **/sphinx**: This directory contains the configuration of the Sphinx documentation.\n- **/src**: This directory will contain the source code of the project. This is where you will add your own sauce.\n- **/tests**: This directory will contain the tests of the project.\n- **/docker_files**: This directory contains the scripts that will help you build the docker image and run the \n   project in a container.\n- **Dockerfile**: This file is responsible for building the docker image of the project.\n- **.gitattributes**: This file is responsible for setting the git attributes of the project.\n- **.gitignore**: This file is responsible for ignoring the files that you don't want to commit to the repository.\n   A basic one is already provided and should be enough for most of the projects.\n- **pyproject.toml**: This file is responsible for listing the dependencies of the project and the \n   configuration of the project.\n- **README.md**: This file is responsible for providing information about the project.\n   A basic structure is provided after this little introduction.\n- **change_project_attributes.py**: This script is responsible for changing the attributes of the project.\n   Feel free to remove it once you used it.\n- **setup.py**: This file is responsible for setting up the project.\n- **LICENSE**: This file is responsible for providing the license of the project.\n\n# README TEMPLATE\n\n## Installation\n### Development Dependencies\n\nWith `uv` installed, run the following commands to install the dependencies:\n```bash\nuv venv .venv\nuv sync --dev\n```\n\nWith `python` and `pip` installed, run the following commands to install the dependencies:\n```bash\npython -m venv .venv\nsource .venv/bin/activate\npip install uv\npython -m uv sync --dev\n```\n\nWith `poetry` installed, run the following commands to install the dependencies:\n```bash\npython -m venv .venv\nsource .venv/bin/activate\npoetry install\n```\n\n\n## Scripting Usage\nTo run a single training, you can run the following command:\n```bash\npython -m \u003cpackage_name\u003e \u003cyour_parameters\u003e\n```\nand to know the parameters you can use the help command:\n```bash\npython -m \u003cpackage_name\u003e --help\n```\n\n## Deployment\nYou will need to install Docker to run the trainings in a container. \nYou can install Docker by following the instructions [here](https://docs.docker.com/get-docker/).\n\nTo build the docker image of the project you can run the following command:\n```bash\ndocker build -t \u003cpackage_name\u003e:latest .\n```\n\nThe container can be run in two different modes: \n\n- **release**: This mode is responsible for running the __main__.py of the current package. \n- **it**: This is a development mode that is responsible for running the container in the interactive mode.\n\nTo run a mode `\u003cmode\u003e` you can run the following command:\n```bash\ndocker run --name \u003cpackage_name\u003e-\u003cphase\u003e --detach --rm --volume=\u003cdata_path\u003e:/\u003cROOT_DIR\u003e/data -e \"MODE=\u003cmode\u003e\" \u003cpackage_name\u003e:latest \u003cyour_arguments\u003e\n```\nwhere `\u003cdata_path\u003e` is the absolute path in your local machine where you want to store the data generated by the phase.\nThe `\u003cROOT_DIR\u003e` is the root directory of the project.\n\nThere is another way you can do all of this. You can use the `docker_files/build_image_and_run.py` script. This script\nwill build the image and run the mode you want. You can run the script with the following command:\n```bash\npython docker_files/build_image_and_run.py --mode=\u003cmode\u003e\n```\n\n\n## References\n\n\n## License\n\n\n## Acknowledgements\n\n\n## Citation\n```\n```\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fjeremiegince%2Fpythonproject-template","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fjeremiegince%2Fpythonproject-template","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fjeremiegince%2Fpythonproject-template/lists"}