Descarga github metadata - Descargar el código fuente github metadata

github-metadata

Reúna los metadatos de GitHub sobre un repositorio.

Instalar

Instalar con NPM:

$ npm install --save github-metadata

Instalar con hilo:

$ yarn add github-metadata

Uso

 var metadata = require ( 'github-metadata' ) ;

API

metadatos

Recoja metadatos de GitHub para el repositorio especificado. Esto intenta obtener los mismos metadatos utilizados por Jekyll y especificados en los documentos de GitHub. Algunos de los metadatos requieren autenticación, lo que requiere pasar un username y password o token en el objeto options . Es mejor usar un token de acceso personal desde Github. Vea la sección de resultados para ver cómo se ve el objeto de metadatos devuelto

Parámetros

options {Object} : Opciones Objeto que contiene autenticación y detalles del repositorio.
options.owner {String} : el usuario u organización que posee el repositorio. Este es el primer segmento de ruta después de "https://github.com/".
options.repo {String} : el nombre del repositorio para obtener metadatos para. Este es el segundo segmento de ruta después de "https://github.com/".
options.exclude {Array} : opcionalmente, pase una lista de propiedades de nivel superior para excluir de los metadatos al no descargarlo de GitHub.
options.username {String} : Opcionalmente, proporcione un nombre de usuario GitHub para la autenticación. Esto solo es necesario cuando se usa username/password para autenticación.
options.password {String} : opcionalmente, proporcione una contraseña de GitHub para la autenticación. Esto solo es necesario cuando se usa username/password para autenticación.
options.token {String} : Opcionalmente, proporcione un token de acceso personal GitHub para la autenticación. Esto solo es necesario con el uso de OAuth (en lugar de username/password ) para la autenticación.
returns {Promise} : Devuelve una promesa que tendrá metadatos de repositorios cuando se resuelva.

Ejemplo

 var options = {
  token : 'XXXXXXXXXX' // get this from GitHub,
  owner : 'doowb' ,
  repo : 'github-metadata'
} ;

metadata ( options )
  . then ( function ( data ) {
    console . log ( data ) ;
    //=> {
    //=>   // this object contains all of the metadata that was gather from GitHub
    //=> }
  } )
  . catch ( console . error ) ;

Resultados

El siguiente objeto representa los metadatos de GitHub que se devuelven para el repositorio de ensamble/ensamble. Los elementos de las propiedades que contienen matrices largas se han eliminado y reemplazado con ... Consulte el objeto JSON completo y la documentación de la API de GitHub para obtener más información sobre los elementos en esas matrices.

 {
  "public_repositories" : [
    ...
  ] ,
  "organization_members" : [
    ...
  ] ,
  "contributors" : [
    ...
  ] ,
  "collaborators" : [
    ...
  ] ,
  "branches" : [
    ...
  ] ,
  "languages" : {
    "CSS" : 483616 ,
    "JavaScript" : 102873 ,
    "HTML" : 44790
  } ,
  "teams" : [
    ...
  ] ,
  "releases" : [
    ...
  ] ,
  "tags" : [
    ...
  ] ,
  "repository" : {
    "id" : 5916767 ,
    "name" : "assemble" ,
    "full_name" : "assemble/assemble" ,
    "owner" : {
      "login" : "assemble" ,
      "id" : 2645080 ,
      "avatar_url" : "https://avatars3.githubusercontent.com/u/2645080?v=3" ,
      "gravatar_id" : "" ,
      "url" : "https://api.github.com/users/assemble" ,
      "html_url" : "https://github.com/assemble" ,
      "followers_url" : "https://api.github.com/users/assemble/followers" ,
      "following_url" : "https://api.github.com/users/assemble/following{/other_user}" ,
      "gists_url" : "https://api.github.com/users/assemble/gists{/gist_id}" ,
      "starred_url" : "https://api.github.com/users/assemble/starred{/owner}{/repo}" ,
      "subscriptions_url" : "https://api.github.com/users/assemble/subscriptions" ,
      "organizations_url" : "https://api.github.com/users/assemble/orgs" ,
      "repos_url" : "https://api.github.com/users/assemble/repos" ,
      "events_url" : "https://api.github.com/users/assemble/events{/privacy}" ,
      "received_events_url" : "https://api.github.com/users/assemble/received_events" ,
      "type" : "Organization" ,
      "site_admin" : false
    } ,
    "private" : false ,
    "html_url" : "https://github.com/assemble/assemble" ,
    "description" : "Static site generator and rapid prototyping framework for Node.js, Grunt.js, and Yeoman and Gulp. Render templates with Handlebars, Lo-Dash or any template engine. Used by Less.js / lesscss.org, Topcoat, Web Experience Toolkit, and hundreds of other projects to build sites, themes, components, documentation, blogs and gh-pages." ,
    "fork" : false ,
    "url" : "https://api.github.com/repos/assemble/assemble" ,
    "forks_url" : "https://api.github.com/repos/assemble/assemble/forks" ,
    "keys_url" : "https://api.github.com/repos/assemble/assemble/keys{/key_id}" ,
    "collaborators_url" : "https://api.github.com/repos/assemble/assemble/collaborators{/collaborator}" ,
    "teams_url" : "https://api.github.com/repos/assemble/assemble/teams" ,
    "hooks_url" : "https://api.github.com/repos/assemble/assemble/hooks" ,
    "issue_events_url" : "https://api.github.com/repos/assemble/assemble/issues/events{/number}" ,
    "events_url" : "https://api.github.com/repos/assemble/assemble/events" ,
    "assignees_url" : "https://api.github.com/repos/assemble/assemble/assignees{/user}" ,
    "branches_url" : "https://api.github.com/repos/assemble/assemble/branches{/branch}" ,
    "tags_url" : "https://api.github.com/repos/assemble/assemble/tags" ,
    "blobs_url" : "https://api.github.com/repos/assemble/assemble/git/blobs{/sha}" ,
    "git_tags_url" : "https://api.github.com/repos/assemble/assemble/git/tags{/sha}" ,
    "git_refs_url" : "https://api.github.com/repos/assemble/assemble/git/refs{/sha}" ,
    "trees_url" : "https://api.github.com/repos/assemble/assemble/git/trees{/sha}" ,
    "statuses_url" : "https://api.github.com/repos/assemble/assemble/statuses/{sha}" ,
    "languages_url" : "https://api.github.com/repos/assemble/assemble/languages" ,
    "stargazers_url" : "https://api.github.com/repos/assemble/assemble/stargazers" ,
    "contributors_url" : "https://api.github.com/repos/assemble/assemble/contributors" ,
    "subscribers_url" : "https://api.github.com/repos/assemble/assemble/subscribers" ,
    "subscription_url" : "https://api.github.com/repos/assemble/assemble/subscription" ,
    "commits_url" : "https://api.github.com/repos/assemble/assemble/commits{/sha}" ,
    "git_commits_url" : "https://api.github.com/repos/assemble/assemble/git/commits{/sha}" ,
    "comments_url" : "https://api.github.com/repos/assemble/assemble/comments{/number}" ,
    "issue_comment_url" : "https://api.github.com/repos/assemble/assemble/issues/comments{/number}" ,
    "contents_url" : "https://api.github.com/repos/assemble/assemble/contents/{+path}" ,
    "compare_url" : "https://api.github.com/repos/assemble/assemble/compare/{base}...{head}" ,
    "merges_url" : "https://api.github.com/repos/assemble/assemble/merges" ,
    "archive_url" : "https://api.github.com/repos/assemble/assemble/{archive_format}{/ref}" ,
    "downloads_url" : "https://api.github.com/repos/assemble/assemble/downloads" ,
    "issues_url" : "https://api.github.com/repos/assemble/assemble/issues{/number}" ,
    "pulls_url" : "https://api.github.com/repos/assemble/assemble/pulls{/number}" ,
    "milestones_url" : "https://api.github.com/repos/assemble/assemble/milestones{/number}" ,
    "notifications_url" : "https://api.github.com/repos/assemble/assemble/notifications{?since,all,participating}" ,
    "labels_url" : "https://api.github.com/repos/assemble/assemble/labels{/name}" ,
    "releases_url" : "https://api.github.com/repos/assemble/assemble/releases{/id}" ,
    "deployments_url" : "https://api.github.com/repos/assemble/assemble/deployments" ,
    "created_at" : "2012-09-22T20:50:23Z" ,
    "updated_at" : "2017-06-15T01:09:31Z" ,
    "pushed_at" : "2017-05-20T00:33:33Z" ,
    "git_url" : "git://github.com/assemble/assemble.git" ,
    "ssh_url" : "[email protected]:assemble/assemble.git" ,
    "clone_url" : "https://github.com/assemble/assemble.git" ,
    "svn_url" : "https://github.com/assemble/assemble" ,
    "homepage" : "http://assemble.io/" ,
    "size" : 13050 ,
    "stargazers_count" : 3350 ,
    "watchers_count" : 3350 ,
    "language" : "CSS" ,
    "has_issues" : true ,
    "has_projects" : true ,
    "has_downloads" : true ,
    "has_wiki" : true ,
    "has_pages" : false ,
    "forks_count" : 225 ,
    "mirror_url" : null ,
    "open_issues_count" : 26 ,
    "forks" : 225 ,
    "open_issues" : 26 ,
    "watchers" : 3350 ,
    "default_branch" : "master" ,
    "permissions" : {
      "admin" : true ,
      "push" : true ,
      "pull" : true
    } ,
    "allow_squash_merge" : true ,
    "allow_merge_commit" : true ,
    "allow_rebase_merge" : true ,
    "organization" : {
      "login" : "assemble" ,
      "id" : 2645080 ,
      "avatar_url" : "https://avatars3.githubusercontent.com/u/2645080?v=3" ,
      "gravatar_id" : "" ,
      "url" : "https://api.github.com/users/assemble" ,
      "html_url" : "https://github.com/assemble" ,
      "followers_url" : "https://api.github.com/users/assemble/followers" ,
      "following_url" : "https://api.github.com/users/assemble/following{/other_user}" ,
      "gists_url" : "https://api.github.com/users/assemble/gists{/gist_id}" ,
      "starred_url" : "https://api.github.com/users/assemble/starred{/owner}{/repo}" ,
      "subscriptions_url" : "https://api.github.com/users/assemble/subscriptions" ,
      "organizations_url" : "https://api.github.com/users/assemble/orgs" ,
      "repos_url" : "https://api.github.com/users/assemble/repos" ,
      "events_url" : "https://api.github.com/users/assemble/events{/privacy}" ,
      "received_events_url" : "https://api.github.com/users/assemble/received_events" ,
      "type" : "Organization" ,
      "site_admin" : false
    } ,
    "network_count" : 225 ,
    "subscribers_count" : 121
  } ,
  "pages_info" : {
    "message" : "Not Found" ,
    "documentation_url" : "https://developer.github.com/v3"
  } ,
  "pages" : {
    "env" : "development" ,
    "test" : false ,
    "dotcom" : false ,
    "enterprise" : false ,
    "development" : true ,
    "ssl" : false ,
    "schema" : "http" ,
    "custom_domains_enabled" : false ,
    "github_hostname" : "github.com" ,
    "pages_hostname" : "localhost:4000" ,
    "github_url" : "http://github.com" ,
    "api_url" : "https://api.github.com" ,
    "help_url" : "https://help.github.com"
  } ,
  "hostname" : "github.com" ,
  "pages_hostname" : "localhost:4000" ,
  "api_url" : "https://api.github.com" ,
  "help_url" : "https://help.github.com" ,
  "environment" : "development" ,
  "pages_env" : "development" ,
  "url" : "https://github.com/assemble/assemble" ,
  "project_title" : "assemble" ,
  "repository_name" : "assemble" ,
  "repository_nwo" : "assemble/assemble" ,
  "project_tagline" : "Static site generator and rapid prototyping framework for Node.js, Grunt.js, and Yeoman and Gulp. Render templates with Handlebars, Lo-Dash or any template engine. Used by Less.js / lesscss.org, Topcoat, Web Experience Toolkit, and hundreds of other projects to build sites, themes, components, documentation, blogs and gh-pages." ,
  "owner_name" : "assemble" ,
  "owner_gravatar_url" : "http://github.com/assemble.png}" ,
  "repository_url" : "https://github.com/assemble/assemble" ,
  "language" : "CSS" ,
  "show_downloads" : true ,
  "owner_url" : "http://github.com/assemble" ,
  "zip_url" : "http://github.com/assemble/assemble/zipball/gh_pages" ,
  "tar_url" : "http://github.com/assemble/assemble/tarball/gh_pages" ,
  "clone_url" : "http://github.com/assemble/assemble.git" ,
  "releases_url" : "http://github.com/assemble/assemble/releases" ,
  "issues_url" : "http://github.com/assemble/assemble/issues" ,
  "wiki_url" : "http://github.com/assemble/assemble/wiki" ,
  "is_user_page" : false ,
  "is_project_page" : true
}

Acerca de

Proyectos relacionados

Ensamble: ¡saca las rocas de tus calcetines! Ensamblar te hace rápido en la creación de proyectos web ... más | página principal
GitHub-Base: Wrapper JavaScript que simplifica enormemente el trabajo con la API de GitHub. | página principal

Que contribuye

Las solicitudes y las estrellas siempre son bienvenidas. Para errores y solicitudes de funciones, cree un problema.

Lea la guía de contribución para obtener asesoramiento sobre problemas de apertura, solicitudes de extracción y estándares de codificación.

Construcción de documentos

(El verbo genera el readMe.md de este proyecto, no edite el readMe directamente. Cualquier cambio en el ReadMe debe realizarse en la plantilla .verb.md ReadMe).

Para generar el ReadMe, ejecute el siguiente comando:

$ npm install -g verbose/verb#dev verb-generate-readme && verb

Pruebas de ejecución

Ejecutar y revisar las pruebas unitarias es una excelente manera de familiarizarse con una biblioteca y su API. Puede instalar dependencias y ejecutar pruebas con el siguiente comando: