https://github.com/mathix420/swap
Simple components sharing tool
https://github.com/mathix420/swap
Last synced: 17 days ago
JSON representation
Simple components sharing tool
- Host: GitHub
- URL: https://github.com/mathix420/swap
- Owner: mathix420
- Created: 2020-04-09T09:01:59.000Z (about 6 years ago)
- Default Branch: master
- Last Pushed: 2023-09-09T10:44:38.000Z (almost 3 years ago)
- Last Synced: 2025-02-14T05:51:19.277Z (over 1 year ago)
- Language: Python
- Homepage:
- Size: 66.4 KB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
SWAP
Simple components sharing tool
# Installation
```bash
pip install swp
```
## Optionnal dependencies
```bash
# Linux
apt install tree
# MacOS
brew install tree
```
# Documentation
## Swapfile
`swap.yaml` example:
```yaml
git@github.com:mathix420/pylone.git:
# name: local_path:remote_path@optionnal_branch_or_commitID
pylone_utils: utils:pylone/utils
git@github.com:vuejs/ui.git:
vue_ui: components/vue_ui:src/components
```
## Commands
- `swp init` Will guide you for creating a new config file.
- `swp tree` Will show you the path structure of remotes.
- `swp sync` Will by directionnal update of tracked modules/files.
- `swp add` Will add the specified path to the swapfile.
- `swp rm` Will remove the specified path from the swapfile.
- `swp get` Will pull a module/file from a specified remote URL and add it to the swapfile.
**More detailed documentation is available [here](/docs/guide.md)**
> As `swp sync` will push local updates to remote, I recommand you to fork repositories like `vuejs/ui` to have write rights on thems.