Metadata-Version: 2.4
Name: collective.casestudy
Version: 1.0.0b1
Summary: Case Study content type for Plone.
Project-URL: Changelog, https://github.com/collective/collective.casestudy/blob/main/CHANGELOG.md
Project-URL: Homepage, https://github.com/collective/collective.casestudy
Project-URL: Issues, https://github.com/collective/collective.casestudy/issues
Project-URL: Repository, https://github.com/collective/collective.casestudy/
Author-email: Érico Andrei <ericof@plone.org>
License: GNU General Public License v2 (GPLv2)
License-File: LICENSE.md
Keywords: Plone,Python
Classifier: Development Status :: 5 - Production/Stable
Classifier: Environment :: Web Environment
Classifier: Framework :: Plone
Classifier: Framework :: Plone :: 6.0
Classifier: Framework :: Plone :: 6.1
Classifier: Framework :: Plone :: Addon
Classifier: Framework :: Zope
Classifier: Framework :: Zope :: 5
Classifier: License :: OSI Approved :: GNU General Public License v2 (GPLv2)
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3 :: Only
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.13
Requires-Python: >=3.10
Requires-Dist: plone-api
Requires-Dist: plone-restapi
Requires-Dist: plone-volto
Requires-Dist: products-cmfplone>=6.0.0
Requires-Dist: pycountry
Provides-Extra: test
Requires-Dist: collective-mockmailhost; extra == 'test'
Requires-Dist: horse-with-no-namespace; extra == 'test'
Requires-Dist: plone-app-robotframework[debug]; extra == 'test'
Requires-Dist: plone-app-testing; extra == 'test'
Requires-Dist: plone-restapi[test]; extra == 'test'
Requires-Dist: pytest-cov; extra == 'test'
Requires-Dist: pytest-plone>=1.0.0a1; extra == 'test'
Requires-Dist: zest-releaser[recommended]; extra == 'test'
Requires-Dist: zest-releaser[recommended]>=9.5.0; extra == 'test'
Requires-Dist: zestreleaser-towncrier>=1.3.0; extra == 'test'
Description-Content-Type: text/markdown

<div align="center"><img alt="logo" src="https://raw.githubusercontent.com/collective/collective.casestudy/main/docs/icon.svg" width="70" /></div>

<h1 align="center">A Case Study content type for Plone</h1>

<div align="center">

[![PyPI](https://img.shields.io/pypi/v/collective.casestudy)](https://pypi.org/project/collective.casestudy/)
[![PyPI - Python Version](https://img.shields.io/pypi/pyversions/collective.casestudy)](https://pypi.org/project/collective.casestudy/)
[![PyPI - Wheel](https://img.shields.io/pypi/wheel/collective.casestudy)](https://pypi.org/project/collective.casestudy/)
[![PyPI - License](https://img.shields.io/pypi/l/collective.casestudy)](https://pypi.org/project/collective.casestudy/)
[![PyPI - Status](https://img.shields.io/pypi/status/collective.casestudy)](https://pypi.org/project/collective.casestudy/)


[![PyPI - Plone Versions](https://img.shields.io/pypi/frameworkversions/plone/collective.casestudy)](https://pypi.org/project/collective.casestudy/)

[![CI](https://github.com/collective/collective.casestudy/actions/workflows/ci.yml/badge.svg)](https://github.com/collective/collective.casestudy/actions/workflows/ci.yml)

[![GitHub contributors](https://img.shields.io/github/contributors/collective/collective.casestudy)](https://github.com/collective/collective.casestudy)
[![GitHub Repo stars](https://img.shields.io/github/stars/collective/collective.casestudy?style=social)](https://github.com/collective/collective.casestudy)

</div>

## Features

`collective.casestudy` provides two new content types to be used in Plone sites, Case Study and Provider.

### Case Study

A case study of a Plone deployment, which has attributes to track the Plone version used, the industry, and the type of usage of Plone.

### Provider

A company providing Plone services and solutions.

## See it in action

**collective.casestudy** is being used in the following sites:

* [Plone.org](https://plone.org)
* [Plone Brasil](https://plone.org.br)

## Documentation

This package supports Plone sites using Volto, but each project should provide its view for this content type.


### Installation

Add **collective.casestudy** to the Plone installation using `pip`:

```bash
pip install collective.casestudy
```
or add it as a dependency on your package's `setup.py`

```python
    install_requires = [
        "Plone",
        "plone.restapi",
        "collective.casestudy",
    ],
```

Start Plone and activate the plugin in the addons control-panel.


## Source Code and Contributions

We welcome contributions to `collective.casestudy`.
You can create an issue in the issue tracker, or contact a maintainer.

- [Issue Tracker](https://github.com/collective/collective.casestudy/issues)
- [Source Code](https://github.com/collective/collective.casestudy/)



### Development

You need a working Python environment version 3.10 or later.

Then install the dependencies and a development instance using:

```bash
make install
```

By default, we use the latest Plone version in the 6.x series.

## License

The project is licensed under GPLv2.
