2.6.0

What's Changed

• Add instrument methods by @patking02 in #282

Full Changelog: 2.5.0...2.6.0

2.5.0

What's Changed

• coerce field and form arguments in export_records() by @ugGit in #269
• Keep default values in df_kwargs when calling load_data() by @ugGit in #270
• Add Arm and Event API by @patking02 in #278

New Contributors

• @patking02 made their first contribution in #278 🙇🏻‍♂️

Full Changelog: 2.4.0...2.5.0

2.4.0

What's Changed

• Capitalization by @wibeasley in #256
• Add request_kwargs to be passed during API requests by @ugGit in #251
• Add mypy by @pwildenhain in #258

New Contributors

• @wibeasley made their first contribution in #256
• @ugGit made their first contribution in #251

Full Changelog: 2.3.0...2.4.0

2.3.0

What's Changed

• Backfill fields for all records export requests by @pwildenhain in #247
• ⬆️ Bump certifi by @pwildenhain in #250
• Only return complete fields for requested forms by @pwildenhain in #253

Full Changelog: 2.2.0...2.3.0

2.2.0

What's Changed

• Add check for missing token and url (#238)
• Update docs for pandas optional dependency (#239)
• Add delete roles method (#243)

Full Changelog: 2.1.0...2.2.0

2.1.0

API Support 🤖

• Add logging methods (#222)
• Add user methods (#225)
• Add DAG methods (#226)
• Add user role methods (#228)
• Add new args for export records (#223)

Package Improvements 💪

• Add docs tests for return format type (#224)

2.0.0

2.0.0 (2022-03-29)

API Support 🤖

• Add support for export_repeating_instruments_events and import_repeating_instruments_events (#210 @JuliaSprenger)

Package Improvements 💪

• Project class loads lazily by default
• All Project.export_* methods that return JSON now can return DataFrame's as well
• Project class was broken up into smaller utility classes, see the redcap.methods module or the API reference on the new docs site
• Robust testing infrastructure (pytest, doctest-plus) with both unit and integration tests, maintained at 100% test coverage, with automated styling and linting checks in CI (black, pylint)
• Gradual typing added, but not yet enforced in CI
• Add _complete fields to payload when requesting survey fields (#149 @forsakendaemon)

Breaking changes 💥

• Dropped support for Python 2, requires python 3.8 or above
• Many extraneous Project attributes were removed. See the API reference for remaining attributes
• RedcapError is raised for all endpoints when API errors are encountered. Errors are never returned in the response
• generate_next_record_name now returns a str instead of an int. This fixes a bug that occurs when a project uses DAGs
• export_fem renamed to export_instrument_event_mapping to be more consistent with other endpoints
• Common parameter name changes including: format --> format_type, return_format --> return_format_type, type --> record_type. Most of the reason for this change was to avoid the use of reserved keywords such as format and type

Documentation 📝

• Revamp documentation to mkdocs-material style on GitHub pages
• Add comprehensive docstrings and doctests to all methods
• Update delete_records documentation (#173 @andyjessen)

Version 1.1.3

API Support

• Add support for import_metadata endpoint (#145 @JuliaSprenger)

Documentation

• Update contributing.rst with new installation instructions (#135 @njvack)

Version 1.1.2

API Support

• Add support for exportFieldNames call (#125 @chgreer)
• Add dateRangeBegin and dateRangeEnd parameters to Project.export_records (#124 @chgreer)

Package Improvements

• Use pytest for full test suite (#132)
• Enforce black and pylint style and formatting on project (#132)
• Deprecate support for Python 2 (#132)
• Add pandas as an extra_requires (#132)

Documentation

• Update README with new community support model and how to contribute (#132)

Version 1.1.1

1.1.1 (2020-08-18)

Bug Fixes

• Fix package version parsing for UNIX (#122 @fissell)