| Name | zinny-api JSON |
| Version |
1.0.19
JSON |
| download |
| home_page | None |
| Summary | An API backed for Zinny, the movie rating app. |
| upload_time | 2025-01-07 07:29:33 |
| maintainer | None |
| docs_url | None |
| author | Ryan Laney |
| requires_python | >=3.8 |
| license | BSD 3-Clause License Copyright (c) 2025, Ryan Laney 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
movie
rating
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
flask
jinja2
numpy
pandas
zinny_api
zinny_surveys
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# Zinny API: A Backend Server for Structured Media Evaluations
[](LICENSE)
## What's the skinny on the ciné?
Zinny API powers the backend for structured media evaluations using surveys from [zinny-surveys](https://github.com/RyLaney/zinny-surveys). It stores ratings in a SQLite database and provides endpoints for managing surveys, titles, ratings, and collections.
The API is used by the [zinny-webui](https://github.com/RyLaney/zinny-webui) frontend and the [zinny-cli](https://github.com/RyLaney/zinny-cli) command-line interface for seamless user interaction.
## Quickstart
1. Start the server:
`python zinny-api.py` or `zinny-api`
2. Open the web browser to:
`http://127.0.0.1:5219`
## API Documentation
For detailed API endpoints and usage, see [API_REFERENCE.md](https://github.com/RyLaney/zinny-api/blob/main/API_REFERENCE.md).
## Installation Details
see [SETUP.md](https://github.com/RyLaney/zinny-api/blob/main/SETUP.md)
## 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-api/blob/main/CONTRIBUTING.md) file for guidelines.
## Acknowledgements
- [Flask](https://flask.palletsprojects.com/en/1.1.x/) for the API framework.
- [PyInstaller](https://www.pyinstaller.org/) for building executables.
- [Platypus](https://github.com/sveinbjornt/Platypus) for creating macOS app bundles.
- Special thanks to [IMDb](https://www.imdb.com) for being the standard reference for movie and TV data. While no IMDb data is used directly, title information may coincide with their dataset.
- Development sponsored by [Teus Media](https://teus.media).
Raw data
{
"_id": null,
"home_page": null,
"name": "zinny-api",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.8",
"maintainer_email": null,
"keywords": "zinny, surveys, movie, rating",
"author": "Ryan Laney",
"author_email": null,
"download_url": "https://files.pythonhosted.org/packages/3d/26/805034c443763af08fc511ae88edc942d6888cb55748e9410d356f74e382/zinny_api-1.0.19.tar.gz",
"platform": null,
"description": "# Zinny API: A Backend Server for Structured Media Evaluations\n[](LICENSE)\n\n## What's the skinny on the cin\u00e9?\n\nZinny API powers the backend for structured media evaluations using surveys from [zinny-surveys](https://github.com/RyLaney/zinny-surveys). It stores ratings in a SQLite database and provides endpoints for managing surveys, titles, ratings, and collections.\n\nThe API is used by the [zinny-webui](https://github.com/RyLaney/zinny-webui) frontend and the [zinny-cli](https://github.com/RyLaney/zinny-cli) command-line interface for seamless user interaction.\n\n\n## Quickstart\n1. Start the server:\n `python zinny-api.py` or `zinny-api`\n2. Open the web browser to:\n `http://127.0.0.1:5219`\n\n\n## API Documentation\nFor detailed API endpoints and usage, see [API_REFERENCE.md](https://github.com/RyLaney/zinny-api/blob/main/API_REFERENCE.md).\n\n\n## Installation Details\n\nsee [SETUP.md](https://github.com/RyLaney/zinny-api/blob/main/SETUP.md)\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-api/blob/main/CONTRIBUTING.md) file for guidelines.\n\n\n## Acknowledgements\n- [Flask](https://flask.palletsprojects.com/en/1.1.x/) for the API framework.\n- [PyInstaller](https://www.pyinstaller.org/) for building executables.\n- [Platypus](https://github.com/sveinbjornt/Platypus) for creating macOS app bundles.\n- Special thanks to [IMDb](https://www.imdb.com) for being the standard reference for movie and TV data. While no IMDb data is used directly, title information may coincide with their dataset.\n- Development sponsored by [Teus Media](https://teus.media).\n",
"bugtrack_url": null,
"license": "BSD 3-Clause License Copyright (c) 2025, Ryan Laney 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": "An API backed for Zinny, the movie rating app.",
"version": "1.0.19",
"project_urls": {
"Homepage": "https://github.com/RyLaney/zinny-webui",
"Issues": "https://github.com/RyLaney/zinny-webui/issues"
},
"split_keywords": [
"zinny",
" surveys",
" movie",
" rating"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "ad13ad4731a18e8facff0a6e44d09ac2cfabca7909261bde3f91f534866abc01",
"md5": "b532b4e689d7aaeedf552b590e4b9692",
"sha256": "6ab6fd8e0e3901265588822fd405be36a7303b1b616cbd1bed2a2f50d664956d"
},
"downloads": -1,
"filename": "zinny_api-1.0.19-py3-none-any.whl",
"has_sig": false,
"md5_digest": "b532b4e689d7aaeedf552b590e4b9692",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.8",
"size": 32092,
"upload_time": "2025-01-07T07:29:31",
"upload_time_iso_8601": "2025-01-07T07:29:31.066050Z",
"url": "https://files.pythonhosted.org/packages/ad/13/ad4731a18e8facff0a6e44d09ac2cfabca7909261bde3f91f534866abc01/zinny_api-1.0.19-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "3d26805034c443763af08fc511ae88edc942d6888cb55748e9410d356f74e382",
"md5": "200d2f1d8bf4993b634b21df56b73b1d",
"sha256": "fbf3a86b2aaba3806e0e0f6676380eb74683b0398bc626c3cbdb142eafb0d614"
},
"downloads": -1,
"filename": "zinny_api-1.0.19.tar.gz",
"has_sig": false,
"md5_digest": "200d2f1d8bf4993b634b21df56b73b1d",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8",
"size": 35144,
"upload_time": "2025-01-07T07:29:33",
"upload_time_iso_8601": "2025-01-07T07:29:33.431061Z",
"url": "https://files.pythonhosted.org/packages/3d/26/805034c443763af08fc511ae88edc942d6888cb55748e9410d356f74e382/zinny_api-1.0.19.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2025-01-07 07:29:33",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "RyLaney",
"github_project": "zinny-webui",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"requirements": [
{
"name": "flask",
"specs": []
},
{
"name": "jinja2",
"specs": []
},
{
"name": "numpy",
"specs": []
},
{
"name": "pandas",
"specs": []
},
{
"name": "zinny_api",
"specs": []
},
{
"name": "zinny_surveys",
"specs": []
}
],
"lcname": "zinny-api"
}
