diff --git a/README.md b/README.md index 84f28cd..5a3091d 100644 --- a/README.md +++ b/README.md @@ -1,51 +1,51 @@ Utilities scripts for c4science =============================== GetMyStuph ---------- - Clone the repository ``` git clone https://c4science.ch/source/phab-api.git c4science-scripts cd c4science-scripts ``` - Dependencies ``` pip install --user -r requirements.txt ``` - Generate a cli token here: https://c4science.ch/conduit/login/ - Create a .yml file with the repositories and group you want to import, - Take a look in the example.yml file for help. The script needs an explicit - list of your repositories to import. You can set global options in the __all__ + Take a look at the example .yml files for help. The script needs an explicit + list of your repositories to import. You can set global options in the `__all__` section and override it per repository. - Be sure that all user in an epfl group you want to import already have an account on c4science. Otherwise you can also re-run the script after they created their account and they will be added to the Projects your set - Run the script ``` ./getmystuph_in_phab.py --config config.yml -v ``` - Before running the script for good you should use the `--dry-run` option, which is showing what actions it will do without modifying anything on c4science ``` ./getmystuph_in_phab.py --config config.yml -v --dry-run ``` ### Windows users - [[https://www.python.org/downloads/windows/|Install Python 3]] and [[https://git-scm.com/download/win|Git Bash]] - Follow the install above and run the script like this in CMD.exe ``` python getmystuph_in_phab.py --config config.yml ```