| Name | zinny-surveys JSON |
| Version |
0.1.8
JSON |
| download |
| home_page | None |
| Summary | Surveys and specifications for rating Motion Picture titles. Used by Zinny, the movei rating app. |
| upload_time | 2025-01-07 07:09:37 |
| maintainer | None |
| docs_url | None |
| author | Ryan Laney |
| requires_python | >=3.8 |
| license | BSD 3-Clause License Copyright (c) 2024, Ryan Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met: 1. Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer. 2. Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution. 3. Neither the name of the copyright holder nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission. THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. |
| keywords |
zinny
surveys
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# Zinny Surveys: Structured Media Evaluation
[](LICENSE)
## What's the skinny on the ciné?
Zinny is a tool for rating media, and the surveys here provide for a meaningful evaluation of consistent criteria across many titles and perspectives.
## A collection of survey definitions
This repo is a collection of surveys used by the [zinny-api](https://github.com/RyLaney/zinny-api) and front end [zinny-webui](https://github.com/RyLaney/zinny-webui). They are published separately to allow for independent use, and to encourage community contributions.
## Installation
see [SETUP.md](https://github.com/RyLaney/zinny-surveys/blob/main/SETUP.md)
## Motivation:
Comparing movies across genres, styles, or time periods can be challenging. Surveys offer a structured approach to evaluate films by breaking down complex elements into measurable components. This approach captures the expertise behind a movie more comprehensively than a single score.
Surveys define measurable criteria, while weights establish their relative importance, making evaluations both meaningful and customizable.
## Goals
* **Standardization:** Standardization: Provide curated surveys and weights for consistent and reliable evaluations.
* **Customization:** Easily create or modify JSON-based surveys and weights to fit specific needs.
* **Community Contributions:** Contributions are welcome to expand criteria or add new surveys. Submit pull requests or reach out to get involved.
## Definitions
### Surveys
## Definitions
### Surveys
**Survey:** A predefined set of criteria for evaluating a media title. Each survey includes:
* **Metadata:** Describes the survey's purpose, version, author, and related details.
* **Criteria:** Individual measures with attributes such as range and descriptions.
**Criteria:**
* Criteria are measurable attributes within a survey, defined as:
* **ID:** A unique identifier (e.g., "artistry").
* **Name:** A human-readable label (e.g., "Artistry").
* **Description:** Details what the criterion measures.
* **Range:** (optional) Specifies valid scoring values (e.g., [1,10]).
* **Value Labels:** (optional) Explains specific values within the range (e.g., 0: "No quality", 10: "best quality").
#### Repository Structure
#### Repository Structure
```plaintext
surveys/
├── shared/ # Institutionally approved surveys
│ ├── vfx.json
│ ├── picture.json
│ └── ...
├── community/ # Community-contributed surveys
└── local/ # reserved for local surveys
```
#### Example JSON Representation:
see [Examples.md](https://github.com/RyLaney/zinny-surveys/blob/main/docs/Examples.md)
### Weight Presets
**Weights:**
Weights determine the relative importance of each survey criterion. They are linked to specific surveys (and optionally, survey versions) and allow for multiple perspectives by using different weight configurations.
#### Repository Structure
```plaintext
weights/ # Weighting configurations
├── shared/ # Institutionally approved weights
│ ├── vfx_even_weights.json
│ ├── picture_even_weights.json
│ ├── picture_storyteller.json
│ └── picture_technologist.json
├── community/ # Community-contributed weights
└── local/ # reserved for local weights
```
## Collections
**Collection:**
Collections group related items, such as titles or surveys, into curated sets. Each collection includes:
* **ID:** A unique identifier (e.g., "favorites_2024").
* **Name:** A human-readable name (e.g., "My Favorites").
* **Description:** Optional context for the collection (e.g., "Movies to watch this year.").
* **Items:** A list of either titles or surveys in the collection.
* **Titles:** Include name (e.g., "Madame Web") and year (e.g., 2024).
* **Surveys:** Include name (e.g., "VFX Evaluation") and version (e.g., "1.0").
## Contributing
We welcome contributions! If you'd like to report an issue, suggest a feature, or contribute code, please check out the [CONTRIBUTING.md](https://github.com/RyLaney/zinny-surveys/blob/main/CONTRIBUTING.md) file for guidelines.
## Acknowledgements
- Development was sponsored by [Teus Media](https://teus.media).
Raw data
{
"_id": null,
"home_page": null,
"name": "zinny-surveys",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.8",
"maintainer_email": null,
"keywords": "zinny, surveys",
"author": "Ryan Laney",
"author_email": null,
"download_url": "https://files.pythonhosted.org/packages/6a/a4/eb67605e70e51dea9fe2240cc5539e903df2222f4bd25b3f8d36cc4be57b/zinny_surveys-0.1.8.tar.gz",
"platform": null,
"description": "# Zinny Surveys: Structured Media Evaluation\n[](LICENSE)\n\n## What's the skinny on the cin\u00e9?\n\nZinny is a tool for rating media, and the surveys here provide for a meaningful evaluation of consistent criteria across many titles and perspectives.\n\n## A collection of survey definitions\n\nThis repo is a collection of surveys used by the [zinny-api](https://github.com/RyLaney/zinny-api) and front end [zinny-webui](https://github.com/RyLaney/zinny-webui). They are published separately to allow for independent use, and to encourage community contributions.\n\n## Installation\n\nsee [SETUP.md](https://github.com/RyLaney/zinny-surveys/blob/main/SETUP.md)\n\n## Motivation:\nComparing movies across genres, styles, or time periods can be challenging. Surveys offer a structured approach to evaluate films by breaking down complex elements into measurable components. This approach captures the expertise behind a movie more comprehensively than a single score.\n\nSurveys define measurable criteria, while weights establish their relative importance, making evaluations both meaningful and customizable.\n\n## Goals\n\n* **Standardization:** Standardization: Provide curated surveys and weights for consistent and reliable evaluations.\n\n* **Customization:** Easily create or modify JSON-based surveys and weights to fit specific needs.\n\n* **Community Contributions:** Contributions are welcome to expand criteria or add new surveys. Submit pull requests or reach out to get involved.\n\n\n## Definitions\n\n### Surveys\n## Definitions\n\n### Surveys\n**Survey:** A predefined set of criteria for evaluating a media title. Each survey includes:\n* **Metadata:** Describes the survey's purpose, version, author, and related details.\n* **Criteria:** Individual measures with attributes such as range and descriptions.\n\n**Criteria:**\n* Criteria are measurable attributes within a survey, defined as:\n * **ID:** A unique identifier (e.g., \"artistry\").\n * **Name:** A human-readable label (e.g., \"Artistry\").\n * **Description:** Details what the criterion measures.\n * **Range:** (optional) Specifies valid scoring values (e.g., [1,10]).\n * **Value Labels:** (optional) Explains specific values within the range (e.g., 0: \"No quality\", 10: \"best quality\").\n\n#### Repository Structure\n#### Repository Structure\n\n```plaintext\nsurveys/\n\u251c\u2500\u2500 shared/ # Institutionally approved surveys\n\u2502 \u251c\u2500\u2500 vfx.json\n\u2502 \u251c\u2500\u2500 picture.json\n\u2502 \u2514\u2500\u2500 ...\n\u251c\u2500\u2500 community/ # Community-contributed surveys\n\u2514\u2500\u2500 local/ # reserved for local surveys\n```\n\n#### Example JSON Representation:\nsee [Examples.md](https://github.com/RyLaney/zinny-surveys/blob/main/docs/Examples.md)\n\n### Weight Presets\n**Weights:**\nWeights determine the relative importance of each survey criterion. They are linked to specific surveys (and optionally, survey versions) and allow for multiple perspectives by using different weight configurations.\n\n#### Repository Structure\n\n```plaintext\nweights/ # Weighting configurations\n\u251c\u2500\u2500 shared/ # Institutionally approved weights\n\u2502 \u251c\u2500\u2500 vfx_even_weights.json\n\u2502 \u251c\u2500\u2500 picture_even_weights.json\n\u2502 \u251c\u2500\u2500 picture_storyteller.json\n\u2502 \u2514\u2500\u2500 picture_technologist.json\n\u251c\u2500\u2500 community/ # Community-contributed weights\n\u2514\u2500\u2500 local/ # reserved for local weights\n```\n\n## Collections\n\n**Collection:**\nCollections group related items, such as titles or surveys, into curated sets. Each collection includes:\n * **ID:** A unique identifier (e.g., \"favorites_2024\").\n * **Name:** A human-readable name (e.g., \"My Favorites\").\n * **Description:** Optional context for the collection (e.g., \"Movies to watch this year.\").\n * **Items:** A list of either titles or surveys in the collection.\n * **Titles:** Include name (e.g., \"Madame Web\") and year (e.g., 2024).\n * **Surveys:** Include name (e.g., \"VFX Evaluation\") and version (e.g., \"1.0\").\n\n## Contributing\nWe welcome contributions! If you'd like to report an issue, suggest a feature, or contribute code, please check out the [CONTRIBUTING.md](https://github.com/RyLaney/zinny-surveys/blob/main/CONTRIBUTING.md) file for guidelines.\n\n## Acknowledgements\n- Development was sponsored by [Teus Media](https://teus.media).\n",
"bugtrack_url": null,
"license": "BSD 3-Clause License Copyright (c) 2024, Ryan Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met: 1. Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer. 2. Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution. 3. Neither the name of the copyright holder nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission. THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS \"AS IS\" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. ",
"summary": "Surveys and specifications for rating Motion Picture titles. Used by Zinny, the movei rating app.",
"version": "0.1.8",
"project_urls": {
"Homepage": "https://github.com/RyLaney/zinny-surveys",
"Issues": "https://github.com/RyLaney/zinny-surveys/issues"
},
"split_keywords": [
"zinny",
" surveys"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "be543a077a55a0013625a3ed4df09cb20a33ce271657c666abf9a3f1d6a73394",
"md5": "d535ba6152f5207541582573b99b21e0",
"sha256": "035607457870a076e21e0c83ab4c403a6e2199337aa2f08eb12ef592582f52bc"
},
"downloads": -1,
"filename": "zinny_surveys-0.1.8-py3-none-any.whl",
"has_sig": false,
"md5_digest": "d535ba6152f5207541582573b99b21e0",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.8",
"size": 20031,
"upload_time": "2025-01-07T07:09:33",
"upload_time_iso_8601": "2025-01-07T07:09:33.806450Z",
"url": "https://files.pythonhosted.org/packages/be/54/3a077a55a0013625a3ed4df09cb20a33ce271657c666abf9a3f1d6a73394/zinny_surveys-0.1.8-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "6aa4eb67605e70e51dea9fe2240cc5539e903df2222f4bd25b3f8d36cc4be57b",
"md5": "791548491fca40e2059debe596bfaf24",
"sha256": "4e62306085adaa36c067cd7b59df20560182c9f2ecd91a04d11faf2ec8a5d272"
},
"downloads": -1,
"filename": "zinny_surveys-0.1.8.tar.gz",
"has_sig": false,
"md5_digest": "791548491fca40e2059debe596bfaf24",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8",
"size": 14483,
"upload_time": "2025-01-07T07:09:37",
"upload_time_iso_8601": "2025-01-07T07:09:37.759715Z",
"url": "https://files.pythonhosted.org/packages/6a/a4/eb67605e70e51dea9fe2240cc5539e903df2222f4bd25b3f8d36cc4be57b/zinny_surveys-0.1.8.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2025-01-07 07:09:37",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "RyLaney",
"github_project": "zinny-surveys",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"lcname": "zinny-surveys"
}
