Open
Conversation
Introduced a new command line interface (CLI) for creating experiment projects using a template. The `build-exp` command allows users to initialize a new experiment repository from the terminal. Updated the README to include usage instructions and added tests to ensure functionality. New files: - `cli/__init__.py`: CLI module initialization. - `cli/experiment.py`: Contains the logic for downloading and setting up the experiment template. - `tests/cli/test_experiment.py`: Tests for the experiment CLI functionality. Updated `pyproject.toml` to register the new CLI command and modified the README to document the new feature.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
This PR adds a small CLI tool to poulet-py that allows users to scaffold a new experiment repository directly from the terminal using build-exp init . The command downloads the poulet-lab/experiment-template archive, copies it into the target folder, removes the template’s .git directory, updates README references from experiment-template to the new project name, and prints clear next-step instructions for initialising a fresh git repository.
The main benefit is that any user who installs poulet-py (inside or outside the lab) can create a standardised experiment structure without manually cloning or cleaning the template repository. This lowers the barrier to using the shared experiment template, promotes consistent organisation of experiments, and makes it easier for external users and collaborators to adopt the lab’s conventions.