Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Make PEP representations consistent #493

Closed
3 tasks
donaldcampbelljr opened this issue Sep 4, 2024 · 0 comments · Fixed by #494
Closed
3 tasks

Make PEP representations consistent #493

donaldcampbelljr opened this issue Sep 4, 2024 · 0 comments · Fixed by #494

Comments

@donaldcampbelljr
Copy link
Contributor

We currently have 3 ways of representing PEPs:

  1. Schema representations -> see: https://schema.databio.org/?namespace=pep&schema=2.1.0
  2. peppy.Project object -> this is a mutable mapping containing _config and samples attributes.
  3. dict via peppy.Project.to_dict() -> this contains all attributes under the original _config key (but not the _config key!) and the samples.

We would like to ensure that number 3 resembles number 2, so that the data structures have both config and samples attributes.

Finally, in this same process we have decided to rename the config key to project.

In summary:

  • ensure to_dict()'s representation matches the peppy.Project representation
  • change config key to project
  • refactor _samples to samples
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging a pull request may close this issue.

1 participant