pyDataverse icon indicating copy to clipboard operation
pyDataverse copied to clipboard

Control workflow with environment variables coming from dotenv files

Open skasberger opened this issue 4 years ago • 1 comments

Use environment variables to steer the pyDataverse workflow. Optionally load them with pydantic from dotenv files.

Prepare

  • [ ] Identify process steps to be steered
  • [ ] Define environment variables needed: type, name
    • [ ] use env-config structure
    • [ ] use owat_api strategy
    • [ ] User API token
    • [ ] base url
    • [ ] instance type: PRODUCTION, DEVELOPMENT
    • [ ] Publish Dataverse: true/false

Implementation

  • [ ] Develop tests
  • [ ] Write pydantic settings class
    • [ ] use ENV_FILE for pasing dotenv-file
  • [ ] Update Docs
    • [ ] Settings Management: somewhere
    • [ ] User Guide - Basic Usage
    • [ ] User Guide - Advanced Usage
    • [ ] Homepage - Quickstart
  • [ ] Write Docstrings
  • [ ] Run pytest
  • [ ] Run tox
  • [ ] Run pylint
  • [ ] Run mypy

Review

  • [ ] Docs

Follow-Ups

skasberger avatar Feb 15 '21 19:02 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