# 🐒 ExpMonkey: Unleash Your Experiments with Git Magic! 🍌
Welcome to ExpMonkey, the nimble experiment management tool that transforms the way you handle your research and development projects. By harnessing the power of git worktrees, ExpMonkey offers a command-line sanctuary for your branches, treating each one as a unique adventure in the jungle of innovation. Ready to swing from experiment to experiment with the grace of a seasoned primate? 🌿 Let's dive in!
## 🌟 Spotlight Features
Embark on a journey with ExpMonkey and discover a world where managing multiple experiments feels like a walk in the park:
- 🍌 **Parallel Universe Workflow**: Each git branch becomes an alternate reality, with its own directory to tinker in. Work on multiple fronts without ever tangling your vines.
- 🍌 **Jungle Gym Navigation**: Leap between branches with a simple command. It's like having a map of the entire jungle at your fingertips.
- 🍌 **Git Sorcery Enhanced**: ExpMonkey casts a spell on the standard git rituals, streamlining branch antics and conjuring up tools specifically for the experimental alchemist.
- 🍌 **Branch Alchemy**: Transmute, clone, and compare experiments with the dexterity of a monkey's tail, all thanks to ExpMonkey's clever branch wizardry.
- 🍌 **Chant Autocompletion**: Invoke the spirits of speed and precision with our autocompletion incantations, banishing typos to the shadow realm.
- 🍌 **Fuzzy Oracle Integration**: Consult the `fzf` oracle for visions of branches and commits, selecting your path with the clarity of a shaman's trance.
## 📜 Prerequisites
Before you embark on this quest, ensure you have the following relics:
- Python 3.x
- Git
- Optional: `fzf` for an enhanced soothsaying interface
## 🛠 Installation: Summoning ExpMonkey
Invoke ExpMonkey into your realm with these ancient incantations:
1. Conjure the Python package:
```shell
pip3 install expmonkey
```
2. (Optional) Weave `em-init-script` into your shell's tapestry for autocompletion and arcane abilities:
```bash
echo 'eval "$(em-init-script)"' >> ~/.bashrc
```
3. (Optional) Summon `fzf` for a mystical user experience:
``` bash
git clone --depth 1 https://github.com/junegunn/fzf.git ~/.fzf
~/.fzf/install
```
Consult the [fzf grimoire](https://github.com/junegunn/fzf#installation) for more details.
## 📗 Grimoire of Usage
Harness the power of ExpMonkey as you navigate the treacherous terrain of experiments:
### 🌱 Sprout a New Repository
```bash
em clone git@github.com:megvii-research/RevCol.git
```
### 📜 Parchment of Experiments
```bash
em ls -as
```
### 🌿 Branch Out with Forks
```bash
em cp <base-branch-name> <new-branch-name>
```
### 🚀 Propel Your New Creation
```bash
em cd <new-branch-name>
# Enchant with your changes
em push
```
## 🧙♂️ Command Incantations
### The Dot Trick 🐒🐒🐒
ExpMonkey's eyes gleam when spotting a `.`. Behold the magic:
### 🕳️ Conjure from the Void
Create an empty experiment:
``` shell
em empty <branch-name>
```
### 🔍 Scrying List
Peer into the branches:
``` shell
em ls # unveil local branches
em ls <filter-regex> # filter through local branches
em ls -as # reveal remote branches with status
```
`em ls -as` illuminates branches with enchanted hues:
| Color | Meaning |
| ---- | ---- |
| Red | Distant Lands (Remote) |
| White | Uncharted (Not Checked out) |
| Blue | Whispering Winds (Not Pushed) |
| Yellow | Altered Realms (Modified) |
| Normal | Harmony (Clean) |
`em ls` is a swift spell, while `em ls -as` consults distant spirits, requiring more time.
### 🌟 Starry Copy
Craft a new branch from existing strands of fate:
``` shell
em cp <Tab> <target-branch-name> # divine local branches
em cp .r<Tab> <target-branch-name> # divine all branches
em cp <base-branch-name> .<Tab> # scribe as base-branch-name
em cp .<Tab> <target-branch-name> # scribe as current-branch-name
em cp . <target-branch-name> # duplicate current branch
```
### 🌀 Portal to Another Branch
Step into another experiment:
``` shell
em co <Tab> # divine local branches
em co .r<Tab> # divine all branches
em co <branch-name> # step through the portal
```
### 🗑️ Banish an Experiment
Cast away an unwanted branch:
``` shell
em rm <branch-name> # banish branch
em rm . # banish current branch
```
### 🌌 Push to the Cosmos
Send your experiment into the vast unknown:
``` shell
em push # launch it skyward
```
### 📛 Rename Your Destiny
Alter the name of your journey:
``` shell
em mv <current-branch-name> <target-branch-name>
```
### 🔮 Gaze into Differences
Witness the divergence between realms:
``` shell
em diff <branch1> <branch2>
```
## 📜 License
This project is a tome of knowledge, open to all seekers under the [MIT License](LICENSE).
Raw data
{
"_id": null,
"home_page": null,
"name": "expmonkey",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.5",
"maintainer_email": "liuyibo <liuyibo1994@qq.com>",
"keywords": "branch management, code branching, code experiments, command-line interface, development tools, experiment management, git branches, git enhancements, git worktree, machine learning experiments, parallel development, project organization, research workflow, scientific experiments, version control, workspace management",
"author": null,
"author_email": "liuyibo <liuyibo1994@qq.com>",
"download_url": "https://files.pythonhosted.org/packages/96/25/b7d9ed0fb11d755270e3160d65a8829f9e5cad3472227e22c45871ca176d/expmonkey-0.0.35.tar.gz",
"platform": null,
"description": "# \ud83d\udc12 ExpMonkey: Unleash Your Experiments with Git Magic! \ud83c\udf4c\n\nWelcome to ExpMonkey, the nimble experiment management tool that transforms the way you handle your research and development projects. By harnessing the power of git worktrees, ExpMonkey offers a command-line sanctuary for your branches, treating each one as a unique adventure in the jungle of innovation. Ready to swing from experiment to experiment with the grace of a seasoned primate? \ud83c\udf3f Let's dive in!\n\n## \ud83c\udf1f Spotlight Features\n\nEmbark on a journey with ExpMonkey and discover a world where managing multiple experiments feels like a walk in the park:\n\n- \ud83c\udf4c **Parallel Universe Workflow**: Each git branch becomes an alternate reality, with its own directory to tinker in. Work on multiple fronts without ever tangling your vines.\n\n- \ud83c\udf4c **Jungle Gym Navigation**: Leap between branches with a simple command. It's like having a map of the entire jungle at your fingertips.\n\n- \ud83c\udf4c **Git Sorcery Enhanced**: ExpMonkey casts a spell on the standard git rituals, streamlining branch antics and conjuring up tools specifically for the experimental alchemist.\n\n- \ud83c\udf4c **Branch Alchemy**: Transmute, clone, and compare experiments with the dexterity of a monkey's tail, all thanks to ExpMonkey's clever branch wizardry.\n\n- \ud83c\udf4c **Chant Autocompletion**: Invoke the spirits of speed and precision with our autocompletion incantations, banishing typos to the shadow realm.\n\n- \ud83c\udf4c **Fuzzy Oracle Integration**: Consult the `fzf` oracle for visions of branches and commits, selecting your path with the clarity of a shaman's trance.\n\n## \ud83d\udcdc Prerequisites\n\nBefore you embark on this quest, ensure you have the following relics:\n\n- Python 3.x\n- Git\n- Optional: `fzf` for an enhanced soothsaying interface\n\n## \ud83d\udee0 Installation: Summoning ExpMonkey\n\nInvoke ExpMonkey into your realm with these ancient incantations:\n\n1. Conjure the Python package:\n```shell\npip3 install expmonkey\n```\n\n2. (Optional) Weave `em-init-script` into your shell's tapestry for autocompletion and arcane abilities:\n```bash\necho 'eval \"$(em-init-script)\"' >> ~/.bashrc\n```\n\n3. (Optional) Summon `fzf` for a mystical user experience:\n``` bash\ngit clone --depth 1 https://github.com/junegunn/fzf.git ~/.fzf\n~/.fzf/install\n```\nConsult the [fzf grimoire](https://github.com/junegunn/fzf#installation) for more details.\n\n## \ud83d\udcd7 Grimoire of Usage\n\nHarness the power of ExpMonkey as you navigate the treacherous terrain of experiments:\n\n### \ud83c\udf31 Sprout a New Repository\n```bash\nem clone git@github.com:megvii-research/RevCol.git\n```\n\n### \ud83d\udcdc Parchment of Experiments\n```bash\nem ls -as\n```\n\n### \ud83c\udf3f Branch Out with Forks\n```bash\nem cp <base-branch-name> <new-branch-name>\n```\n\n### \ud83d\ude80 Propel Your New Creation\n```bash\nem cd <new-branch-name>\n# Enchant with your changes\nem push\n```\n\n## \ud83e\uddd9\u200d\u2642\ufe0f Command Incantations\n\n### The Dot Trick \ud83d\udc12\ud83d\udc12\ud83d\udc12\nExpMonkey's eyes gleam when spotting a `.`. Behold the magic:\n\n### \ud83d\udd73\ufe0f Conjure from the Void\nCreate an empty experiment:\n``` shell\nem empty <branch-name>\n```\n\n### \ud83d\udd0d Scrying List\nPeer into the branches:\n``` shell\nem ls # unveil local branches\nem ls <filter-regex> # filter through local branches\nem ls -as # reveal remote branches with status\n```\n\n`em ls -as` illuminates branches with enchanted hues:\n\n| Color | Meaning |\n| ---- | ---- |\n| Red | Distant Lands (Remote) |\n| White | Uncharted (Not Checked out) |\n| Blue | Whispering Winds (Not Pushed) |\n| Yellow | Altered Realms (Modified) |\n| Normal | Harmony (Clean) |\n\n`em ls` is a swift spell, while `em ls -as` consults distant spirits, requiring more time.\n\n### \ud83c\udf1f Starry Copy\nCraft a new branch from existing strands of fate:\n``` shell\nem cp <Tab> <target-branch-name> # divine local branches\nem cp .r<Tab> <target-branch-name> # divine all branches\nem cp <base-branch-name> .<Tab> # scribe as base-branch-name\nem cp .<Tab> <target-branch-name> # scribe as current-branch-name\nem cp . <target-branch-name> # duplicate current branch\n```\n\n### \ud83c\udf00 Portal to Another Branch\nStep into another experiment:\n``` shell\nem co <Tab> # divine local branches\nem co .r<Tab> # divine all branches\nem co <branch-name> # step through the portal\n```\n\n### \ud83d\uddd1\ufe0f Banish an Experiment\nCast away an unwanted branch:\n``` shell\nem rm <branch-name> # banish branch\nem rm . # banish current branch\n```\n\n### \ud83c\udf0c Push to the Cosmos\nSend your experiment into the vast unknown:\n``` shell\nem push # launch it skyward\n```\n\n### \ud83d\udcdb Rename Your Destiny\nAlter the name of your journey:\n``` shell\nem mv <current-branch-name> <target-branch-name>\n```\n\n### \ud83d\udd2e Gaze into Differences\nWitness the divergence between realms:\n``` shell\nem diff <branch1> <branch2>\n```\n\n## \ud83d\udcdc License\n\nThis project is a tome of knowledge, open to all seekers under the [MIT License](LICENSE).\n",
"bugtrack_url": null,
"license": null,
"summary": "A git worktree-based CLI tool for efficient management and navigation of multiple isolated experiments in parallel development workflows",
"version": "0.0.35",
"project_urls": {
"Homepage": "https://github.com/liuyibo/expmonkey",
"Issues": "https://github.com/liuyibo/expmonkey/issues"
},
"split_keywords": [
"branch management",
" code branching",
" code experiments",
" command-line interface",
" development tools",
" experiment management",
" git branches",
" git enhancements",
" git worktree",
" machine learning experiments",
" parallel development",
" project organization",
" research workflow",
" scientific experiments",
" version control",
" workspace management"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "928432ea0b738b0a002f98c1e99f9f31f1d119284a71e7afea03387bb56b8789",
"md5": "4e1f15bcca1653458ef64753b75394fd",
"sha256": "5e09545a8aed11e78ea0aa567294a1c34dd3c497fa227c54b6aa8a8153f7b930"
},
"downloads": -1,
"filename": "expmonkey-0.0.35-py3-none-any.whl",
"has_sig": false,
"md5_digest": "4e1f15bcca1653458ef64753b75394fd",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.5",
"size": 11481,
"upload_time": "2024-05-03T14:40:58",
"upload_time_iso_8601": "2024-05-03T14:40:58.540655Z",
"url": "https://files.pythonhosted.org/packages/92/84/32ea0b738b0a002f98c1e99f9f31f1d119284a71e7afea03387bb56b8789/expmonkey-0.0.35-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "9625b7d9ed0fb11d755270e3160d65a8829f9e5cad3472227e22c45871ca176d",
"md5": "1fb3412b2ed2ada3c3b796b68b75dab6",
"sha256": "bc988fccbc03e6905a9de46513487892ca0dc587371d11c78811096448cb4f93"
},
"downloads": -1,
"filename": "expmonkey-0.0.35.tar.gz",
"has_sig": false,
"md5_digest": "1fb3412b2ed2ada3c3b796b68b75dab6",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.5",
"size": 12352,
"upload_time": "2024-05-03T14:41:00",
"upload_time_iso_8601": "2024-05-03T14:41:00.045713Z",
"url": "https://files.pythonhosted.org/packages/96/25/b7d9ed0fb11d755270e3160d65a8829f9e5cad3472227e22c45871ca176d/expmonkey-0.0.35.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-05-03 14:41:00",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "liuyibo",
"github_project": "expmonkey",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"lcname": "expmonkey"
}
JSON
