ghedsh 1.1.39 → 1.1.40

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: c81ab0cbd1e2dd44e2aa3679176b5ae079e9bddc
-  data.tar.gz: ba021c28e9f2a32a5aea738e36c84bd525005391
+  metadata.gz: c64f6b3a212a113c203031a57ee86bed73545e1b
+  data.tar.gz: b4523ad22001791403763cee8b8fef349786e713
 SHA512:
-  metadata.gz: 2f2859e405ac8e55bba00e33c01882c9e882fd77aad735aa08a1b25dce34584dc7e4a21d7eca578c0853c0aa99fd8cb727d72ee8084c4c05f2bf54123d417bf5
-  data.tar.gz: a843631878ec2a7eb2d572403186df56f30b63f5c0bc473b34fe78f160228d753885b7c09eb0069f2c283e4e97892da0b0d0dc1467cc71dcdd622be02a06efd8
+  metadata.gz: 561817bf58d181b357cd06136aad98fa2d9e6dd498077614fe0d97b3d2b8bd91b6ba2c301a46a0e8d3d1b2cc73dd29b81c1feed6ca732e577bbb7731b41b78c8
+  data.tar.gz: d8ddd86623e67fff0207b00ea31344a325efff96663d9d517637f8243ac00d1d9c51808228575328a6a8514a5f1429164e09f8b91f1843b01f12b980eb3ca3b0

data/.gitignore

@@ -5,7 +5,7 @@
 /lib/db/assignments2.json
 .ghedsh
 script
-
+tags
 *.csv
 *.gem
 *.rbc

data/README.md

@@ -1,15 +1,15 @@
 ![](http://i125.photobucket.com/albums/p79/NooK1e_RG/ghedsh2_zpsdsdlzg1t.png)
-#GITHUB EDUCATION SHELL
+# GITHUB EDUCATION SHELL
 
 A command line program following the philosophy of GitHub Education.
 
-##How does it work?
+## How does it work?
 
 This program give you an interaction with Github like you was using your command line simulating a tree structure. Each level on the tree gives you several options of managing your Github account or your Organization.
 
 Following the philosophy of Github Education, you can use this application to managing your own organization as a classroom where you can make assignments to your students using repository strategies.    
 
-##Installing GHEDSH
+## Installing GHEDSH
 
 You can download the gem **ghdesh** from rubygem.
 
@@ -17,7 +17,7 @@ You can download the gem **ghdesh** from rubygem.
 
 To run the app you need to call the binary file "ghedsh" in your command line after install it. Configuration files are being set in a hidden directory called *.ghedsh*, in your Home path.  
 
-###First step: Oauth requirements.
+### First step: Oauth requirements.
 
 Ir order to run this program, you need to make an **Access token** from Github with create and edit scope. When you run the program, it asks you the access token to identify yourself with no need to use your user and password.
 
@@ -25,7 +25,7 @@ Ir order to run this program, you need to make an **Access token** from Github w
 
 You need to tick all options, unless admin:gpg_key scopes.  
 
-###ghedsh executable options
+### ghedsh executable options
 
 '-t' or '--token token'. Provides a github access token by argument.
 
@@ -38,7 +38,7 @@ You need to tick all options, unless admin:gpg_key scopes.
 This program creates a directory called *.ghedsh* in your home with all configuration files that it needs.
 
 
-##Basic usage
+## Basic usage
 Logged in our app you start set in your personal profile. There you can list your repositories, create repositories, see your organizations and other options that you can see using the command *help* in your command line. You can go inside of a specific organization with the command *cd* and start to managing itself. Its possible to create task for the members your organization, create teamworks and many options that you can see again with *help*. You can move and go back in the tree directory as it is possible in the github structure.
 
 ```
@@ -53,7 +53,7 @@ Levels
     └── User Repositories
 ```
 
-##Lista de comandos
+## Lista de comandos
 
 
 ```sh
@@ -98,28 +98,28 @@ teams
 Muestra todos los equipos de una organizacion.
 
 ```sh
-new_team <nombre> <miembro1> <miembro2> ...
+new team <nombre> <miembro1> <miembro2> ...
 ```
 Crea un equipo a al que le sera asignado uno o varios miembros de la organizacion.
 
 ```sh
-rm_team <nombre> <miembro1> <miembro2> ...
+rm team <nombre> <miembro1> <miembro2> ...
 ```
 Borra un equipo de una organizacion.
 
 ```sh
-add_to_team <miembro1> <miembro2> ...
+add to team <miembro1> <miembro2> ...
 ```
 
 Dentro de un equipo en una organizacion, añadira nuevos miembros al equipo de trabajo.
 
 ```sh
-new_group <nombre> <equipo1> <equipo2> ...
+new group <nombre> <equipo1> <equipo2> ...
 ```
 Dentro de una organizacion, crea grupos donde asignar equipos de trabajo.
 
 ```sh
-rm_group <nombre> <equipo1> <equipo2> ...
+rm group <nombre> <equipo1> <equipo2> ...
 ```
 Dentro de una organizacion, borra un grupo de trabajo.
 
@@ -134,12 +134,12 @@ assignments
 Muestra las tareas o asignaciones hechas para una organizacion.
 
 ```sh
-new_repository <nombre>
+new repository <nombre>
 ```
 Crea un repositorio para un usuario, para una organizacion, o para un equipo dentro de una organizacion. Espera el nombre del repositorio.
 
 ```sh
-rm_repository <nombre>
+rm repository <nombre>
 ```
 Borra un repositorio de un usuario o de una organizacion. El comando espera el nombre del repositorio, ademas pedira confirmacion para el borrado del mismo si se ha comprobado su existencia.
 
@@ -163,21 +163,109 @@ people info <usuario>
 ```
 Muestra la informacion extendida de un miembro especifico de una organizacion.
 
+```
+user>organization> new relation file.csv
+```
+Esta orden provee un mecanismo para ampliar posteriormente 
+la información sobre la gente/estudiantes (`people`) en la organización.
+Establece una `relación` entre el nombre de usuario GitHub y un campo que servirá para la identificación
+del usuario en la institución educativa.
+
+En este ejemplo se establece el enlace entre la clave primaria de github (el nombre de usuario github)
+y el email del alumno/profesor en la universidad:
+
+```
+crguezl>ULL-ESIT-GRADOII-TFG> new relation tfg-people.csv
+```
+El fichero `tfg-people.csv` contiene lo siguiente:
+```
+~/ghedsh(master)]$ cat tfg-people.csv 
+"github","mail"
+"alu0100505023","Clemente.ull.edu.es"
+"alu0100769579","Raul.ull.edu.es"
+"alu0100816167","Carlos.ull.edu.es"
+"berkanrhdz","Berkan.ull.edu.es"
+"Cicko","Rudolf.ull.edu.es"
+"crguezl","Casiano.ull.edu.es"
+"EleDiaz","Eleazar.ull.edu.es"
+"jjlabrador","JJ.ull.edu.es"
+"Losnen","Samuel.ull.edu.es"
+"sokartema","Jazer.ull.edu.es"
+```
+Ahora podemos consultar de nuevo la información sobre los miembros:
+```
+crguezl>ULL-ESIT-GRADOII-TFG> people info /alu/
+
+alu0100505023
+Github:	 alu0100505023
+Email:	 Clemente.ull.edu.es
+
+...
+```
+
+
 ```sh
-add_people_info	<file>
+new people info	<file>
 ```
 Añade informacion extendida de los miembros de una organizacion mediante un archivo .csv.
 
 Formato y campos de la informacion añadida: La primera linea del archivo .csv debera indicar el nombre de los campos que seran recogidos por el sistema.
 
-> "github", "id", "nombre", "apellido", "emails", "organizaciones", "urls"
+```
+ "github", "id", "nombre", "apellido", "emails", "organizaciones", "urls"
+```
 
 Ejemplo del contenido del archivo .csv. A partir de la primera linea de campos, cada nueva linea representara los datos de un alumno. Poniendo dobles comillas se podra añadir varios valores en un mismo campo.
 
-> "studentbeta","alu1342","Pedro,Garcia Perez,""alu1342@ull.edu.es, pedrogarciaperez@gmail.com"",""classroom-testing, SYTW1617"",""http://campusvirtual.ull.es/aluXXX, http://pegarpe.github.io""
+```
+ "studentbeta","alu1342","Pedro,Garcia Perez,""alu1342@ull.edu.es, pedrogarciaperez@gmail.com"",""classroom-testing, SYTW1617"",""http://campusvirtual.ull.es/aluXXX, http://pegarpe.github.io""
+```
 
 > "studentalpha1","alu321","Paco","Gutierrez","alu321@ull.edu.es","classroom-testing",","http://st.github.com"
 
+Ejemplo:
+
+```
+crguezl>ULL-ESIT-GRADOII-TFG> new people info tfg-people-2
+
+Fields found: 
+"github"
+"mail"
+"nota"
+```
+El fichero `tfg-people-2.csv` contiene:
+```
+[~/TFGsrc/clementeTFG/ghedsh(master)]$ cat tfg-people-2.csv 
+"github","mail","nota"
+"alu0100505023","Clemente.ull.edu.es",4
+"alu0100769579","Raul.ull.edu.es",6
+"alu0100816167","Carlos.ull.edu.es",7
+"berkanrhdz","Berkan.ull.edu.es",9
+"Cicko","Rudolf.ull.edu.es",8
+"crguezl","Casiano.ull.edu.es",5
+"EleDiaz","Eleazar.ull.edu.es",6
+"jjlabrador","JJ.ull.edu.es",9
+"Losnen","Samuel.ull.edu.es",8
+"sokartema","Jazer.ull.edu.es",9
+```
+Ahora podemos consultar la información añadida:
+```
+crguezl>ULL-ESIT-GRADOII-TFG> people info /alu.*6/
+
+alu0100769579
+Github:	 alu0100769579
+Email:	 Raul.ull.edu.es
+Nota:	 6
+
+
+alu0100816167
+Github:	 alu0100816167
+Email:	 Carlos.ull.edu.es
+Nota:	 7
+```
+
+
+
 
 ```sh
 files <path>
@@ -215,24 +303,24 @@ issue <id>
 Muestra un issue especifico, y permite ver ademas sus comentarios.
 
 ```sh
-add_issue_comment <id>
+new issue comment <id>
 ```
 Añade un comentario a un issue especifico.
 
 ```sh
-new_issue <nombre>
+new issue <nombre>
 ```
 Crea un nuevo issue estando situado en un repositorio especifico. El titulo sera dado por parametro, y la descripcion sera introducida tras ejecutar el comando.
 
 ```sh
-close_issue <id>
+close issue <id>
 ```
 Cierra un issue especifico dentro de un repositorio. Se debe especificar el issue mediante la id del mismo.
 
 ###Comandos para las Tareas o asignaciones
 
 ```sh
-new_assignment <nombre>
+new assignment <nombre>
 ```
 Crea una asignacion para una organizacion. Espera por parametro el nombre. Tras ejecutar el comando pedira un repositorio ya existente, la creacion de uno nuevo o la no insercion de un repositorio. Ademas esperara una lista de grupos para asignar a la tarea, ademas de la posible creacion de un grupo al que se le añadiran sus equipos. Todos los pasos pueden ser saltados, y tanto los grupos como el repositorio pueden ser añadidos posteriormente mediante **add_group** y **add_repo**.
 
@@ -257,7 +345,7 @@ add_repo
 Dentro de la asignacion, se activara el proceso de añadido del repositorio. Entre las opciones a elegir, estara la de añadir un repositorio ya creado, crear un nuevo repositorio o saltar el paso y no añadir el repositorio. Si ya habia un repositorio asignado anteriormente, este comando lo reemplazara.
 
 ```sh
-add_group
+add group
 ```
 Dentro de la asignacion, se activara el proceso de añadido de groups. Entre las opciones a elegir, estaran la de añadir directamente grupos ya creados o crear uno desde cero. Si se crea uno desde cero se pedira un nombre o se creara un nombre con la fecha actual, despues se añadiran los equipos que perteneceran al grupo. Si ya existian grupos en la asignacion, este comando añadira otro mas a la lista.
 

data/lib/version.rb

@@ -1,3 +1,3 @@
 module Ghedsh
-  VERSION='1.1.39'
+  VERSION='1.1.40'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: ghedsh
 version: !ruby/object:Gem::Version
-  version: 1.1.39
+  version: 1.1.40
 platform: ruby
 authors:
 - Javier Clemente
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-06-01 00:00:00.000000000 Z
+date: 2018-01-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: octokit
@@ -80,6 +80,7 @@ files:
 - README.md
 - Rakefile
 - bin/ghedsh
+- docs/Javier-clemente-MemoriaTFG-ghedsh.pdf
 - ghedsh.gemspec
 - lib/actions/help.rb
 - lib/actions/orgs.rb
@@ -110,7 +111,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.5.1
+rubygems_version: 2.6.14
 signing_key: 
 specification_version: 4
 summary: A command line program following the philosophy of GitHub Education.