{"id":16343513,"url":"https://github.com/costrouc/python-package-template","last_synced_at":"2025-11-06T05:30:32.571Z","repository":{"id":50207335,"uuid":"135220833","full_name":"costrouc/python-package-template","owner":"costrouc","description":"An example for package in python","archived":false,"fork":false,"pushed_at":"2022-12-08T00:59:42.000Z","size":2551,"stargazers_count":0,"open_issues_count":6,"forks_count":0,"subscribers_count":3,"default_branch":"master","last_synced_at":"2024-12-27T16:28:21.066Z","etag":null,"topics":["conda","continuous-integration","package","pypi","python","testing"],"latest_commit_sha":null,"homepage":"https://costrouc-python-package-template.readthedocs.io/en/latest/","language":"Python","has_issues":false,"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/costrouc.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":"LICENSE.md","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2018-05-29T00:17:43.000Z","updated_at":"2018-05-29T00:22:25.000Z","dependencies_parsed_at":"2023-01-24T09:15:33.950Z","dependency_job_id":null,"html_url":"https://github.com/costrouc/python-package-template","commit_stats":null,"previous_names":[],"tags_count":19,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/costrouc%2Fpython-package-template","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/costrouc%2Fpython-package-template/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/costrouc%2Fpython-package-template/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/costrouc%2Fpython-package-template/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/costrouc","download_url":"https://codeload.github.com/costrouc/python-package-template/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":239484065,"owners_count":19646429,"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":["conda","continuous-integration","package","pypi","python","testing"],"created_at":"2024-10-11T00:24:49.229Z","updated_at":"2025-11-06T05:30:32.542Z","avatar_url":"https://github.com/costrouc.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"**All issues and contributions should be done on\n[Gitlab](https://gitlab.com/costrouc/python-package-template). Github\nis used only as a mirror for visibility**\n\n# Python Package Template\n\n\u003ctable\u003e\n\u003ctr\u003e\n  \u003ctd\u003eLatest Release\u003c/td\u003e\n  \u003ctd\u003e\u003cimg src=\"https://img.shields.io/pypi/v/pypkgtemp.svg\" alt=\"latest release\" /\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n  \u003ctd\u003e\u003c/td\u003e\n  \u003ctd\u003e\u003cimg src=\"https://anaconda.org/costrouc/pypkgtemp/badges/version.svg\" alt=\"latest release\" /\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n  \u003ctd\u003e\u003c/td\u003e\n  \u003ctd\u003e\n    \u003ca href=\"https://hub.docker.com/r/costrouc/python-package-template/\"\u003e\n    \u003cimg src=\"https://img.shields.io/badge/docker-latest-blue.svg\" alt=\"latest release\" /\u003e\n    \u003c/a\u003e\n  \u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n  \u003ctd\u003ePackage Status\u003c/td\u003e\n  \u003ctd\u003e\u003cimg src=\"https://img.shields.io/pypi/status/pypkgtemp.svg\" alt=\"status\" /\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n  \u003ctd\u003eLicense\u003c/td\u003e\n  \u003ctd\u003e\u003cimg src=\"https://img.shields.io/pypi/l/pypkgtemp.svg\" alt=\"license\" /\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n  \u003ctd\u003eBuild Status\u003c/td\u003e\n  \u003ctd\u003e\n    \u003ca href=\"https://gitlab.com/costrouc/python-package-template/pipelines\"\u003e\n    \u003cimg src=\"https://gitlab.com/costrouc/python-package-template/badges/master/pipeline.svg\" alt=\"gitlab pipeline status\" /\u003e\n    \u003c/a\u003e\n  \u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n  \u003ctd\u003eCoverage\u003c/td\u003e\n  \u003ctd\u003e\u003cimg src=\"https://gitlab.com/costrouc/python-package-template/badges/master/coverage.svg\" alt=\"coverage\" /\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n  \u003ctd\u003eConda\u003c/td\u003e\n  \u003ctd\u003e\n    \u003ca href=\"https://gitlab.com/costrouc/python-package-template\"\u003e\n    \u003cimg src=\"https://anaconda.org/costrouc/pypkgtemp/badges/downloads.svg\" alt=\"conda downloads\" /\u003e\n    \u003c/a\u003e\n  \u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n  \u003ctd\u003eDocumentation\u003c/td\u003e\n  \u003ctd\u003e\n    \u003ca href=\"https://costrouc-python-package-template.readthedocs.io/en/latest/\"\u003e\n    \u003cimg src=\"https://media.readthedocs.org/static/projects/badges/passing.svg\" alt=\"readthedocs documentation\" /\u003e\n    \u003c/a\u003e\n  \u003c/td\u003e\n\u003c/tr\u003e\n\u003c/table\u003e\n\nThis is an opinionated attempt to document how I deploy a python\napplication with documentation, testing, pypi, and continuous\ndeployment. This project will be updated as I change my python\ndevelopment practices. Number one this is a learning experience.\n\n - documentation ([sphinx](http://www.sphinx-doc.org/en/stable/), selfhosted + [readthedocs](https://readthedocs.org/))\n - testing ([pytest](https://docs.pytest.org/en/latest/)) and coverage ([pytest-cov](https://github.com/pytest-dev/pytest-cov))\n - deploy to pypi ([twine](https://github.com/pypa/twine))\n - deploy to conda ([conda](https://github.com/conda/conda))\n - deploy docker container to ([dockerhub](https://hub.docker.com) and [gitlab container registry](https://about.gitlab.com/2016/05/23/gitlab-container-registry/))\n - building a package (`setup.py`, `README.md`, `CHANGELOG.md`, `LICENSE.md`)\n - command line interface with argparse\n - badges for testing, packages, and documentation\n\n## Assumptions:\n\nGitlab will be used for the continuous deployment. It is a great\nproject that is open source and comes with many nice features not\navailable for Github. You should consider it! Features used:\n\n - [pages](https://docs.gitlab.com/ee/user/project/pages/index.html)\n - [CI/CD](https://about.gitlab.com/features/gitlab-ci-cd/)\n\nIf you would like a custom domain setup with gitlab pages for the\ndocumentation you will need to use\n[cloudflare](https://www.cloudflare.com/). I have a [blog written on\nhow to do\nthis](https://chrisostrouchov.com/posts/hugo_static_site_deployment/)\nor you can look at the [gitlab cloudflare\ndocumentation](https://about.gitlab.com/2017/02/07/setting-up-gitlab-pages-with-cloudflare-certificates/).\n\n## Steps\n\nThis project is a python package itself and full documentation is\navailable on readthedocs. Each of the steps below includes a link to\nthe section in the documentation.\n\n1. [setup a bare python package](https://costrouc-python-package-template.readthedocs.io/en/latest/packaging.html) with git repo (`setup.py`, `README.md`, `.gitignore`, `\u003cpackage\u003e`)\n2. [setup pypi deployment](https://costrouc-python-package-template.readthedocs.io/en/latest/pypi.html) with git tags `vX.X.X`\n3. [setup testing](https://costrouc-python-package-template.readthedocs.io/en/latest/testing.html) on each commit with `pytest`\n4. [setup documentation](https://costrouc-python-package-template.readthedocs.io/en/latest/documentation.html) with `sphinx` on readthedocs and self hosted\n\n# Requirements\n\nNone!\n\n# Contributing\n\nAll contributions, bug reports, bug fixes, documentation improvements,\nenhancements and ideas are welcome. These should be submitted at the\n[Gitlab repository](https://gitlab.com/costrouc/python-package-template). Github is\nonly used for visibility.\n\nThe goal of this project is to in an opinionated way guide modern\npython packaging development for myself.\n\n# License\n\nMIT\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcostrouc%2Fpython-package-template","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fcostrouc%2Fpython-package-template","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcostrouc%2Fpython-package-template/lists"}