Skip to content

yaml-to-bibtex.py is fragile #11

Open
@rougier

Description

@rougier
Member

The yaml-to-bibtex script seems to be quite fragile and will break fro any typo in the yaml file (see for example #10). We need to make it more robust. Any taker ?

Activity

schackartk

schackartk commented on Feb 8, 2023

@schackartk
Contributor

I might like to take a stab at it (article.py as well). Are you using any code formatters or formal linters at this time?

I would like to start off by using a formatter (I would elect black, but happy to use whatever), and make sure it passes pylint and flake8. Then add type annotations and check with mypy.

I think those checks will get it pretty far in terms of robustness. From there, I would like to add more parsing checks and some unit tests (e.g. lastname and abbrvname extraction tests). Are there any objections to this proposal?

rougier

rougier commented on Feb 14, 2023

@rougier
MemberAuthor

Thanks for the proposal. We're actually transitioning to a new system (JOSS) where metadata will be entered at time of submission. Hopefully we won't need the script anymore. But I retain your proposal in case things do not work as expected.

schackartk

schackartk commented on Mar 7, 2023

@schackartk
Contributor

Thanks! On that note, how soon do you think the transition will be complete? I have a replication I would like to submit soon and was wondering if it would be best to wait until after the transition?

rougier

rougier commented on Mar 27, 2023

@rougier
MemberAuthor

Sorry for the delay. We have an early protype and I hope we'll make the transition by end of June but difficult to say. If you can wait a few more weeks, I should have a better timeline (don't hesitate to ping me in this thread).

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

      Development

      No branches or pull requests

        Participants

        @rougier@schackartk

        Issue actions

          yaml-to-bibtex.py is fragile · Issue #11 · ReScience/template