{"id":16691882,"url":"https://github.com/ucyo/python-package-template","last_synced_at":"2025-12-28T20:14:01.122Z","repository":{"id":89361144,"uuid":"414991522","full_name":"ucyo/python-package-template","owner":"ucyo","description":"Template for reproducible python applications in science","archived":false,"fork":false,"pushed_at":"2023-12-30T20:46:09.000Z","size":25,"stargazers_count":1,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"master","last_synced_at":"2025-03-13T21:29:53.906Z","etag":null,"topics":["python","pythonappdevelopemnt","reproducibility","reproducible-research","reproducible-science"],"latest_commit_sha":null,"homepage":"","language":"Makefile","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/ucyo.png","metadata":{"files":{"readme":"README.md","changelog":null,"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}},"created_at":"2021-10-08T13:10:46.000Z","updated_at":"2023-08-28T13:37:05.000Z","dependencies_parsed_at":"2023-12-30T21:59:39.738Z","dependency_job_id":"fb9017ff-aa81-4d6b-9be0-5e96b552453c","html_url":"https://github.com/ucyo/python-package-template","commit_stats":null,"previous_names":["ucyo/python-package-template","ucyo/python-dev-template-base"],"tags_count":0,"template":true,"template_full_name":null,"purl":"pkg:github/ucyo/python-package-template","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ucyo%2Fpython-package-template","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ucyo%2Fpython-package-template/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ucyo%2Fpython-package-template/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ucyo%2Fpython-package-template/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/ucyo","download_url":"https://codeload.github.com/ucyo/python-package-template/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ucyo%2Fpython-package-template/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":28103533,"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","status":"online","status_checked_at":"2025-12-28T02:00:05.685Z","response_time":62,"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":["python","pythonappdevelopemnt","reproducibility","reproducible-research","reproducible-science"],"created_at":"2024-10-12T16:10:31.013Z","updated_at":"2025-12-28T20:14:01.104Z","avatar_url":"https://github.com/ucyo.png","language":"Makefile","readme":"# Template for Python\n\nThis a template for developing Python application and libraries in an enclosed\nand safe environment. We are using Docker to provide a reproducible environment\nwhich can be used for active development, python packaging for releases and\nCI/CD workflows.\n\n## Usage\n\nCopy the example environmental file `.env.example` to `.env` and (if necessary)\nadd environmental variables.\n```bash\n$ \u003e cp .env.example .env\n```\n\nStart and bash into development container.\n```bash\n$ \u003e make bash\n```\n\nNow your environment is setup. All changes to the codebase are reflected in the\ncontainer, since they are mounted.\n\n## Getting Started\n\n### Name your project\n\nThe first thing you want to do is give your project a proper name.\n\n1. Rename the `project` in [pyproject.toml](./app/pyproject.toml) and update the `description`.\n2. Rename the `app/src/app` to your project name.\n\n    ```bash\n    $ \u003e mv app/src/app app/src/\u003cprojectname\u003e\n    ```\n\n### Add dependencies\n\nAdd your dependencies to the project.\n\n1. Enter the development container.\n\n    ```bash\n    $ \u003e make bash\n    ```\n\n2. Use `rye` to add the dependencies. You can find an introduction to `rye` [here](https://rye-up.com/guide/).\n\n    ```bash\n    $ \u003e rye add \u003cdependent package\u003e  # like flask, numpy or pandas\n    ```\n\n3. Install the dependencies.\n\n    ```bash\n    $ \u003e rye sync\n    ```\n\nThe next time you build the container your dependencies have been installed.\n\n### Update the README\n\nA fresh start. Just move [the blank README.md](./app/README.md) over here and\nstart with your project.\n\n```bash\n$ \u003e mv app/README.md .\n```\n\n## Explore\n\nThis template is just the barebone to get a Python Open Source Software (OSS)\nproject up and running. Don't forget change the license, add a CHANGE.md and\na CODE_OF_CONDUCT.md. But that is up to your :smile:\n","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fucyo%2Fpython-package-template","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fucyo%2Fpython-package-template","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fucyo%2Fpython-package-template/lists"}