Metadata-Version: 2.1
Name: octocheese
Version: 0.0.2
Summary: Copy PyPI Packages to GitHub Releases
Home-page: https://github.com/domdfcoding/octocheese
Author: Dominic Davis-Foster
Author-email: dominic@davis-foster.co.uk
License: GNU Lesser General Public License v3 or later (LGPLv3+)
Project-URL: Documentation, https://octocheese.readthedocs.io
Project-URL: Issue Tracker, https://github.com/domdfcoding/octocheese/issues
Project-URL: Source Code, https://github.com/domdfcoding/octocheese
Platform: UNKNOWN
Classifier: Development Status :: 4 - Beta
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: GNU Lesser General Public License v3 or later (LGPLv3+)
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3 :: Only
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: Implementation :: CPython
Classifier: Topic :: Utilities
Requires-Python: >=3.6
Requires-Dist: PyGithub (>=1.51)
Requires-Dist: requests (>=2.24.0)
Requires-Dist: dulwich (>=0.20.5)
Requires-Dist: domdf-python-tools (>=0.3.8)
Provides-Extra: all

#############
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
	  - |travis| |actions_windows| |actions_macos| |codefactor|
	* - PyPI
	  - |pypi-version| |supported-versions| |supported-implementations| |wheel|
	* - Activity
	  - |commits-latest| |commits-since| |maintained|
	* - Other
	  - |license| |language| |requires|

.. |docs| image:: https://img.shields.io/readthedocs/octocheese/latest?logo=read-the-docs
	:target: https://octocheese.readthedocs.io/en/latest/?badge=latest
	:alt: Documentation 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

.. |travis| image:: https://img.shields.io/travis/com/domdfcoding/octocheese/master?logo=travis
	:target: https://travis-ci.com/domdfcoding/octocheese
	:alt: Travis Build Status

.. |actions_windows| image:: https://github.com/domdfcoding/octocheese/workflows/Windows%20Tests/badge.svg
	:target: https://github.com/domdfcoding/octocheese/actions?query=workflow%3A%22Windows+Tests%22
	:alt: Windows Tests Status

.. |actions_macos| image:: https://github.com/domdfcoding/octocheese/workflows/macOS%20Tests/badge.svg
	:target: https://github.com/domdfcoding/octocheese/actions?query=workflow%3A%22macOS+Tests%22
	:alt: macOS Tests Status

.. |requires| image:: https://requires.io/github/domdfcoding/octocheese/requirements.svg?branch=master
	:target: https://requires.io/github/domdfcoding/octocheese/requirements/?branch=master
	:alt: Requirements Status

.. |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
	: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
	:alt: License
	:target: https://github.com/domdfcoding/octocheese/blob/master/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.0.2
	: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/2020
	:alt: Maintenance

.. 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



