{"id":17724930,"url":"https://github.com/simonboothroyd/python-template","last_synced_at":"2025-03-31T14:17:00.092Z","repository":{"id":217884045,"uuid":"745029481","full_name":"SimonBoothroyd/python-template","owner":"SimonBoothroyd","description":"A robust template for new python projects","archived":false,"fork":false,"pushed_at":"2024-01-20T12:06:07.000Z","size":19,"stargazers_count":1,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2024-01-20T13:24:45.504Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"","language":"Python","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/SimonBoothroyd.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,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2024-01-18T13:58:58.000Z","updated_at":"2024-01-18T15:07:49.000Z","dependencies_parsed_at":"2024-10-25T20:08:46.445Z","dependency_job_id":"9fb28947-f392-4bc8-af33-144dfb770036","html_url":"https://github.com/SimonBoothroyd/python-template","commit_stats":null,"previous_names":["simonboothroyd/python-template"],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/SimonBoothroyd%2Fpython-template","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/SimonBoothroyd%2Fpython-template/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/SimonBoothroyd%2Fpython-template/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/SimonBoothroyd%2Fpython-template/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/SimonBoothroyd","download_url":"https://codeload.github.com/SimonBoothroyd/python-template/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":246481005,"owners_count":20784458,"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-25T15:49:03.947Z","updated_at":"2025-03-31T14:17:00.075Z","avatar_url":"https://github.com/SimonBoothroyd.png","language":"Python","readme":"# Python Template\n\nAn opinionated template for Python projects that was originally based on the fantastic\n[MolSSI Cookiecutter template](https://github.com/MolSSI/cookiecutter-cms), but has\nnow diverged significantly.\n\nThe template provides\n\n- a basic python package project structure.\n- a pre-commit configuration for linting and formatting using [`ruff`](https://github.com/astral-sh/ruff)\n- a makefile with common commands, such as conda environment creation and linting.\n- a GitHub Actions workflow for running tests and code coverage.\n- automation to deploying documentation to GitHub Pages using GitHub Actions.\n- simple GitHub issue / PR templates.\n\n## Usage\n\nTo create a project using this template, run\n\n```shell\ncookiecutter gh:SimonBoothroyd/python-template\n```\n\nand follow the instructions.\n\nOnce created, a development conda environment can be created by running\n\n```shell\nmake env\nconda activate {{ package_name }}\n```\n\nin the newly created project directory.\n\n### GitHub Pages\n\nTo enable automatic deployment of documentation to GitHub Pages, you will need to \nallow GitHub Actions to push to your repository. To do this, go to your repository's\nsettings page, and select `Actions -\u003e General` from the left-hand menu. Then enable\n`\"Read and write permissions\"` under `\"Workflow permissions\"`.\n\nYou will also need to enable GitHub Pages for your repository. To do this, go to your\nrepository's settings page, and select `Pages` from the left-hand menu. Then under \n`\"Branch\"`, select `gh-pages` and click `Save`.\n\nYou will probably also want to commit an `index.html` file to your repository `gh-pages`\nbranch that redirects to the latest documentation:\n\n```html\n\u003c!DOCTYPE html\u003e\n\u003chtml\u003e\n\u003chead\u003e\n    \u003cmeta charset=\"utf-8\"\u003e\n    \u003cmeta http-equiv=\"refresh\" content=\"0;url=./latest/\"\u003e\n    \u003ctitle\u003eRedirecting to latest documentation\u003c/title\u003e\n\u003c/head\u003e\n\u003cbody\u003e\n    \u003cp\u003eIf you are not redirected, \u003ca href=\"./latest/\"\u003eclick here\u003c/a\u003e to go to the latest documentation.\u003c/p\u003e\n\u003c/body\u003e\n\u003c/html\u003e\n```","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsimonboothroyd%2Fpython-template","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fsimonboothroyd%2Fpython-template","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsimonboothroyd%2Fpython-template/lists"}