{"id":14065126,"url":"https://github.com/Nelson-Gon/pytemplates","last_synced_at":"2025-07-29T20:31:07.182Z","repository":{"id":48380915,"uuid":"419897285","full_name":"Nelson-Gon/pytemplates","owner":"Nelson-Gon","description":"Python Project templates ","archived":false,"fork":false,"pushed_at":"2022-07-30T00:18:32.000Z","size":245,"stargazers_count":1,"open_issues_count":0,"forks_count":0,"subscribers_count":2,"default_branch":"main","last_synced_at":"2024-10-29T13:59:58.540Z","etag":null,"topics":["cookiecutter","developer-tools","devtools","docgenerator","githubaction-workflow","githubactions","pip","project","project-template","pypi-package","python","python-3","python-script","setup-development-environment","starter-template","template","templates"],"latest_commit_sha":null,"homepage":"https://pytemplates.readthedocs.io/en/latest/","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/Nelson-Gon.png","metadata":{"files":{"readme":"README.md","changelog":"changelog.md","contributing":".github/CONTRIBUTING.md","funding":null,"license":"LICENSE","code_of_conduct":".github/CODE_OF_CONDUCT.md","threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2021-10-21T22:42:13.000Z","updated_at":"2023-09-08T18:27:48.000Z","dependencies_parsed_at":"2022-08-03T13:00:21.662Z","dependency_job_id":null,"html_url":"https://github.com/Nelson-Gon/pytemplates","commit_stats":null,"previous_names":[],"tags_count":0,"template":true,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Nelson-Gon%2Fpytemplates","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Nelson-Gon%2Fpytemplates/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Nelson-Gon%2Fpytemplates/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Nelson-Gon%2Fpytemplates/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/Nelson-Gon","download_url":"https://codeload.github.com/Nelson-Gon/pytemplates/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":228046079,"owners_count":17861090,"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":["cookiecutter","developer-tools","devtools","docgenerator","githubaction-workflow","githubactions","pip","project","project-template","pypi-package","python","python-3","python-script","setup-development-environment","starter-template","template","templates"],"created_at":"2024-08-13T07:04:19.055Z","updated_at":"2024-12-04T04:30:45.900Z","avatar_url":"https://github.com/Nelson-Gon.png","language":"Python","readme":"# Our Project: What the project does \n\n[![PyPI version fury.io](https://badge.fury.io/our_project.svg)](https://pypi.python.org/pypi/our_project/)\n[![DOI](https://zenodo.org/badge/DOI/10.5281/zenodo.3764453.svg)](https://doi.org/10.5281/zenodo.3764453)\n[![Project Status](http://www.repostatus.org/badges/latest/active.svg)](http://www.repostatus.org/#active) \n[![Codecov](https://codecov.io/gh/Nelson-Gon/pytemplates/branch/main/graph/badge.svg)](https://codecov.io/gh/Nelson-Gon/pytemplates?branch=main)\n![Test-Package](https://github.com/Nelson-Gon/pytemplates/workflows/Test-Package/badge.svg)\n[![PyPI license](https://img.shields.io/pypi/l/our_project.svg)](https://pypi.python.org/pypi/our_project/)\n[![Documentation Status](https://readthedocs.org/projects/pytemplates/badge/?version=latest)](https://pytemplates.readthedocs.io/en/latest/?badge=latest)\n[![Total Downloads](https://pepy.tech/badge/our_project)](https://pepy.tech/project/our_project)\n[![Monthly Downloads](https://pepy.tech/badge/our_project/month)](https://pepy.tech/project/our_project)\n[![Weekly Downloads](https://pepy.tech/badge/our_project/week)](https://pepy.tech/project/our_project)\n[![Maintenance](https://img.shields.io/badge/Maintained%3F-yes-green.svg)](https://GitHub.com/Nelson-Gon/pytemplates/graphs/commit-activity)\n[![GitHub last commit](https://img.shields.io/github/last-commit/Nelson-Gon/pytemplates.svg)](https://github.com/Nelson-Gon/pytemplates/commits/main)\n[![GitHub issues](https://img.shields.io/github/issues/Nelson-Gon/pytemplates.svg)](https://GitHub.com/Nelson-Gon/pytemplates/issues/)\n[![GitHub issues-closed](https://img.shields.io/github/issues-closed/Nelson-Gon/pytemplates.svg)](https://GitHub.com/Nelson-Gon/pytemplates/issues?q=is%3Aissue+is%3Aclosed)\n\n\nWelcome to `our_project`. \n\n**Please note that this is a template repository, click use template (do not fork unless suggesting an improvement) to use in a new project and edit files as required**. Also, see important notes at the end of this file. \n\n# Installation Guide\n\n```shell\npip install our_project \n```\n\n# Currently implemented features\n\n`our_project` currently does the following:\n\n- [x] Contains base class `HelloWorld` \n\n- [x] `HelloWorld` has the `print_text` method that prints user supplied text. \n\n- [x] A github action to test project installation and run tests.\n\n- [x] A github action to release on PyPI (requires adding `PYPI_USERNAME` and `PYPI_PASSWORD` to repository secrets.)\n\n# Features that need further attention \n\nWe intend to work on the following in the future:\n\n- [ ] Make it less cumbersome to init docs with `sphinx`. \n\n\n# Document generation \n\nPlease edit `docs/source/index.rst` and `docs/source/modules.rst` as required then run:\n\n```shell\n./scripts/mkdocs.sh \n\n```\n\nThe above assumes you are at the root of \"our_project\". \n\nAlso delete `setup.rst`, `tests.rst`, if they exist. \n\nOtherwise, run and edit as necessary.  \n\n```shell\nsphinx-quickstart\n```\n\nThank you,\n\nNelsonGon\n22/10/2021 \n\n\n---\n\n# Important Notes \n\nThis repository holds templates that follow a typical workflow for new `python` projects.\n\n**A word of caution**\n\nThese templates are mostly intended to save time. However, modern IDEs provide project templates that are more mature and less opinionated than the templates here. \n\nThis repository serves an additional purpose of allowing developers new to programming to study project structure using very simple examples. \n\nFor licenses, tests, and workflows, gitignore it is recommended that one generates these automatically either from their IDE of choice or for `.gitignore` files and licenses, via github or gitlab. \n\nHappy to hear from you in case of any questions and/or feedback.\n\n---\n\n**DISCLAIMER**: \n\nThis project is not in anyway related to a similarly named package [pytemplates](https://pypi.org/project/pytemplates/) that does something completely different (\"Pytemplates is a lightweight HTML template engine written in Python, with support for template inheritance, blocks, macros, context, and Django.\").\n\nI only got to learn of this package upon adding badges to this file. \n\n\n\n","funding_links":[],"categories":["Python"],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2FNelson-Gon%2Fpytemplates","html_url":"https://awesome.ecosyste.ms/projects/github.com%2FNelson-Gon%2Fpytemplates","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2FNelson-Gon%2Fpytemplates/lists"}