#########
mkrecipe
#########
.. start short_desc
**A tool to create recipes for building conda packages from distributions on PyPI.**
.. end short_desc
.. 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|
* - Anaconda
- |conda-version| |conda-platform|
* - 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/mkrecipe/latest?logo=read-the-docs
:target: https://mkrecipe.readthedocs.io/en/latest
:alt: Documentation Build Status
.. |docs_check| image:: https://github.com/repo-helper/mkrecipe/workflows/Docs%20Check/badge.svg
:target: https://github.com/repo-helper/mkrecipe/actions?query=workflow%3A%22Docs+Check%22
:alt: Docs Check Status
.. |actions_linux| image:: https://github.com/repo-helper/mkrecipe/workflows/Linux/badge.svg
:target: https://github.com/repo-helper/mkrecipe/actions?query=workflow%3A%22Linux%22
:alt: Linux Test Status
.. |actions_windows| image:: https://github.com/repo-helper/mkrecipe/workflows/Windows/badge.svg
:target: https://github.com/repo-helper/mkrecipe/actions?query=workflow%3A%22Windows%22
:alt: Windows Test Status
.. |actions_macos| image:: https://github.com/repo-helper/mkrecipe/workflows/macOS/badge.svg
:target: https://github.com/repo-helper/mkrecipe/actions?query=workflow%3A%22macOS%22
:alt: macOS Test Status
.. |actions_flake8| image:: https://github.com/repo-helper/mkrecipe/workflows/Flake8/badge.svg
:target: https://github.com/repo-helper/mkrecipe/actions?query=workflow%3A%22Flake8%22
:alt: Flake8 Status
.. |actions_mypy| image:: https://github.com/repo-helper/mkrecipe/workflows/mypy/badge.svg
:target: https://github.com/repo-helper/mkrecipe/actions?query=workflow%3A%22mypy%22
:alt: mypy status
.. |requires| image:: https://dependency-dash.repo-helper.uk/github/repo-helper/mkrecipe/badge.svg
:target: https://dependency-dash.repo-helper.uk/github/repo-helper/mkrecipe/
:alt: Requirements Status
.. |coveralls| image:: https://img.shields.io/coveralls/github/repo-helper/mkrecipe/master?logo=coveralls
:target: https://coveralls.io/github/repo-helper/mkrecipe?branch=master
:alt: Coverage
.. |codefactor| image:: https://img.shields.io/codefactor/grade/github/repo-helper/mkrecipe?logo=codefactor
:target: https://www.codefactor.io/repository/github/repo-helper/mkrecipe
:alt: CodeFactor Grade
.. |pypi-version| image:: https://img.shields.io/pypi/v/mkrecipe
:target: https://pypi.org/project/mkrecipe/
:alt: PyPI - Package Version
.. |supported-versions| image:: https://img.shields.io/pypi/pyversions/mkrecipe?logo=python&logoColor=white
:target: https://pypi.org/project/mkrecipe/
:alt: PyPI - Supported Python Versions
.. |supported-implementations| image:: https://img.shields.io/pypi/implementation/mkrecipe
:target: https://pypi.org/project/mkrecipe/
:alt: PyPI - Supported Implementations
.. |wheel| image:: https://img.shields.io/pypi/wheel/mkrecipe
:target: https://pypi.org/project/mkrecipe/
:alt: PyPI - Wheel
.. |conda-version| image:: https://img.shields.io/conda/v/domdfcoding/mkrecipe?logo=anaconda
:target: https://anaconda.org/domdfcoding/mkrecipe
:alt: Conda - Package Version
.. |conda-platform| image:: https://img.shields.io/conda/pn/domdfcoding/mkrecipe?label=conda%7Cplatform
:target: https://anaconda.org/domdfcoding/mkrecipe
:alt: Conda - Platform
.. |license| image:: https://img.shields.io/github/license/repo-helper/mkrecipe
:target: https://github.com/repo-helper/mkrecipe/blob/master/LICENSE
:alt: License
.. |language| image:: https://img.shields.io/github/languages/top/repo-helper/mkrecipe
:alt: GitHub top language
.. |commits-since| image:: https://img.shields.io/github/commits-since/repo-helper/mkrecipe/v0.6.0.post1
:target: https://github.com/repo-helper/mkrecipe/pulse
:alt: GitHub commits since tagged version
.. |commits-latest| image:: https://img.shields.io/github/last-commit/repo-helper/mkrecipe
:target: https://github.com/repo-helper/mkrecipe/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/mkrecipe
:target: https://pypi.org/project/mkrecipe/
:alt: PyPI - Downloads
.. end shields
Installation
--------------
.. start installation
``mkrecipe`` can be installed from PyPI or Anaconda.
To install with ``pip``:
.. code-block:: bash
$ python -m pip install mkrecipe
To install with ``conda``:
* First add the required channels
.. code-block:: bash
$ conda config --add channels https://conda.anaconda.org/conda-forge
$ conda config --add channels https://conda.anaconda.org/domdfcoding
* Then install
.. code-block:: bash
$ conda install mkrecipe
.. end installation
Usage
-----------
``mkrecipe`` is configured in ``pyproject.toml``. See `the documentation`_ for more information.
.. _the documentation: https://mkrecipe.readthedocs.io/en/latest/configuration.html
``mkrecipe`` can then be run with the ``mkrecipe`` command when in the project directory.
This will write the conda recipe to ``./conda/meta.yaml``.
The output directory can be customised using the ``-o / --outfile`` option.
Raw data
{
"_id": null,
"home_page": "https://github.com/repo-helper/mkrecipe",
"name": "mkrecipe",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.6",
"maintainer_email": "",
"keywords": "conda,distribution,packaging,pep621",
"author": "",
"author_email": "Dominic Davis-Foster <dominic@davis-foster.co.uk>",
"download_url": "https://files.pythonhosted.org/packages/21/0a/ac9e88dd04cc3aa71f8b613f2e0cf8c5a72faf8f88ab8962f5a1c6745d75/mkrecipe-0.6.0.post1.tar.gz",
"platform": "Windows",
"description": "\n#########\nmkrecipe\n#########\n\n.. start short_desc\n\n**A tool to create recipes for building conda packages from distributions on PyPI.**\n\n.. end short_desc\n\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* - Anaconda\n\t - |conda-version| |conda-platform|\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/mkrecipe/latest?logo=read-the-docs\n\t:target: https://mkrecipe.readthedocs.io/en/latest\n\t:alt: Documentation Build Status\n\n.. |docs_check| image:: https://github.com/repo-helper/mkrecipe/workflows/Docs%20Check/badge.svg\n\t:target: https://github.com/repo-helper/mkrecipe/actions?query=workflow%3A%22Docs+Check%22\n\t:alt: Docs Check Status\n\n.. |actions_linux| image:: https://github.com/repo-helper/mkrecipe/workflows/Linux/badge.svg\n\t:target: https://github.com/repo-helper/mkrecipe/actions?query=workflow%3A%22Linux%22\n\t:alt: Linux Test Status\n\n.. |actions_windows| image:: https://github.com/repo-helper/mkrecipe/workflows/Windows/badge.svg\n\t:target: https://github.com/repo-helper/mkrecipe/actions?query=workflow%3A%22Windows%22\n\t:alt: Windows Test Status\n\n.. |actions_macos| image:: https://github.com/repo-helper/mkrecipe/workflows/macOS/badge.svg\n\t:target: https://github.com/repo-helper/mkrecipe/actions?query=workflow%3A%22macOS%22\n\t:alt: macOS Test Status\n\n.. |actions_flake8| image:: https://github.com/repo-helper/mkrecipe/workflows/Flake8/badge.svg\n\t:target: https://github.com/repo-helper/mkrecipe/actions?query=workflow%3A%22Flake8%22\n\t:alt: Flake8 Status\n\n.. |actions_mypy| image:: https://github.com/repo-helper/mkrecipe/workflows/mypy/badge.svg\n\t:target: https://github.com/repo-helper/mkrecipe/actions?query=workflow%3A%22mypy%22\n\t:alt: mypy status\n\n.. |requires| image:: https://dependency-dash.repo-helper.uk/github/repo-helper/mkrecipe/badge.svg\n\t:target: https://dependency-dash.repo-helper.uk/github/repo-helper/mkrecipe/\n\t:alt: Requirements Status\n\n.. |coveralls| image:: https://img.shields.io/coveralls/github/repo-helper/mkrecipe/master?logo=coveralls\n\t:target: https://coveralls.io/github/repo-helper/mkrecipe?branch=master\n\t:alt: Coverage\n\n.. |codefactor| image:: https://img.shields.io/codefactor/grade/github/repo-helper/mkrecipe?logo=codefactor\n\t:target: https://www.codefactor.io/repository/github/repo-helper/mkrecipe\n\t:alt: CodeFactor Grade\n\n.. |pypi-version| image:: https://img.shields.io/pypi/v/mkrecipe\n\t:target: https://pypi.org/project/mkrecipe/\n\t:alt: PyPI - Package Version\n\n.. |supported-versions| image:: https://img.shields.io/pypi/pyversions/mkrecipe?logo=python&logoColor=white\n\t:target: https://pypi.org/project/mkrecipe/\n\t:alt: PyPI - Supported Python Versions\n\n.. |supported-implementations| image:: https://img.shields.io/pypi/implementation/mkrecipe\n\t:target: https://pypi.org/project/mkrecipe/\n\t:alt: PyPI - Supported Implementations\n\n.. |wheel| image:: https://img.shields.io/pypi/wheel/mkrecipe\n\t:target: https://pypi.org/project/mkrecipe/\n\t:alt: PyPI - Wheel\n\n.. |conda-version| image:: https://img.shields.io/conda/v/domdfcoding/mkrecipe?logo=anaconda\n\t:target: https://anaconda.org/domdfcoding/mkrecipe\n\t:alt: Conda - Package Version\n\n.. |conda-platform| image:: https://img.shields.io/conda/pn/domdfcoding/mkrecipe?label=conda%7Cplatform\n\t:target: https://anaconda.org/domdfcoding/mkrecipe\n\t:alt: Conda - Platform\n\n.. |license| image:: https://img.shields.io/github/license/repo-helper/mkrecipe\n\t:target: https://github.com/repo-helper/mkrecipe/blob/master/LICENSE\n\t:alt: License\n\n.. |language| image:: https://img.shields.io/github/languages/top/repo-helper/mkrecipe\n\t:alt: GitHub top language\n\n.. |commits-since| image:: https://img.shields.io/github/commits-since/repo-helper/mkrecipe/v0.6.0.post1\n\t:target: https://github.com/repo-helper/mkrecipe/pulse\n\t:alt: GitHub commits since tagged version\n\n.. |commits-latest| image:: https://img.shields.io/github/last-commit/repo-helper/mkrecipe\n\t:target: https://github.com/repo-helper/mkrecipe/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/mkrecipe\n\t:target: https://pypi.org/project/mkrecipe/\n\t:alt: PyPI - Downloads\n\n.. end shields\n\nInstallation\n--------------\n\n.. start installation\n\n``mkrecipe`` can be installed from PyPI or Anaconda.\n\nTo install with ``pip``:\n\n.. code-block:: bash\n\n\t$ python -m pip install mkrecipe\n\nTo install with ``conda``:\n\n\t* First add the required channels\n\n\t.. code-block:: bash\n\n\t\t$ conda config --add channels https://conda.anaconda.org/conda-forge\n\t\t$ conda config --add channels https://conda.anaconda.org/domdfcoding\n\n\t* Then install\n\n\t.. code-block:: bash\n\n\t\t$ conda install mkrecipe\n\n.. end installation\n\n\nUsage\n-----------\n\n``mkrecipe`` is configured in ``pyproject.toml``. See `the documentation`_ for more information.\n\n.. _the documentation: https://mkrecipe.readthedocs.io/en/latest/configuration.html\n\n``mkrecipe`` can then be run with the ``mkrecipe`` command when in the project directory.\nThis will write the conda recipe to ``./conda/meta.yaml``.\nThe output directory can be customised using the ``-o / --outfile`` option.\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "A tool to create recipes for building conda packages from distributions on PyPI.",
"version": "0.6.0.post1",
"project_urls": {
"Documentation": "https://mkrecipe.readthedocs.io/en/latest",
"Homepage": "https://github.com/repo-helper/mkrecipe",
"Issue Tracker": "https://github.com/repo-helper/mkrecipe/issues",
"Source Code": "https://github.com/repo-helper/mkrecipe"
},
"split_keywords": [
"conda",
"distribution",
"packaging",
"pep621"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "4527b7eeb64c15f346e84a8dd39b6ac8c14f3bca23daec66a76b906375141c20",
"md5": "c43569c653bc396c195c07d9336b9b39",
"sha256": "6dabb38f4b5c0442f8ebe1834a951cc6f9152577a3a06ab64dceebef3a827889"
},
"downloads": -1,
"filename": "mkrecipe-0.6.0.post1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "c43569c653bc396c195c07d9336b9b39",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.6",
"size": 34702,
"upload_time": "2023-11-22T15:31:41",
"upload_time_iso_8601": "2023-11-22T15:31:41.492552Z",
"url": "https://files.pythonhosted.org/packages/45/27/b7eeb64c15f346e84a8dd39b6ac8c14f3bca23daec66a76b906375141c20/mkrecipe-0.6.0.post1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "210aac9e88dd04cc3aa71f8b613f2e0cf8c5a72faf8f88ab8962f5a1c6745d75",
"md5": "6488e69459e28435c47122a14c48a875",
"sha256": "377e2965ad9456cc653b97c2628ea62ca8454893ba42ac2ca7baf93d855401d0"
},
"downloads": -1,
"filename": "mkrecipe-0.6.0.post1.tar.gz",
"has_sig": false,
"md5_digest": "6488e69459e28435c47122a14c48a875",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.6",
"size": 10636,
"upload_time": "2023-11-22T15:31:43",
"upload_time_iso_8601": "2023-11-22T15:31:43.298341Z",
"url": "https://files.pythonhosted.org/packages/21/0a/ac9e88dd04cc3aa71f8b613f2e0cf8c5a72faf8f88ab8962f5a1c6745d75/mkrecipe-0.6.0.post1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-11-22 15:31:43",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "repo-helper",
"github_project": "mkrecipe",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"requirements": [],
"tox": true,
"lcname": "mkrecipe"
}