Uploaded image for project: 'Data Management'
  1. Data Management
  2. DM-24281

Add document describing how to create executable scripts to the dev guide

    Details

    • Urgent?:
      No

      Description

      There currently is no document in the developer guide that describes how to create an executable script following our "code in `python/script/`, nearly-empty executable in bin.src" convention. We have a community post with links describing how to document such a script, but no central location for someone writing a new script.

      I'm not sure if this should go under `Python` or `DM Stack` in the dev guide.

        Attachments

          Issue Links

            Activity

            Parejkoj John Parejko created issue -
            Parejkoj John Parejko made changes -
            Field Original Value New Value
            Link This issue relates to DM-15807 [ DM-15807 ]
            Parejkoj John Parejko made changes -
            Link This issue relates to DM-15792 [ DM-15792 ]
            krzys Krzysztof Findeisen made changes -
            Link This issue is duplicated by DM-24282 [ DM-24282 ]
            Hide
            krzys Krzysztof Findeisen added a comment -

            So it doesn't get lost, there's a discussion of all the advantages of the current convention on #dm-middleware.

            Show
            krzys Krzysztof Findeisen added a comment - So it doesn't get lost, there's a discussion of all the advantages of the current convention on #dm-middleware .
            krzys Krzysztof Findeisen made changes -
            Component/s dm_dev_guide [ 15900 ]
            Hide
            jsick Jonathan Sick added a comment -

             

            I'm not sure if this should go under `Python` or `DM Stack` in the dev guide.

            I'd vote for "DM Stack" since I think the solution will end up being deeply integrated with how the Stack (like Science Pipelines) is architected.

            Other DM Python code, that uses setuptools for instance, would use a different way of writing executable scripts.

            Show
            jsick Jonathan Sick added a comment -   I'm not sure if this should go under `Python` or `DM Stack` in the dev guide. I'd vote for "DM Stack" since I think the solution will end up being deeply integrated with how the Stack (like Science Pipelines) is architected. Other DM Python code, that uses setuptools for instance, would use a different way of writing executable scripts.
            ktl Kian-Tat Lim made changes -
            Assignee Nate Pease [ npease ]

              People

              • Assignee:
                npease Nate Pease
                Reporter:
                Parejkoj John Parejko
                Watchers:
                John Parejko, Jonathan Sick, Kian-Tat Lim, Petr Kubanek, Tim Jenness
              • Votes:
                1 Vote for this issue
                Watchers:
                5 Start watching this issue

                Dates

                • Created:
                  Updated:

                  Summary Panel