{ "info": { "author": "John Freeman", "author_email": "jfreeman08@gmail.com", "bugtrack_url": null, "classifiers": [ "License :: OSI Approved", "Programming Language :: Python :: 3", "Programming Language :: Python :: 3.6", "Programming Language :: Python :: 3.7" ], "description": ".. start-include\n\n=======\ncupcake\n=======\n\nMake C++ a piece of cake.\n\n.. image:: https://travis-ci.org/thejohnfreeman/cupcake.svg?branch=master\n :target: https://travis-ci.org/thejohnfreeman/cupcake\n :alt: Build status\n\n.. image:: https://readthedocs.org/projects/cupcake/badge/?version=latest\n :target: https://cupcake.readthedocs.io/\n :alt: Documentation status\n\n.. image:: https://img.shields.io/pypi/v/cupcake.svg\n :target: https://pypi.org/project/cupcake/\n :alt: Latest PyPI version\n\n.. image:: https://img.shields.io/pypi/pyversions/cupcake.svg\n :target: https://pypi.org/project/cupcake/\n :alt: Python versions supported\n\nCupcake is a thin layer over CMake_ and Conan_ that tries to offer\na better user experience in the style of Yarn_ or Poetry_.\n\n.. _CMake: https://cmake.org/cmake/help/latest/manual/cmake.1.html\n.. _Conan: https://docs.conan.io/\n.. _Yarn: https://yarnpkg.com/en/\n.. _Poetry: https://poetry.eustace.io/\n\n\nAudience\n========\n\nTo use this tool, your C++ project must fit a certain profile and follow some\nconventions. The profile is what I call a **basic C++ project**:\n\n- A **name** that is a valid C++ identifier.\n- Zero or more **public dependencies**. These may be runtime dependencies of\n the library or executables, or they may be build time dependencies of the\n public headers. Users must install the public dependencies when they install\n the project.\n- Some **public headers** nested under a directory named after the project.\n- One **library**, named after the project, that can be linked statically or\n dynamically (with no other options). The library depends on the public\n headers and the public dependencies.\n- Zero or more **executables** that depend on the public headers, the library,\n and the public dependencies.\n- Zero or more **private dependencies**. These are often test frameworks.\n Developers working on the library expect them to be installed, but users of\n the library do not.\n- Zero or more **tests** that depend on the public headers, the library, the\n public dependencies, and the private dependencies.\n\nThe conventions are popular in the community and seem to be considered__\nbest__ practices__:\n\n.. __: https://www.youtube.com/watch?v=eC9-iRN2b04\n.. __: https://pabloariasal.github.io/2018/02/19/its-time-to-do-cmake-right/\n.. __: https://unclejimbo.github.io/2018/06/08/Modern-CMake-for-Library-Developers/\n\n- The project is built and installed with **CMake** [#]_.\n- The project uses **semantic versioning**.\n- The project installs itself relative to a **prefix**. Public headers are\n installed in ``include/``; static and dynamic libraries are installed in\n ``lib/``; executables are installed in ``bin/``.\n- The project installs a `CMake package configuration file`__ that exports\n a target for the library. The target is named after the project, and it is\n scoped within a namespace named after the project. Dependents link against\n that target with the **same syntax** whether it was installed with CMake or\n with Conan.\n\n.. __: https://cmake.org/cmake/help/latest/manual/cmake-packages.7.html#package-configuration-file\n\n\nCommands\n========\n\n``package``\n-----------\n\nThis abstracts the ``conan create`` `\u2197\ufe0f`__ command. It:\n\n.. __: https://docs.conan.io/en/latest/reference/commands/creator/create.html\n\n- Copies a Conan recipe for your project to your local Conan cache, a la\n ``conan export`` `\u2197\ufe0f`__.\n\n .. __: https://docs.conan.io/en/latest/reference/commands/creator/export.html\n\n- Builds the recipe for your current settings (CPU architecture, operating\n system, compiler) and the ``Release`` build type, a la ``conan install``\n `\u2197\ufe0f`__.\n\n .. __: https://docs.conan.io/en/latest/reference/commands/consumer/install.html\n\n- Configures and builds an example that depends on your project as a test of\n its packaging, a la ``conan\n test`` `\u2197\ufe0f`__. That example must reside in the ``example/`` directory of your\n project with a ``CMakeLists.txt`` that looks like this:\n\n .. __: https://docs.conan.io/en/latest/reference/commands/creator/test.html\n\n .. code-block:: cmake\n\n add_executable(example example.cpp)\n target_link_libraries(example ${PROJECT_NAME}::${PROJECT_NAME})\n\n .. TODO: example.cpp in place of example/ directory.\n\n\nEtymology\n=========\n\nI love Make_, but it's just not cross-platform. Just about every other\nsingle letter prefix of \"-ake\" is taken, including the obvious candidate for\nC++ (but stolen by C#), Cake_. From there, it's a small step to Cppcake,\nwhich needs an easy pronunciation. \"Cupcake\" works. I prefer names to be\nspelled with an unambiguous pronunciation so that readers are not left\nconfused, so I might as well name the tool Cupcake. A brief `Google\nsearch`__ appears to confirm\nthe name is unclaimed in the C++ community.\n\n.. _Make: https://www.gnu.org/software/make/\n.. _Cake: https://cakebuild.net/\n.. __: https://www.google.com/search?q=c%2B%2B+cupcake\n\n\n.. [#] CMake likes to remind everyone that it is a build system *generator*,\n not a build system, but it is reaching a level of abstraction that lets\n us think of it as a cross-platform build system.\n\n.. end-include\n", "description_content_type": "text/x-rst", "docs_url": null, "download_url": "", "downloads": { "last_day": -1, "last_month": -1, "last_week": -1 }, "home_page": "https://github.com/thejohnfreeman/cupcake/", "keywords": "", "license": "ISC", "maintainer": "John Freeman", "maintainer_email": "jfreeman08@gmail.com", "name": "cupcake", "package_url": "https://pypi.org/project/cupcake/", "platform": "", "project_url": "https://pypi.org/project/cupcake/", "project_urls": { "Documentation": "https://cupcake.readthedocs.io/", "Homepage": "https://github.com/thejohnfreeman/cupcake/", "Repository": "https://github.com/thejohnfreeman/cupcake/" }, "release_url": "https://pypi.org/project/cupcake/0.0.4/", "requires_dist": [ "sphinx (>=1.8,<2.0); extra == \"docs\"", "sphinx_rtd_theme (>=0.4.3,<0.5.0); extra == \"docs\"", "toml (>=0.10.0,<0.11.0); extra == \"docs\"", "click (>=7.0,<8.0)", "semantic_version (>=2.6,<3.0)", "cmakelists_parsing (>=0.3.1,<0.4.0)", "cached-property (>=1.5,<2.0)", "dataclasses (>=0.6.0,<0.7.0)", "conan (>=1.15,<2.0)", "toolz (>=0.9.0,<0.10.0)", "pydantic (>=0.29.0,<0.30.0)" ], "requires_python": ">=3.6,<4.0", "summary": "Make C++ a piece of cake.", "version": "0.0.4" }, "last_serial": 5479320, "releases": { "0.0.1": [ { "comment_text": "", "digests": { "md5": "0733188df7f6561c9861a7e5482c8d18", "sha256": "40ebc86cb8ba9f8e318c11c045497c50dfdcadf3352b021709f3cc17cbe66c6c" }, "downloads": -1, "filename": "cupcake-0.0.1-py3-none-any.whl", "has_sig": false, "md5_digest": "0733188df7f6561c9861a7e5482c8d18", "packagetype": "bdist_wheel", "python_version": "py3", "requires_python": ">=3.6-dev,<4.0", "size": 10794, "upload_time": "2019-06-11T19:35:34", "url": "https://files.pythonhosted.org/packages/5c/47/789f397f8e61db083372d388a32ec59462880bdca57da40fe38382fed597/cupcake-0.0.1-py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "47bfd7bd1b10b8e052a06750f8b33a69", "sha256": "d8333b7cd3c044ab127c981c43e939a99c7553f33c8e9ba3a1fd22963045d46b" }, "downloads": -1, "filename": "cupcake-0.0.1.tar.gz", "has_sig": false, "md5_digest": "47bfd7bd1b10b8e052a06750f8b33a69", "packagetype": "sdist", "python_version": "source", "requires_python": ">=3.6-dev,<4.0", "size": 11810, "upload_time": "2019-06-11T19:35:37", "url": "https://files.pythonhosted.org/packages/ae/8e/b33badd082e6afd03405c3f7ecdb88051bc463ef54270b70c653a67ca24b/cupcake-0.0.1.tar.gz" } ], "0.0.2": [ { "comment_text": "", "digests": { "md5": "d21026678b51794ec604aad77ad09c86", "sha256": "37e38888667cfc0f8eb6878bc2de2c248501495f8fec94319878ee4d256ad37a" }, "downloads": -1, "filename": "cupcake-0.0.2-py3-none-any.whl", "has_sig": false, "md5_digest": "d21026678b51794ec604aad77ad09c86", "packagetype": "bdist_wheel", "python_version": "py3", "requires_python": ">=3.6-dev,<4.0", "size": 10808, "upload_time": "2019-06-11T20:56:13", "url": "https://files.pythonhosted.org/packages/54/f4/76f5eee7da2acb1a0d52d2a0389152749a6260ede2bb573aede0ed876a2c/cupcake-0.0.2-py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "8e3fd6cbfd7792045dfa144ab7f014ee", "sha256": "7fefdd1d040b26be1a2332f56e2ef144872147e2c9a7f88def955add900f9b45" }, "downloads": -1, "filename": "cupcake-0.0.2.tar.gz", "has_sig": false, "md5_digest": "8e3fd6cbfd7792045dfa144ab7f014ee", "packagetype": "sdist", "python_version": "source", "requires_python": ">=3.6-dev,<4.0", "size": 11823, "upload_time": "2019-06-11T20:56:15", "url": "https://files.pythonhosted.org/packages/d0/33/a16064896154652741ab3bca453bccbd4b5ee9b35ebedecdcb585071de22/cupcake-0.0.2.tar.gz" } ], "0.0.3": [ { "comment_text": "", "digests": { "md5": "d358051c14d3324dddaf7fd0fb58bff5", "sha256": "d0ea191a09a155950c786e8a492f780c2eea25841b0c62108d275fca8db921cd" }, "downloads": -1, "filename": "cupcake-0.0.3-py3-none-any.whl", "has_sig": false, "md5_digest": "d358051c14d3324dddaf7fd0fb58bff5", "packagetype": "bdist_wheel", "python_version": "py3", "requires_python": ">=3.6-dev,<4.0", "size": 10805, "upload_time": "2019-06-11T21:22:20", "url": "https://files.pythonhosted.org/packages/46/f7/ed77ff6e6e89fbe15fc881401920edeba33f70c15695aa37f490d19fe6da/cupcake-0.0.3-py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "d1418c24d1cc43b4f1414335423d7c31", "sha256": "f2ef53d89c59ca441c6abb030480f811256c52fb63cf677f827cab0996849f5b" }, "downloads": -1, "filename": "cupcake-0.0.3.tar.gz", "has_sig": false, "md5_digest": "d1418c24d1cc43b4f1414335423d7c31", "packagetype": "sdist", "python_version": "source", "requires_python": ">=3.6-dev,<4.0", "size": 11822, "upload_time": "2019-06-11T21:22:21", "url": "https://files.pythonhosted.org/packages/21/1f/4d2e3658965fe28185336f1143619552361f31cca93e90c7b9ddfd6ffa1c/cupcake-0.0.3.tar.gz" } ], "0.0.4": [ { "comment_text": "", "digests": { "md5": "432ec9135f737732a467ffb81a721ff8", "sha256": "80f2de725849d45b23ed99fb88b3d8de526de8f66ba27c357a50fa04383b0600" }, "downloads": -1, "filename": "cupcake-0.0.4-py3-none-any.whl", "has_sig": false, "md5_digest": "432ec9135f737732a467ffb81a721ff8", "packagetype": "bdist_wheel", "python_version": "py3", "requires_python": ">=3.6,<4.0", "size": 11690, "upload_time": "2019-07-03T03:47:14", "url": "https://files.pythonhosted.org/packages/5b/b0/3b2477856ba8102e4d7dddfc282384757f11f4a7f318cbe9bcf4988d2368/cupcake-0.0.4-py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "9f8048cac7912b7b3283aac7bbe7a942", "sha256": "84f87a95f21ccf4af59805bab3b01ae0b2f1a06c1014a5d55f25af00df7e8d35" }, "downloads": -1, "filename": "cupcake-0.0.4.tar.gz", "has_sig": false, "md5_digest": "9f8048cac7912b7b3283aac7bbe7a942", "packagetype": "sdist", "python_version": "source", "requires_python": ">=3.6,<4.0", "size": 12343, "upload_time": "2019-07-03T03:47:16", "url": "https://files.pythonhosted.org/packages/20/8e/94837bdeee29dbc155afe4332e8d138cef2b028c141f579129357c0ce148/cupcake-0.0.4.tar.gz" } ] }, "urls": [ { "comment_text": "", "digests": { "md5": "432ec9135f737732a467ffb81a721ff8", "sha256": "80f2de725849d45b23ed99fb88b3d8de526de8f66ba27c357a50fa04383b0600" }, "downloads": -1, "filename": "cupcake-0.0.4-py3-none-any.whl", "has_sig": false, "md5_digest": "432ec9135f737732a467ffb81a721ff8", "packagetype": "bdist_wheel", "python_version": "py3", "requires_python": ">=3.6,<4.0", "size": 11690, "upload_time": "2019-07-03T03:47:14", "url": "https://files.pythonhosted.org/packages/5b/b0/3b2477856ba8102e4d7dddfc282384757f11f4a7f318cbe9bcf4988d2368/cupcake-0.0.4-py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "9f8048cac7912b7b3283aac7bbe7a942", "sha256": "84f87a95f21ccf4af59805bab3b01ae0b2f1a06c1014a5d55f25af00df7e8d35" }, "downloads": -1, "filename": "cupcake-0.0.4.tar.gz", "has_sig": false, "md5_digest": "9f8048cac7912b7b3283aac7bbe7a942", "packagetype": "sdist", "python_version": "source", "requires_python": ">=3.6,<4.0", "size": 12343, "upload_time": "2019-07-03T03:47:16", "url": "https://files.pythonhosted.org/packages/20/8e/94837bdeee29dbc155afe4332e8d138cef2b028c141f579129357c0ce148/cupcake-0.0.4.tar.gz" } ] }