# PyPI Package Template
[![Ruff](https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/ruff/main/assets/badge/v2.json)](https://github.com/astral-sh/ruff)
![GitHub License](https://img.shields.io/github/license/SpaceShaman/pypi-workflow)
![Tests](https://img.shields.io/github/actions/workflow/status/SpaceShaman/pypi-workflow/release.yml?label=tests)
![Codecov](https://img.shields.io/codecov/c/github/SpaceShaman/pypi-workflow)
![PyPI - Python Version](https://img.shields.io/pypi/pyversions/pypi-workflow)
[![PyPI - Version](https://img.shields.io/pypi/v/pypi-workflow)](https://pypi.org/project/pypi-workflow)
This repository contains a simple template for creating PyPI packages with automated publishing using GitHub Actions. It includes the following features:
- **Automated Publishing**:
- New versions are published to Test PyPI when a new tag with a semantic version is pushed.
- New releases trigger the build and publication of the package to the official PyPI.
- **Continuous Integration/Continuous Deployment (CI/CD)**:
- Automated testing using `pytest`.
- Coverage reports generated with `pytest-cov` and uploaded to Codecov.
- **Secrets Configuration**:
- Requires `PYPI_TOKEN` and `TEST_PYPI_TOKEN` for publishing.
- Requires `CODECOV_TOKEN` for generating the coverage badge.
This template streamlines the process of developing, testing, and publishing Python packages, ensuring a smooth and automated workflow.
Raw data
{
"_id": null,
"home_page": "https://github.com/SpaceShaman/pypi-workflow",
"name": "pypi-workflow",
"maintainer": null,
"docs_url": null,
"requires_python": "<4.0.0,>=3.10.0",
"maintainer_email": null,
"keywords": null,
"author": "SpaceShaman",
"author_email": "spaceshaman@tuta.io",
"download_url": "https://files.pythonhosted.org/packages/87/55/d7299b062cd462da34eaf60f67966621ac8d3eec9da631b6409b939a344c/pypi_workflow-0.1.2.tar.gz",
"platform": null,
"description": "# PyPI Package Template\n\n[![Ruff](https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/ruff/main/assets/badge/v2.json)](https://github.com/astral-sh/ruff)\n![GitHub License](https://img.shields.io/github/license/SpaceShaman/pypi-workflow)\n![Tests](https://img.shields.io/github/actions/workflow/status/SpaceShaman/pypi-workflow/release.yml?label=tests)\n![Codecov](https://img.shields.io/codecov/c/github/SpaceShaman/pypi-workflow)\n![PyPI - Python Version](https://img.shields.io/pypi/pyversions/pypi-workflow)\n[![PyPI - Version](https://img.shields.io/pypi/v/pypi-workflow)](https://pypi.org/project/pypi-workflow)\n\nThis repository contains a simple template for creating PyPI packages with automated publishing using GitHub Actions. It includes the following features:\n\n- **Automated Publishing**:\n - New versions are published to Test PyPI when a new tag with a semantic version is pushed.\n - New releases trigger the build and publication of the package to the official PyPI.\n\n- **Continuous Integration/Continuous Deployment (CI/CD)**:\n - Automated testing using `pytest`.\n - Coverage reports generated with `pytest-cov` and uploaded to Codecov.\n\n- **Secrets Configuration**:\n - Requires `PYPI_TOKEN` and `TEST_PYPI_TOKEN` for publishing.\n - Requires `CODECOV_TOKEN` for generating the coverage badge.\n\nThis template streamlines the process of developing, testing, and publishing Python packages, ensuring a smooth and automated workflow.\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "Simple template for creating PyPI packages with automated publishing using GitHub Actions.",
"version": "0.1.2",
"project_urls": {
"Homepage": "https://github.com/SpaceShaman/pypi-workflow",
"Repository": "https://github.com/SpaceShaman/pypi-workflow"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "907a1c6a7555570b488bd3129de3f2bcd51c74238b79e6eddf6b0f634cf845ba",
"md5": "1398622493fdf5537cf9d4403266d4a1",
"sha256": "2b2036fd81c6bc9cc6ceedb1b21719267999ddf4662e4d13831f0166fe06c4b7"
},
"downloads": -1,
"filename": "pypi_workflow-0.1.2-py3-none-any.whl",
"has_sig": false,
"md5_digest": "1398622493fdf5537cf9d4403266d4a1",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": "<4.0.0,>=3.10.0",
"size": 2827,
"upload_time": "2024-07-07T20:43:15",
"upload_time_iso_8601": "2024-07-07T20:43:15.548447Z",
"url": "https://files.pythonhosted.org/packages/90/7a/1c6a7555570b488bd3129de3f2bcd51c74238b79e6eddf6b0f634cf845ba/pypi_workflow-0.1.2-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "8755d7299b062cd462da34eaf60f67966621ac8d3eec9da631b6409b939a344c",
"md5": "f62f2cfb26210ec4b40f6afdf2e267ee",
"sha256": "dfa2c2a2547adc1329f9c27091ab5180606107578d58b72269a373566da1f6bd"
},
"downloads": -1,
"filename": "pypi_workflow-0.1.2.tar.gz",
"has_sig": false,
"md5_digest": "f62f2cfb26210ec4b40f6afdf2e267ee",
"packagetype": "sdist",
"python_version": "source",
"requires_python": "<4.0.0,>=3.10.0",
"size": 2187,
"upload_time": "2024-07-07T20:43:19",
"upload_time_iso_8601": "2024-07-07T20:43:19.176084Z",
"url": "https://files.pythonhosted.org/packages/87/55/d7299b062cd462da34eaf60f67966621ac8d3eec9da631b6409b939a344c/pypi_workflow-0.1.2.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-07-07 20:43:19",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "SpaceShaman",
"github_project": "pypi-workflow",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"tox": true,
"lcname": "pypi-workflow"
}