# es-gitlab-scraper

> This is a scraper which collects data from an specific GitLab account with the goal of giving out reports about what students have done and even qualifying of their practices in a short time.

Latest version **0.1.0** (published 2019-04-14) · MIT license · 0 weekly downloads

## Install

```sh
npm install es-gitlab-scraper
pnpm add es-gitlab-scraper
yarn add es-gitlab-scraper
bun add es-gitlab-scraper
```

Provides the command `es-gitlab-scraper`.

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.1.0 |
| Published | 2019-04-14 |
| First published | 2019-04-08 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 7 |
| Unpacked size | 51.7 KB |
| Known vulnerabilities | 0 (+24 in 1 direct dependencies) |
| Install scripts | no |
| Author | Alireza Sheikholmolouki |
| Maintainers | alireza29675 |

## Links

- npm: https://www.npmjs.com/package/es-gitlab-scraper
- npm.io page: https://npm.io/package/es-gitlab-scraper

## Dependencies (7)

- [ora](https://npm.io/package/ora.md) ^3.4.0
- [axios](https://npm.io/package/axios.md) ^0.18.0
- [chalk](https://npm.io/package/chalk.md) ^2.4.2
- [inquirer](https://npm.io/package/inquirer.md) ^6.2.2
- [cli-table](https://npm.io/package/cli-table.md) ^0.3.1
- [write-csv](https://npm.io/package/write-csv.md) ^1.0.0
- [handy-storage](https://npm.io/package/handy-storage.md) ^2.0.1

## Recent versions

- 0.1.0 (latest) — 2019-04-14
- 0.0.4 — 2019-04-08
- 0.0.3 — 2019-04-08
- 0.0.2 — 2019-04-08
- 0.0.1 — 2019-04-08

## README

# ES Gitlab Scraper

This is a scraper which collects data from an specific GitLab account with the goal of giving out reports about what students have done and even qualifying of their practices in a short time.

## How to run the scraper

1. First, you have to install [Node.js and npm](https://nodejs.org/) on your system.

2. Then you can install `es-gitlab-scraper` by running following command:

    ```bash
    sudo npm install -g es-gitlab-scraper
    ```

3. After installing the app, you can simply run it by running:

    ```bash
    es-gitlab-scraper
    ```

4. If you're running `es-gitlab-scraper` for the first time, you'll be asked for entering your API token. you can [create it here if you haven't already had it](https://docs.gitlab.com/ee/user/profile/personal_access_tokens.html#creating-a-personal-access-token).


## How to use

There are different options to use:

- **Show a Full Table Report**
    > Shows a full table report of student names, their weekly projects and challenges.
- **Which projects are empty?**
    > Gives a report about empty projects (no week practices and no challenges.)
- **Who didn't do any challenge?**
    > Gives a report about projects which not include challenge within.
- **Show students and their projects**
    > Shows a table of students, and the links to their repositories
- **Export report to CSV**
    > Exports all analyzed data into a CSV file
- **Re-assign access token**
    > Re-assigns a new token if you've changed if in your Gitlab account. This may be used for security reasons from administrators.
- **Re-store All Projects**
    > Crawls and scraps all projects data again, and store them into app's local DB.

---
_Source: https://npm.io/package/es-gitlab-scraper · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._