#############
OctoCheese
#############
.. start short_desc
**🐙 🧀 – Copy PyPI Packages to GitHub Releases**
.. end short_desc
This is a GitHub action, Python package and command line script that copies distribution files from PyPI ("The Cheese Shop") and adds them to the relevant tag in GitHub Releases.
.. start shields
.. list-table::
:stub-columns: 1
:widths: 10 90
* - Docs
- |docs| |docs_check|
* - Tests
- |actions_linux| |actions_windows| |actions_macos| |coveralls|
* - PyPI
- |pypi-version| |supported-versions| |supported-implementations| |wheel|
* - Activity
- |commits-latest| |commits-since| |maintained| |pypi-downloads|
* - QA
- |codefactor| |actions_flake8| |actions_mypy|
* - Other
- |license| |language| |requires|
.. |docs| image:: https://img.shields.io/readthedocs/octocheese/latest?logo=read-the-docs
:target: https://octocheese.readthedocs.io/en/latest
:alt: Documentation Build Status
.. |docs_check| image:: https://github.com/domdfcoding/octocheese/workflows/Docs%20Check/badge.svg
:target: https://github.com/domdfcoding/octocheese/actions?query=workflow%3A%22Docs+Check%22
:alt: Docs Check Status
.. |actions_linux| image:: https://github.com/domdfcoding/octocheese/workflows/Linux/badge.svg
:target: https://github.com/domdfcoding/octocheese/actions?query=workflow%3A%22Linux%22
:alt: Linux Test Status
.. |actions_windows| image:: https://github.com/domdfcoding/octocheese/workflows/Windows/badge.svg
:target: https://github.com/domdfcoding/octocheese/actions?query=workflow%3A%22Windows%22
:alt: Windows Test Status
.. |actions_macos| image:: https://github.com/domdfcoding/octocheese/workflows/macOS/badge.svg
:target: https://github.com/domdfcoding/octocheese/actions?query=workflow%3A%22macOS%22
:alt: macOS Test Status
.. |actions_flake8| image:: https://github.com/domdfcoding/octocheese/workflows/Flake8/badge.svg
:target: https://github.com/domdfcoding/octocheese/actions?query=workflow%3A%22Flake8%22
:alt: Flake8 Status
.. |actions_mypy| image:: https://github.com/domdfcoding/octocheese/workflows/mypy/badge.svg
:target: https://github.com/domdfcoding/octocheese/actions?query=workflow%3A%22mypy%22
:alt: mypy status
.. |requires| image:: https://dependency-dash.repo-helper.uk/github/domdfcoding/octocheese/badge.svg
:target: https://dependency-dash.repo-helper.uk/github/domdfcoding/octocheese/
:alt: Requirements Status
.. |coveralls| image:: https://img.shields.io/coveralls/github/domdfcoding/octocheese/master?logo=coveralls
:target: https://coveralls.io/github/domdfcoding/octocheese?branch=master
:alt: Coverage
.. |codefactor| image:: https://img.shields.io/codefactor/grade/github/domdfcoding/octocheese?logo=codefactor
:target: https://www.codefactor.io/repository/github/domdfcoding/octocheese
:alt: CodeFactor Grade
.. |pypi-version| image:: https://img.shields.io/pypi/v/octocheese
:target: https://pypi.org/project/octocheese/
:alt: PyPI - Package Version
.. |supported-versions| image:: https://img.shields.io/pypi/pyversions/octocheese?logo=python&logoColor=white
:target: https://pypi.org/project/octocheese/
:alt: PyPI - Supported Python Versions
.. |supported-implementations| image:: https://img.shields.io/pypi/implementation/octocheese
:target: https://pypi.org/project/octocheese/
:alt: PyPI - Supported Implementations
.. |wheel| image:: https://img.shields.io/pypi/wheel/octocheese
:target: https://pypi.org/project/octocheese/
:alt: PyPI - Wheel
.. |license| image:: https://img.shields.io/github/license/domdfcoding/octocheese
:target: https://github.com/domdfcoding/octocheese/blob/master/LICENSE
:alt: License
.. |language| image:: https://img.shields.io/github/languages/top/domdfcoding/octocheese
:alt: GitHub top language
.. |commits-since| image:: https://img.shields.io/github/commits-since/domdfcoding/octocheese/v0.6.0
:target: https://github.com/domdfcoding/octocheese/pulse
:alt: GitHub commits since tagged version
.. |commits-latest| image:: https://img.shields.io/github/last-commit/domdfcoding/octocheese
:target: https://github.com/domdfcoding/octocheese/commit/master
:alt: GitHub last commit
.. |maintained| image:: https://img.shields.io/maintenance/yes/2023
:alt: Maintenance
.. |pypi-downloads| image:: https://img.shields.io/pypi/dm/octocheese
:target: https://pypi.org/project/octocheese/
:alt: PyPI - Downloads
.. end shields
|
GitHub Actions Usage
---------------------
In a GitHub Workflow:
.. code-block:: yaml
name: "Copy PyPI to Releases"
on:
- push
jobs:
releases:
runs-on: ubuntu-latest
steps:
- uses: domdfcoding/octocheese@master
with:
pypi_name: "domdf_python_tools"
env:
GITHUB_TOKEN: ${{secrets.GITHUB_TOKEN}}
Installing as a Python package and script
------------------------------------------
.. start installation
``OctoCheese`` can be installed from PyPI.
To install with ``pip``:
.. code-block:: bash
$ python -m pip install octocheese
.. end installation
Raw data
{
"_id": null,
"home_page": "https://github.com/domdfcoding/octocheese",
"name": "octocheese",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.6",
"maintainer_email": "",
"keywords": "github,github-action,pypi",
"author": "",
"author_email": "Dominic Davis-Foster <dominic@davis-foster.co.uk>",
"download_url": "https://files.pythonhosted.org/packages/bc/6f/41bcdb6bf3389cd01e439cbc9620d10d5d4566d1e680e0cef15126ac3d59/octocheese-0.6.0.tar.gz",
"platform": "Windows",
"description": "\n#############\nOctoCheese\n#############\n\n.. start short_desc\n\n**\ud83d\udc19 \ud83e\uddc0 \u2013 Copy PyPI Packages to GitHub Releases**\n\n.. end short_desc\n\nThis is a GitHub action, Python package and command line script that copies distribution files from PyPI (\"The Cheese Shop\") and adds them to the relevant tag in GitHub Releases.\n\n.. start shields\n\n.. list-table::\n\t:stub-columns: 1\n\t:widths: 10 90\n\n\t* - Docs\n\t - |docs| |docs_check|\n\t* - Tests\n\t - |actions_linux| |actions_windows| |actions_macos| |coveralls|\n\t* - PyPI\n\t - |pypi-version| |supported-versions| |supported-implementations| |wheel|\n\t* - Activity\n\t - |commits-latest| |commits-since| |maintained| |pypi-downloads|\n\t* - QA\n\t - |codefactor| |actions_flake8| |actions_mypy|\n\t* - Other\n\t - |license| |language| |requires|\n\n.. |docs| image:: https://img.shields.io/readthedocs/octocheese/latest?logo=read-the-docs\n\t:target: https://octocheese.readthedocs.io/en/latest\n\t:alt: Documentation Build Status\n\n.. |docs_check| image:: https://github.com/domdfcoding/octocheese/workflows/Docs%20Check/badge.svg\n\t:target: https://github.com/domdfcoding/octocheese/actions?query=workflow%3A%22Docs+Check%22\n\t:alt: Docs Check Status\n\n.. |actions_linux| image:: https://github.com/domdfcoding/octocheese/workflows/Linux/badge.svg\n\t:target: https://github.com/domdfcoding/octocheese/actions?query=workflow%3A%22Linux%22\n\t:alt: Linux Test Status\n\n.. |actions_windows| image:: https://github.com/domdfcoding/octocheese/workflows/Windows/badge.svg\n\t:target: https://github.com/domdfcoding/octocheese/actions?query=workflow%3A%22Windows%22\n\t:alt: Windows Test Status\n\n.. |actions_macos| image:: https://github.com/domdfcoding/octocheese/workflows/macOS/badge.svg\n\t:target: https://github.com/domdfcoding/octocheese/actions?query=workflow%3A%22macOS%22\n\t:alt: macOS Test Status\n\n.. |actions_flake8| image:: https://github.com/domdfcoding/octocheese/workflows/Flake8/badge.svg\n\t:target: https://github.com/domdfcoding/octocheese/actions?query=workflow%3A%22Flake8%22\n\t:alt: Flake8 Status\n\n.. |actions_mypy| image:: https://github.com/domdfcoding/octocheese/workflows/mypy/badge.svg\n\t:target: https://github.com/domdfcoding/octocheese/actions?query=workflow%3A%22mypy%22\n\t:alt: mypy status\n\n.. |requires| image:: https://dependency-dash.repo-helper.uk/github/domdfcoding/octocheese/badge.svg\n\t:target: https://dependency-dash.repo-helper.uk/github/domdfcoding/octocheese/\n\t:alt: Requirements Status\n\n.. |coveralls| image:: https://img.shields.io/coveralls/github/domdfcoding/octocheese/master?logo=coveralls\n\t:target: https://coveralls.io/github/domdfcoding/octocheese?branch=master\n\t:alt: Coverage\n\n.. |codefactor| image:: https://img.shields.io/codefactor/grade/github/domdfcoding/octocheese?logo=codefactor\n\t:target: https://www.codefactor.io/repository/github/domdfcoding/octocheese\n\t:alt: CodeFactor Grade\n\n.. |pypi-version| image:: https://img.shields.io/pypi/v/octocheese\n\t:target: https://pypi.org/project/octocheese/\n\t:alt: PyPI - Package Version\n\n.. |supported-versions| image:: https://img.shields.io/pypi/pyversions/octocheese?logo=python&logoColor=white\n\t:target: https://pypi.org/project/octocheese/\n\t:alt: PyPI - Supported Python Versions\n\n.. |supported-implementations| image:: https://img.shields.io/pypi/implementation/octocheese\n\t:target: https://pypi.org/project/octocheese/\n\t:alt: PyPI - Supported Implementations\n\n.. |wheel| image:: https://img.shields.io/pypi/wheel/octocheese\n\t:target: https://pypi.org/project/octocheese/\n\t:alt: PyPI - Wheel\n\n.. |license| image:: https://img.shields.io/github/license/domdfcoding/octocheese\n\t:target: https://github.com/domdfcoding/octocheese/blob/master/LICENSE\n\t:alt: License\n\n.. |language| image:: https://img.shields.io/github/languages/top/domdfcoding/octocheese\n\t:alt: GitHub top language\n\n.. |commits-since| image:: https://img.shields.io/github/commits-since/domdfcoding/octocheese/v0.6.0\n\t:target: https://github.com/domdfcoding/octocheese/pulse\n\t:alt: GitHub commits since tagged version\n\n.. |commits-latest| image:: https://img.shields.io/github/last-commit/domdfcoding/octocheese\n\t:target: https://github.com/domdfcoding/octocheese/commit/master\n\t:alt: GitHub last commit\n\n.. |maintained| image:: https://img.shields.io/maintenance/yes/2023\n\t:alt: Maintenance\n\n.. |pypi-downloads| image:: https://img.shields.io/pypi/dm/octocheese\n\t:target: https://pypi.org/project/octocheese/\n\t:alt: PyPI - Downloads\n\n.. end shields\n\n|\n\nGitHub Actions Usage\n---------------------\n\nIn a GitHub Workflow:\n\n.. code-block:: yaml\n\n name: \"Copy PyPI to Releases\"\n on:\n - push\n\n jobs:\n releases:\n runs-on: ubuntu-latest\n steps:\n - uses: domdfcoding/octocheese@master\n with:\n pypi_name: \"domdf_python_tools\"\n env:\n GITHUB_TOKEN: ${{secrets.GITHUB_TOKEN}}\n\n\nInstalling as a Python package and script\n------------------------------------------\n\n.. start installation\n\n``OctoCheese`` can be installed from PyPI.\n\nTo install with ``pip``:\n\n.. code-block:: bash\n\n\t$ python -m pip install octocheese\n\n.. end installation\n",
"bugtrack_url": null,
"license": "LGPL-3.0-or-later",
"summary": "\ud83d\udc19 \ud83e\uddc0 \u2013 Copy PyPI Packages to GitHub Releases",
"version": "0.6.0",
"project_urls": {
"Documentation": "https://octocheese.readthedocs.io/en/latest",
"Homepage": "https://github.com/domdfcoding/octocheese",
"Issue Tracker": "https://github.com/domdfcoding/octocheese/issues",
"Source Code": "https://github.com/domdfcoding/octocheese"
},
"split_keywords": [
"github",
"github-action",
"pypi"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "2be4dea8a64ba6ccbdc10c8400c7443a70ce7d5bf54be3a3e4a571b7f15004ca",
"md5": "25019fd99212eee5486d17b37709b181",
"sha256": "491e0e113c51bf63dccc8ad20413083d00b9661183f8e95afa5a73c97d7d3755"
},
"downloads": -1,
"filename": "octocheese-0.6.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "25019fd99212eee5486d17b37709b181",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.6",
"size": 35215,
"upload_time": "2023-05-23T12:54:24",
"upload_time_iso_8601": "2023-05-23T12:54:24.931568Z",
"url": "https://files.pythonhosted.org/packages/2b/e4/dea8a64ba6ccbdc10c8400c7443a70ce7d5bf54be3a3e4a571b7f15004ca/octocheese-0.6.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "bc6f41bcdb6bf3389cd01e439cbc9620d10d5d4566d1e680e0cef15126ac3d59",
"md5": "b493e13f0843d3fa774f3d9870b537a6",
"sha256": "4b25f9aeaa8d0353e9d54dacf957adcd922eef1009b54b2c2b6677fd793a1f41"
},
"downloads": -1,
"filename": "octocheese-0.6.0.tar.gz",
"has_sig": false,
"md5_digest": "b493e13f0843d3fa774f3d9870b537a6",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.6",
"size": 11347,
"upload_time": "2023-05-23T12:54:26",
"upload_time_iso_8601": "2023-05-23T12:54:26.955834Z",
"url": "https://files.pythonhosted.org/packages/bc/6f/41bcdb6bf3389cd01e439cbc9620d10d5d4566d1e680e0cef15126ac3d59/octocheese-0.6.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-05-23 12:54:26",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "domdfcoding",
"github_project": "octocheese",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"requirements": [],
"tox": true,
"lcname": "octocheese"
}
JSON
