Skip to content

[ENH] add code and test to help create schemas #26

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

Closed
wants to merge 78 commits into from

Conversation

Remi-Gau
Copy link
Contributor

@Remi-Gau Remi-Gau commented Jul 31, 2022

TODO

  • use attrs in all constructors:
    • may require refacrtoring and reordering of class hierarchy with a much leaner parent class
  • add doc

unrelated changes

  • reordering of imports using precommit
  • take tests out of package fodler

@Remi-Gau Remi-Gau force-pushed the remi_schema_creator branch from 666e6eb to 7fd2450 Compare August 15, 2022 17:33
@Remi-Gau
Copy link
Contributor Author

Things are starting to look better.

There is still potential for refactoring but I may wait a bit before doing this.

Want to test it on COBIDAS first and add some doc with sphinx to make sure whoever revisit this will not be thoroughly lost.

clean_up(item_dir, item)


def test_item1():
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Note that the creation of some files can still be quite involved if they are complex: I still would like to make the API more intuitive but I am not sure how much more I can do for now.

@Remi-Gau
Copy link
Contributor Author

Note that not all parts of the schema have been covered yet.

FYI: I tend to start from the main one in those and implement the ones that are needed to run some tests to create some example found in the library of the reproschema repo itself

https://www.repronim.org/reproschema/30_schema/

refactor

refactor

refactor

refactor
update doc
@Remi-Gau Remi-Gau force-pushed the remi_schema_creator branch from 23e57db to 61310c8 Compare August 17, 2022 08:12
@satra
Copy link
Contributor

satra commented Oct 31, 2022

@Remi-Gau - we will be getting back to this soon. a new person has joined our group. i wanted to check in on the status.

a few questions:

  • is there an intentional reason to move to sphinx from mkdocs?
  • there is a README.md in each code folder. this seems quite different from python practices, where such statements would simply be in the code files. (it also makes packaging a little weirder since those files have to be explicitly included).

@Remi-Gau
Copy link
Contributor Author

@Remi-Gau - we will be getting back to this soon. a new person has joined our group. i wanted to check in on the status.

status after playing around with attrs I indeed started switching to pydantic as I was already adding tons of type hints... but then I had to go back to do other things.

a few questions:

* is there an intentional reason to move to sphinx from mkdocs?

Not really except for the fact that if we want to deploy documentation useful for devs it will be much easier with sphinx given its autodoc features.

* there is a README.md in each code folder. this seems quite different from python practices, where such statements would simply be in the code files. (it also makes packaging a little weirder since those files have to be explicitly included).

yeah those should probably go away and be included as doc strings in the top of the relevant modules

@satra
Copy link
Contributor

satra commented Oct 31, 2022

thanks @Remi-Gau - there are a few new kid techs on the block that may make our lives even easier. i'll see where we can take this soon.

@Remi-Gau Remi-Gau closed this May 11, 2024
@Remi-Gau Remi-Gau deleted the remi_schema_creator branch May 11, 2024 17:47
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 this pull request may close these issues.

3 participants