collective.icecream


Namecollective.icecream JSON
Version 1.0.0a1 PyPI version JSON
download
home_pagehttps://github.com/collective/collective.icecream
SummaryAn addon for Plone that allow you debug your code using the icecream package
upload_time2023-11-24 16:11:40
maintainer
docs_urlNone
authorale-rt
requires_python>=3.8
licenseGPL version 2
keywords python plone cms
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage
            [![image](https://github.com/collective/collective.icecream/actions/workflows/plone-package.yml/badge.svg)](https://github.com/collective/collective.icecream/actions/workflows/plone-package.yml)
[![Coveralls](https://coveralls.io/repos/github/collective/collective.icecream/badge.svg?branch=main)](https://coveralls.io/github/collective/collective.icecream?branch=main)
[![image](https://codecov.io/gh/collective/collective.icecream/branch/master/graph/badge.svg)](https://codecov.io/gh/collective/collective.icecream)
[![Latest Version](https://img.shields.io/pypi/v/collective.icecream.svg)](https://pypi.python.org/pypi/collective.icecream/)
[![Egg Status](https://img.shields.io/pypi/status/collective.icecream.svg)](https://pypi.python.org/pypi/collective.icecream)
![image](https://img.shields.io/pypi/pyversions/collective.icecream.svg?style=plastic%20%20%20:alt:%20Supported%20-%20Python%20Versions)
[![License](https://img.shields.io/pypi/l/collective.icecream.svg)](https://pypi.python.org/pypi/collective.icecream/)

# collective.icecream

An addon for Plone that does allow you to use the [icecream](https://github.com/gruns/icecream) package

## Installation

Install `collective.icecream` by adding it to your buildout, e.g.:

    [instance]
    eggs +=
        collective.icecream

and then running `bin/buildout`.

When you start your instance in foreground mode you will see:

```shell
[ale@flo collective.icecream]$ ./bin/instance fg
...
ic| 'Icecream installed'
2023-11-24 16:45:13,799 INFO    [Zope:42][MainThread] Ready to handle requests
```

Then you can use the `ic` function everywhere in your code without importing it.

You can also use it in your page templates:

```xml
<?python from icecream import ic; ic("This was placed in a template") ?>
```

TODO: it is planned to not have to import ic from icecream in the templates.

## Authors

The [Syslab.com](https://www.syslab.com) Team.

## Contributors

Put your name here, you deserve it!

- Alessandro Pisa, [Syslab.com](https://www.syslab.com)

## Contribute

- Issue Tracker:
  <https://github.com/collective/collective.icecream/issues>
- Source Code: <https://github.com/collective/collective.icecream>
- Documentation: <https://docs.plone.org/foo/bar>

## Support

If you are having issues, please let us know in the [issue tracker](https://github.com/collective/collective.icecream/issues).

## License

The project is licensed under the GPLv2.


# Contributors


- ale-rt, alessandro.pisa@gmail.com


# Changelog

## 1.0.0a1 (2023-11-24)

- Initial release.
  [ale-rt]

            

Raw data

            {
    "_id": null,
    "home_page": "https://github.com/collective/collective.icecream",
    "name": "collective.icecream",
    "maintainer": "",
    "docs_url": null,
    "requires_python": ">=3.8",
    "maintainer_email": "",
    "keywords": "Python Plone CMS",
    "author": "ale-rt",
    "author_email": "alessandro.pisa@gmail.com",
    "download_url": "https://files.pythonhosted.org/packages/dd/ae/0a0cf9b64615ebd81271b5c4ddb62a8f17ba3f01c71699b4703ee69f9d28/collective.icecream-1.0.0a1.tar.gz",
    "platform": null,
    "description": "[![image](https://github.com/collective/collective.icecream/actions/workflows/plone-package.yml/badge.svg)](https://github.com/collective/collective.icecream/actions/workflows/plone-package.yml)\n[![Coveralls](https://coveralls.io/repos/github/collective/collective.icecream/badge.svg?branch=main)](https://coveralls.io/github/collective/collective.icecream?branch=main)\n[![image](https://codecov.io/gh/collective/collective.icecream/branch/master/graph/badge.svg)](https://codecov.io/gh/collective/collective.icecream)\n[![Latest Version](https://img.shields.io/pypi/v/collective.icecream.svg)](https://pypi.python.org/pypi/collective.icecream/)\n[![Egg Status](https://img.shields.io/pypi/status/collective.icecream.svg)](https://pypi.python.org/pypi/collective.icecream)\n![image](https://img.shields.io/pypi/pyversions/collective.icecream.svg?style=plastic%20%20%20:alt:%20Supported%20-%20Python%20Versions)\n[![License](https://img.shields.io/pypi/l/collective.icecream.svg)](https://pypi.python.org/pypi/collective.icecream/)\n\n# collective.icecream\n\nAn addon for Plone that does allow you to use the [icecream](https://github.com/gruns/icecream) package\n\n## Installation\n\nInstall `collective.icecream` by adding it to your buildout, e.g.:\n\n    [instance]\n    eggs +=\n        collective.icecream\n\nand then running `bin/buildout`.\n\nWhen you start your instance in foreground mode you will see:\n\n```shell\n[ale@flo collective.icecream]$ ./bin/instance fg\n...\nic| 'Icecream installed'\n2023-11-24 16:45:13,799 INFO    [Zope:42][MainThread] Ready to handle requests\n```\n\nThen you can use the `ic` function everywhere in your code without importing it.\n\nYou can also use it in your page templates:\n\n```xml\n<?python from icecream import ic; ic(\"This was placed in a template\") ?>\n```\n\nTODO: it is planned to not have to import ic from icecream in the templates.\n\n## Authors\n\nThe [Syslab.com](https://www.syslab.com) Team.\n\n## Contributors\n\nPut your name here, you deserve it!\n\n- Alessandro Pisa, [Syslab.com](https://www.syslab.com)\n\n## Contribute\n\n- Issue Tracker:\n  <https://github.com/collective/collective.icecream/issues>\n- Source Code: <https://github.com/collective/collective.icecream>\n- Documentation: <https://docs.plone.org/foo/bar>\n\n## Support\n\nIf you are having issues, please let us know in the [issue tracker](https://github.com/collective/collective.icecream/issues).\n\n## License\n\nThe project is licensed under the GPLv2.\n\n\n# Contributors\n\n\n- ale-rt, alessandro.pisa@gmail.com\n\n\n# Changelog\n\n## 1.0.0a1 (2023-11-24)\n\n- Initial release.\n  [ale-rt]\n",
    "bugtrack_url": null,
    "license": "GPL version 2",
    "summary": "An addon for Plone that allow you debug your code using the icecream package",
    "version": "1.0.0a1",
    "project_urls": {
        "Homepage": "https://github.com/collective/collective.icecream",
        "PyPI": "https://pypi.org/project/collective.icecream/",
        "Source": "https://github.com/collective/collective.icecream",
        "Tracker": "https://github.com/collective/collective.icecream/issues"
    },
    "split_keywords": [
        "python",
        "plone",
        "cms"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "ddae0a0cf9b64615ebd81271b5c4ddb62a8f17ba3f01c71699b4703ee69f9d28",
                "md5": "bcd55df85722227439a6b7be017c6761",
                "sha256": "d1a7503b2b69423ebf66d280be83d9e5bf73fce33f8ca376a4acc23cec5ed4ff"
            },
            "downloads": -1,
            "filename": "collective.icecream-1.0.0a1.tar.gz",
            "has_sig": false,
            "md5_digest": "bcd55df85722227439a6b7be017c6761",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.8",
            "size": 11891,
            "upload_time": "2023-11-24T16:11:40",
            "upload_time_iso_8601": "2023-11-24T16:11:40.664662Z",
            "url": "https://files.pythonhosted.org/packages/dd/ae/0a0cf9b64615ebd81271b5c4ddb62a8f17ba3f01c71699b4703ee69f9d28/collective.icecream-1.0.0a1.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2023-11-24 16:11:40",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "collective",
    "github_project": "collective.icecream",
    "travis_ci": false,
    "coveralls": true,
    "github_actions": true,
    "requirements": [],
    "tox": true,
    "lcname": "collective.icecream"
}
        
Elapsed time: 0.16034s