Skip to content

Add export command to CLI#673

Draft
etidoukpong-spec wants to merge 2 commits intoscribe-org:mainfrom
etidoukpong-spec:feature/add-export-command-to-cli
Draft

Add export command to CLI#673
etidoukpong-spec wants to merge 2 commits intoscribe-org:mainfrom
etidoukpong-spec:feature/add-export-command-to-cli

Conversation

@etidoukpong-spec
Copy link
Copy Markdown

Contributor checklist


Description

  • new subprocess in main.py
  • export logic in contracts/export.py

Question on Overwrite Behavior:
Currently, if a contracts/ folder already exists in the PWD, the export_contracts command alerts the user and stops to prevent accidental overwriting of their data.

What is the most useful behaviour?

  • Alert/Stop: (Current implementation)
  • Automatic Rename: e.g., exporting to contracts_1/ if contracts/ exists
  • Force Overwrite: use the overwrite argument

Related issue

@github-actions
Copy link
Copy Markdown
Contributor

Thank you for the pull request! 💙

The Scribe-Data team will do our best to address your contribution as soon as we can. If you're not already a member of our public Matrix community, please consider joining! We'd suggest that you use the Element client as well as Element X for a mobile app, and definitely join the General and Data rooms once you're in. Also consider attending our bi-weekly Saturday dev syncs. It'd be great to meet you 😊

Note

Scribe uses Conventional Comments in reviews to make sure that communication is as clear as possible.

@github-actions
Copy link
Copy Markdown
Contributor

Maintainer Checklist

The following is a checklist for maintainers to make sure this process goes as well as possible. Feel free to address the points below yourself in further commits if you realize that actions are needed :)

  • Tests for changes have been written and the pytest, linting and formatting workflows within the PR checks do not indicate new errors in the files changed

  • The CHANGELOG has been updated with a description of the changes for the upcoming release and the corresponding issue (if necessary)

Copy link
Copy Markdown
Contributor

@github-actions github-actions bot left a comment

Choose a reason for hiding this comment

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

First PR Commit Check

  • The commit messages for the remote branch of a new contributor should be checked to make sure their email is set up correctly so that they receive credit for their contribution
    • The contributor's name and icon in remote commits should be the same as what appears in the PR
    • If there's a mismatch, the contributor needs to make sure that the email they use for GitHub matches what they have for git config user.email in their local Scribe-Data repo (can be set with git config --global user.email "GITHUB_EMAIL")

@andrewtavis andrewtavis self-requested a review March 24, 2026 16:13
@andrewtavis
Copy link
Copy Markdown
Member

Thanks for the PR here, @etidoukpong-spec! To your question, as the contracts could change from one export to the next, I think the best functionality would be to check with the user on if they should be exported or not, and if so then we overwrite the directory without a rename.

Feel free to send along a change to fix that and then mark this as ready for review!

@etidoukpong-spec
Copy link
Copy Markdown
Author

Thanks @andrewtavis, I will see what I can do!

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.

2 participants