Data

Tools

Indexes

Applications

Experiments

Open Source Science

citric

A client to the LimeSurvey Remote Control API 2, written in modern Python.

https://github.com/edgarrmondragon/citric

Science Score: 67.0%

This score indicates how likely this project is to be science-related based on various indicators:

  • ✓
    CITATION.cff file
    Found CITATION.cff file
  • ✓
    codemeta.json file
    Found codemeta.json file
  • ✓
    .zenodo.json file
    Found .zenodo.json file
  • ✓
    DOI references
    Found 1 DOI reference(s) in README
  • ✓
    Academic publication links
    Links to: zenodo.org
  • ○
    Committers with academic emails
  • ○
    Institutional organization owner
  • ○
    JOSS paper metadata
  • ○
    Scientific vocabulary similarity
    Low similarity (9.4%) to scientific vocabulary

Keywords

limesurvey python survey

Keywords from Contributors

pypi energy-system-model interpretability mesh standards quantum-circuit bioinformatics yolov5s geoscience animations
Last synced: 6 months ago · JSON representation ·

Repository

A client to the LimeSurvey Remote Control API 2, written in modern Python.

Basic Info
  • Host: GitHub
  • Owner: edgarrmondragon
  • License: mit
  • Language: Python
  • Default Branch: main
  • Homepage: https://citric.rtfd.io
  • Size: 3.37 MB
Statistics
  • Stars: 29
  • Watchers: 3
  • Forks: 8
  • Open Issues: 8
  • Releases: 48
Topics
limesurvey python survey
Created about 6 years ago · Last pushed 6 months ago
Metadata Files
Readme Changelog Contributing Funding License Code of conduct Citation Codeowners Security Authors

README.md

# Citric
Project Health pre-commit.ci status Documentation Status codecov
Packaging PyPI version Python versions PyPI - Downloads Conda Version
Misc uv Ruff Nox License DOI
*A client to the [LimeSurvey Remote Control API 2](https://manual.limesurvey.org/RemoteControl_2_API), written in modern Python.*

Features

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.getserverversion())

Print every survey's title

for survey in client.listsurveys(): print(survey["surveylstitle"]) ```

Documentation

Code samples and API documentation are available at citric.readthedocs.io.

Contributing

If you'd like to contribute to this project, please see the contributing guide.

Credits

Owner

  • Name: Edgar Ramírez Mondragón
  • Login: edgarrmondragon
  • Kind: user
  • Location: Mexico
  • Company: @archdotdev / @meltano

Python / Data / Backend Applications

Citation (CITATION.cff) 

cff-version: 1.2.0
message: "If you use this software, please cite it as below."
authors:
- family-names: "Ramírez Mondragón"
  given-names: "Edgar"
  orcid: "https://orcid.org/0000-0002-4182-0385"
title: "Citric"
version: "1.4.0"
doi: 10.5281/zenodo.10216279
date-released: 2021-11-11
url: "https://github.com/edgarrmondragon/citric"

GitHub Events

Total
  • Create event: 231
  • Issues event: 7
  • Release event: 5
  • Watch event: 3
  • Delete event: 227
  • Issue comment event: 950
  • Push event: 780
  • Pull request review comment event: 18
  • Pull request review event: 247
  • Pull request event: 444
Last Year
  • Create event: 231
  • Issues event: 7
  • Release event: 5
  • Watch event: 3
  • Delete event: 227
  • Issue comment event: 950
  • Push event: 780
  • Pull request review comment event: 18
  • Pull request review event: 247
  • Pull request event: 444

Committers

Last synced: 9 months ago

All Time
  • Total Commits: 1,402
  • Total Committers: 10
  • Avg Commits per committer: 140.2
  • Development Distribution Score (DDS): 0.459
Past Year
  • Commits: 223
  • Committers: 5
  • Avg Commits per committer: 44.6
  • Development Distribution Score (DDS): 0.39
Top Committers
Name Email Commits
Edgar R. M e****8@g****m 758
dependabot[bot] 4****] 445
pre-commit-ci[bot] 6****] 61
renovate[bot] 2****] 54
edgarrmondragon[bot] 1****] 21
Renovate Bot b****t@r****m 21
pyup.io bot g****t@p****o 20
github-actions[bot] 4****] 20
fossabot b****s@f****o 1
Favian Hazman v****n@g****m 1
Committer Domains (Top 20 + Academic)
fossa.io: 1 pyup.io: 1 renovateapp.com: 1

Issues and Pull Requests

Last synced: 6 months ago

All Time
  • Total issues: 39
  • Total pull requests: 917
  • Average time to close issues: 29 days
  • Average time to close pull requests: 6 days
  • Total issue authors: 9
  • Total pull request authors: 6
  • Average comments per issue: 0.87
  • Average comments per pull request: 2.03
  • Merged pull requests: 758
  • Bot issues: 2
  • Bot pull requests: 476
Past Year
  • Issues: 10
  • Pull requests: 414
  • Average time to close issues: 12 days
  • Average time to close pull requests: 5 days
  • Issue authors: 4
  • Pull request authors: 5
  • Average comments per issue: 1.4
  • Average comments per pull request: 1.51
  • Merged pull requests: 308
  • Bot issues: 1
  • Bot pull requests: 257
View more stats
Top Authors
Issue Authors
  • edgarrmondragon (26)
  • AmauryVanEspen (1)
  • autopoiesis3004 (1)
  • Shnoulle (1)
  • Robert-Vorster (1)
  • soberhofer (1)
  • renovate[bot] (1)
  • MatthiasGer0821 (1)
  • PriyansuMaurya (1)
Pull Request Authors
  • edgarrmondragon (473)
  • dependabot[bot] (189)
  • renovate[bot] (181)
  • edgarrmondragon[bot] (59)
  • pre-commit-ci[bot] (50)
  • github-actions[bot] (16)
Top Labels
Issue Labels
enhancement (22) citric.Client (13) bug (6) documentation (3) REST (3) automation (2) integration (1) question (1) RPC (1)
Pull Request Labels
dependencies (386) Release (91) github_actions (60) python (25) enhancement (16) RPC (16) automation (14) citric.Client (9) Update badges (6) documentation (5) REST (5) docker (4) integration (4) bug (2)

Packages

  • Total packages: 1
  • Total downloads:
    • pypi 2,938 last-month
  • Total dependent packages: 0
  • Total dependent repositories: 1
  • Total versions: 48
  • Total maintainers: 1
pypi.org: citric

A client to the LimeSurvey Remote Control API 2, written in modern Python.

  • Versions: 48
  • Dependent Packages: 0
  • Dependent Repositories: 1
  • Downloads: 2,938 Last month
Rankings
Dependent packages count: 7.4%
Downloads: 8.5%
Average: 13.3%
Stargazers count: 14.2%
Forks count: 14.3%
Dependent repos count: 22.2%
Maintainers (1)
edgarrm92
Funding
  • https://github.com/sponsors/edgarrmondragon
Last synced: 6 months ago

Dependencies

.github/workflows/gen-release-pr.yml actions
  • actions/checkout v3.3.0 composite
  • miniscruff/changie-action v0.2.0 composite
  • peter-evans/create-pull-request v4.2.3 composite
  • softprops/action-gh-release v1 composite
.github/workflows/pr-preview-links.yml actions
  • readthedocs/actions/preview v1 composite
.github/workflows/tests.yml actions
  • actions/checkout v3.3.0 composite
  • actions/download-artifact v3.0.2 composite
  • actions/setup-python v4.5.0 composite
  • actions/upload-artifact v3.1.2 composite
  • codecov/codecov-action v3.1.1 composite
  • deadsnakes/action v3.0.0 composite
docker-compose.yml docker
  • martialblog/limesurvey ${LS_IMAGE_TAG
  • postgres 14
  • quay.io/minio/minio latest
pyproject.toml pypi
  • furo 2022.4.7
  • importlib_metadata >=1.6
  • myst-parser 0.17.2
  • python ^3.7.0
  • requests ^2.23.0
  • sphinx 4.5.0
  • sphinx-autoapi 1.8.4
  • sphinx-autobuild ^2021.3.14
  • sphinx-autodoc-typehints 1.18.1
  • sphinx-copybutton ^0.5.0
  • typing-extensions ^4.4.0
.github/workflows/api-changes.yml actions
  • actions/checkout v4.0.0 composite
  • actions/setup-python v4.7.0 composite
docker-compose.mysql.yml docker
  • mysql latest
docker-compose.ref.yml docker
  • edgarrmondragon/limesurvey latest
.github/actions/install-tools/action.yml actions
.github/workflows/build.yml actions
  • actions/checkout v4.1.1 composite
  • actions/download-artifact v3.0.2 composite
  • actions/setup-python v4.7.1 composite
  • actions/upload-artifact v3.1.3 composite
  • pypa/gh-action-pypi-publish v1.8.10 composite
  • sigstore/gh-action-sigstore-python v2.1.0 composite
  • svenstaro/upload-release-action v2 composite
docs/requirements.txt pypi
  • alabaster ==0.7.13
  • anyascii ==0.3.2
  • astroid ==3.0.2
  • babel ==2.14.0
  • beautifulsoup4 ==4.12.2
  • certifi ==2023.11.17
  • charset-normalizer ==3.3.2
  • colorama ==0.4.6
  • docutils ==0.20.1
  • furo ==2023.9.10
  • idna ==3.6
  • imagesize ==1.4.1
  • jinja2 ==3.1.2
  • livereload ==2.6.3
  • markdown-it-py ==3.0.0
  • markupsafe ==2.1.3
  • mdit-py-plugins ==0.4.0
  • mdurl ==0.1.2
  • myst-parser ==2.0.0
  • packaging ==23.2
  • pygments ==2.17.2
  • pyyaml ==6.0.1
  • requests ==2.31.0
  • six ==1.16.0
  • snowballstemmer ==2.2.0
  • soupsieve ==2.5
  • sphinx ==7.2.6
  • sphinx-autoapi ==3.0.0
  • sphinx-autobuild ==2021.3.14
  • sphinx-basic-ng ==1.0.0b2
  • sphinx-copybutton ==0.5.2
  • sphinx-hoverxref ==1.3.0
  • sphinx-notfound-page ==1.0.0
  • sphinxcontrib-applehelp ==1.0.7
  • sphinxcontrib-devhelp ==1.0.5
  • sphinxcontrib-htmlhelp ==2.0.4
  • sphinxcontrib-jquery ==4.1
  • sphinxcontrib-jsmath ==1.0.1
  • sphinxcontrib-qthelp ==1.0.6
  • sphinxcontrib-serializinghtml ==1.1.9
  • tornado ==6.4
  • urllib3 ==2.1.0