| Name | citric JSON |
| Version |
1.0.0
JSON |
| download |
| home_page | |
| Summary | A client to the LimeSurvey Remote Control API 2, written in modern Python. |
| upload_time | 2024-02-13 02:31:43 |
| maintainer | |
| docs_url | None |
| author | |
| requires_python | >=3.8 |
| license | MIT License Copyright (c) 2019, Edgar Ramírez Mondragón Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. |
| keywords |
json-rpc
limesurvey
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
<div align="center">
# Citric
<table>
<tbody>
<tr>
<td>Project Health</td>
<td>
<a href="https://polar.sh/edgarrmondragon">
<img src="https://polar.sh/embed/seeks-funding-shield.svg?org=edgarrmondragon"/>
</a>
<a href="https://results.pre-commit.ci/latest/github/edgarrmondragon/citric/main">
<img alt="pre-commit.ci status" src="https://results.pre-commit.ci/badge/github/edgarrmondragon/citric/main.svg"/>
</a>
<a href="https://citric.readthedocs.io/en/latest/?badge=latest">
<img alt="Documentation Status" src="https://readthedocs.org/projects/citric/badge/?version=latest"/>
</a>
<a href="https://codecov.io/gh/edgarrmondragon/citric">
<img alt="codecov" src="https://codecov.io/gh/edgarrmondragon/citric/branch/main/graph/badge.svg"/>
</a>
</td>
</tr>
<tr>
<td>Packaging</td>
<td>
<a href="https://pypi.org/project/citric">
<img alt="PyPI version" src="https://img.shields.io/pypi/v/citric.svg?logo=pypi&logoColor=FFE873&color=blue"/>
</a>
<a href="https://pypi.org/project/citric">
<img alt="Python versions" src="https://img.shields.io/pypi/pyversions/citric.svg?logo=python&logoColor=FFE873"/>
</a>
<a href="https://pypi.org/project/citric">
<img alt="PyPI - Downloads" src="https://img.shields.io/pypi/dm/citric?color=blue"/>
</a>
<a href="https://anaconda.org/conda-forge/citric">
<img alt="Conda Version" src="https://img.shields.io/conda/vn/conda-forge/citric.svg"/>
</a>
</tr>
<tr>
<td>Misc</td>
<td>
<a href="https://github.com/astral-sh/ruff">
<img src="https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/charliermarsh/ruff/main/assets/badge/v2.json" alt="Ruff" style="max-width:100%;">
</a>
<a href="https://github.com/wntrblm/nox">
<img alt="Nox" src="https://img.shields.io/badge/%F0%9F%A6%8A-Nox-D85E00.svg"/>
</a>
<a href="https://github.com/pypa/hatch">
<img alt="Hatch project" src="https://img.shields.io/badge/%F0%9F%A5%9A-Hatch-4051b5.svg"/>
</a>
<a href="https://github.com/edgarrmondragon/citric/blob/main/LICENSE">
<img alt="License" src="https://img.shields.io/github/license/edgarrmondragon/citric"/>
</a>
<a href="https://zenodo.org/doi/10.5281/zenodo.10216279">
<img src="https://zenodo.org/badge/223537606.svg" alt="DOI">
</a>
<br />
<a href="https://www.bestpractices.dev/projects/8144">
<img src="https://www.bestpractices.dev/projects/8144/badge">
</a>
<a href="https://securityscorecards.dev/viewer/?uri=github.com/edgarrmondragon/citric">
<img src="https://api.securityscorecards.dev/projects/github.com/edgarrmondragon/citric/badge", alt="OpenSSF Scorecard">
</a>
</td>
</tr>
</tbody>
</table>
*A client to the [LimeSurvey Remote Control API 2](https://manual.limesurvey.org/RemoteControl_2_API), written in modern Python.*
</div>
<!-- begin-short -->
## Features
- Supports the full RPC API via the [`Session` class](https://citric.readthedocs.io/en/latest/_api/citric/session/index.html#citric.session.Session).
- Best effort to implement all the RPC methods in the [`Client` class](https://citric.readthedocs.io/en/stable/_api/citric/index.html#citric.Client). See the [API coverage page](https://citric.readthedocs.io/en/stable/rpc_coverage.html) for details.
- Easily export survey data to CSV files, [Pandas DataFrames](https://citric.readthedocs.io/en/stable/how-to.html#export-responses-to-a-pandas-dataframe) and [DuckDB databases](https://citric.readthedocs.io/en/stable/how-to.html#export-responses-to-a-duckdb-database-and-analyze-with-sql).
- Easily [download survey files](https://citric.readthedocs.io/en/stable/how-to.html#get-files-uploaded-to-a-survey-and-move-them-to-s3) (e.g. images, audio, etc.) to a local directory.
- Tested against LimeSurvey 6.0.0+ and 5.0.0+ versions.
- Experimental support for the new [REST API](https://manual.limesurvey.org/REST_API).
## Installation
```sh
# PyPI
pip install citric
```
```sh
# or conda
conda install -c conda-forge citric
```
## Usage
```python
from citric import Client
# Connect to your LimeSurvey instance
client = Client(
"https://mylimesite.limequery.com/admin/remotecontrol",
"myusername",
"mypassword",
)
# Print the LimeSurvey version
print(client.get_server_version())
# Print every survey's title
for survey in client.list_surveys():
print(survey["surveyls_title"])
```
<!-- end-short -->
## Documentation
Code samples and API documentation are available at [citric.readthedocs.io](https://citric.readthedocs.io/).
## Contributing
If you'd like to contribute to this project, please see the [contributing guide](https://citric.readthedocs.io/en/stable/contributing/getting-started.html).
## Credits
- [Markus Opolka][martialblog] for maintaining a very robust set of [LimeSurvey Docker images](https://github.com/martialblog/docker-limesurvey/).
- [Claudio Jolowicz][claudio] and [his amazing blog post][hypermodern].
[claudio]: https://twitter.com/cjolowicz/
[hypermodern]: https://cjolowicz.github.io/posts/hypermodern-python-01-setup/
[martialblog]: https://github.com/martialblog/
Raw data
{
"_id": null,
"home_page": "",
"name": "citric",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.8",
"maintainer_email": "Edgar Ram\u00edrez-Mondrag\u00f3n <edgarrm358@gmail.com>",
"keywords": "json-rpc,limesurvey",
"author": "",
"author_email": "Edgar Ram\u00edrez-Mondrag\u00f3n <edgarrm358@gmail.com>",
"download_url": "https://files.pythonhosted.org/packages/39/59/3a57c7bd7de0fd5e2d7bdd7b0d4f1b7b295a390bde2ff497feeabbf1ba95/citric-1.0.0.tar.gz",
"platform": null,
"description": "<div align=\"center\">\n\n# Citric\n\n<table>\n <tbody>\n <tr>\n <td>Project Health</td>\n <td>\n <a href=\"https://polar.sh/edgarrmondragon\">\n <img src=\"https://polar.sh/embed/seeks-funding-shield.svg?org=edgarrmondragon\"/>\n </a>\n <a href=\"https://results.pre-commit.ci/latest/github/edgarrmondragon/citric/main\">\n <img alt=\"pre-commit.ci status\" src=\"https://results.pre-commit.ci/badge/github/edgarrmondragon/citric/main.svg\"/>\n </a>\n <a href=\"https://citric.readthedocs.io/en/latest/?badge=latest\">\n <img alt=\"Documentation Status\" src=\"https://readthedocs.org/projects/citric/badge/?version=latest\"/>\n </a>\n <a href=\"https://codecov.io/gh/edgarrmondragon/citric\">\n <img alt=\"codecov\" src=\"https://codecov.io/gh/edgarrmondragon/citric/branch/main/graph/badge.svg\"/>\n </a>\n </td>\n </tr>\n <tr>\n <td>Packaging</td>\n <td>\n <a href=\"https://pypi.org/project/citric\">\n <img alt=\"PyPI version\" src=\"https://img.shields.io/pypi/v/citric.svg?logo=pypi&logoColor=FFE873&color=blue\"/>\n </a>\n <a href=\"https://pypi.org/project/citric\">\n <img alt=\"Python versions\" src=\"https://img.shields.io/pypi/pyversions/citric.svg?logo=python&logoColor=FFE873\"/>\n </a>\n <a href=\"https://pypi.org/project/citric\">\n <img alt=\"PyPI - Downloads\" src=\"https://img.shields.io/pypi/dm/citric?color=blue\"/>\n </a>\n <a href=\"https://anaconda.org/conda-forge/citric\">\n <img alt=\"Conda Version\" src=\"https://img.shields.io/conda/vn/conda-forge/citric.svg\"/>\n </a>\n </tr>\n <tr>\n <td>Misc</td>\n <td>\n <a href=\"https://github.com/astral-sh/ruff\">\n <img src=\"https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/charliermarsh/ruff/main/assets/badge/v2.json\" alt=\"Ruff\" style=\"max-width:100%;\">\n </a>\n <a href=\"https://github.com/wntrblm/nox\">\n <img alt=\"Nox\" src=\"https://img.shields.io/badge/%F0%9F%A6%8A-Nox-D85E00.svg\"/>\n </a>\n <a href=\"https://github.com/pypa/hatch\">\n <img alt=\"Hatch project\" src=\"https://img.shields.io/badge/%F0%9F%A5%9A-Hatch-4051b5.svg\"/>\n </a>\n <a href=\"https://github.com/edgarrmondragon/citric/blob/main/LICENSE\">\n <img alt=\"License\" src=\"https://img.shields.io/github/license/edgarrmondragon/citric\"/>\n </a>\n <a href=\"https://zenodo.org/doi/10.5281/zenodo.10216279\">\n <img src=\"https://zenodo.org/badge/223537606.svg\" alt=\"DOI\">\n </a>\n <br />\n <a href=\"https://www.bestpractices.dev/projects/8144\">\n <img src=\"https://www.bestpractices.dev/projects/8144/badge\">\n </a>\n <a href=\"https://securityscorecards.dev/viewer/?uri=github.com/edgarrmondragon/citric\">\n <img src=\"https://api.securityscorecards.dev/projects/github.com/edgarrmondragon/citric/badge\", alt=\"OpenSSF Scorecard\">\n </a>\n </td>\n </tr>\n </tbody>\n</table>\n\n*A client to the [LimeSurvey Remote Control API 2](https://manual.limesurvey.org/RemoteControl_2_API), written in modern Python.*\n\n</div>\n\n<!-- begin-short -->\n\n## Features\n\n- Supports the full RPC API via the [`Session` class](https://citric.readthedocs.io/en/latest/_api/citric/session/index.html#citric.session.Session).\n- Best effort to implement all the RPC methods in the [`Client` class](https://citric.readthedocs.io/en/stable/_api/citric/index.html#citric.Client). See the [API coverage page](https://citric.readthedocs.io/en/stable/rpc_coverage.html) for details.\n- Easily export survey data to CSV files, [Pandas DataFrames](https://citric.readthedocs.io/en/stable/how-to.html#export-responses-to-a-pandas-dataframe) and [DuckDB databases](https://citric.readthedocs.io/en/stable/how-to.html#export-responses-to-a-duckdb-database-and-analyze-with-sql).\n- Easily [download survey files](https://citric.readthedocs.io/en/stable/how-to.html#get-files-uploaded-to-a-survey-and-move-them-to-s3) (e.g. images, audio, etc.) to a local directory.\n- Tested against LimeSurvey 6.0.0+ and 5.0.0+ versions.\n- Experimental support for the new [REST API](https://manual.limesurvey.org/REST_API).\n\n## Installation\n\n```sh\n# PyPI\npip install citric\n```\n\n```sh\n# or conda\nconda install -c conda-forge citric\n```\n\n## Usage\n\n```python\nfrom citric import Client\n\n# Connect to your LimeSurvey instance\nclient = Client(\n \"https://mylimesite.limequery.com/admin/remotecontrol\",\n \"myusername\",\n \"mypassword\",\n)\n\n# Print the LimeSurvey version\nprint(client.get_server_version())\n\n# Print every survey's title\nfor survey in client.list_surveys():\n print(survey[\"surveyls_title\"])\n```\n\n<!-- end-short -->\n\n## Documentation\n\nCode samples and API documentation are available at [citric.readthedocs.io](https://citric.readthedocs.io/).\n\n## Contributing\n\nIf you'd like to contribute to this project, please see the [contributing guide](https://citric.readthedocs.io/en/stable/contributing/getting-started.html).\n\n## Credits\n\n- [Markus Opolka][martialblog] for maintaining a very robust set of [LimeSurvey Docker images](https://github.com/martialblog/docker-limesurvey/).\n- [Claudio Jolowicz][claudio] and [his amazing blog post][hypermodern].\n\n[claudio]: https://twitter.com/cjolowicz/\n[hypermodern]: https://cjolowicz.github.io/posts/hypermodern-python-01-setup/\n[martialblog]: https://github.com/martialblog/\n",
"bugtrack_url": null,
"license": "MIT License Copyright (c) 2019, Edgar Ram\u00edrez Mondrag\u00f3n Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the \"Software\"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.",
"summary": "A client to the LimeSurvey Remote Control API 2, written in modern Python.",
"version": "1.0.0",
"project_urls": {
"Documentation": "https://citric.readthedocs.io",
"Homepage": "https://github.com/edgarrmondragon/citric",
"Issue Tracker": "https://github.com/edgarrmondragon/citric/issues",
"Repository": "https://github.com/edgarrmondragon/citric"
},
"split_keywords": [
"json-rpc",
"limesurvey"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "c3862ce952a0621377ddfac8b3d6b68dba7d278f480e8ccfe51c744ce3cad7fb",
"md5": "2c3cf586c10e7d278995bfaac76b7e52",
"sha256": "89929562f81a574287e5d59564f0c564c77670da8b569eef5f5897eb9c6830aa"
},
"downloads": -1,
"filename": "citric-1.0.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "2c3cf586c10e7d278995bfaac76b7e52",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.8",
"size": 25793,
"upload_time": "2024-02-13T02:31:41",
"upload_time_iso_8601": "2024-02-13T02:31:41.248788Z",
"url": "https://files.pythonhosted.org/packages/c3/86/2ce952a0621377ddfac8b3d6b68dba7d278f480e8ccfe51c744ce3cad7fb/citric-1.0.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "39593a57c7bd7de0fd5e2d7bdd7b0d4f1b7b295a390bde2ff497feeabbf1ba95",
"md5": "6da2c9dba72499769aaa1dd81da30ddf",
"sha256": "a874928ee6416eadfe6ccca28b6eb38dc6fd938db4066f1ba5f272b9c7c7642d"
},
"downloads": -1,
"filename": "citric-1.0.0.tar.gz",
"has_sig": false,
"md5_digest": "6da2c9dba72499769aaa1dd81da30ddf",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8",
"size": 184787,
"upload_time": "2024-02-13T02:31:43",
"upload_time_iso_8601": "2024-02-13T02:31:43.462926Z",
"url": "https://files.pythonhosted.org/packages/39/59/3a57c7bd7de0fd5e2d7bdd7b0d4f1b7b295a390bde2ff497feeabbf1ba95/citric-1.0.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-02-13 02:31:43",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "edgarrmondragon",
"github_project": "citric",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"circle": true,
"lcname": "citric"
}
