pyDataverse icon indicating copy to clipboard operation
pyDataverse copied to clipboard

Safety mechanism for Production

Open skasberger opened this issue 4 years ago • 1 comments

Add safety mechanism, so that by default for production instances some API functions are not available.

The idea is, that you have to explicitly pass an attribute to force the functionality, so that you don't do unwanted changes to a production Instance.

Prepare

  • [ ] Depends on dotenv feature implemented. This should enable the usage of pyDantic in combination with dotenv files.
  • [ ] Define process:
    • [ ] set env-variable PRODUCTION="false" to avoid this. If not set, or true, it blocks some functions
    • [ ] pass variable force to defined functions. by default False
  • [ ] Define Functions to be blocked:
    • [ ] publish_dataset() ??
    • [ ] destroy_dataset() ??
    • [ ] delete_dataset() ??
    • [ ] publish_dataverse() ??
    • [ ] delete_dataverse() ??
    • [ ] delete_datafile() ??

Actions

  • [ ] Develop tests
  • [ ] Update function(s) with Docstrings
  • [ ] Update Docs
  • [ ] Update Docstrings
  • [ ] Run tests

Review

  • [ ] Docs

Follow-Ups

  • [ ]

skasberger avatar Jan 29 '21 00:01 skasberger

As discussed during the 2024-02-14 meeting of the pyDataverse working group, we are closing old milestones in favor of a new project board at https://github.com/orgs/gdcc/projects/1 and removing issues (like this one) from those old milestones. Please feel free to join the working group! You can find us at https://py.gdcc.io and https://dataverse.zulipchat.com/#narrow/stream/377090-python

pdurbin avatar Mar 04 '24 16:03 pdurbin