{"id":19075805,"url":"https://github.com/lpsm-dev/gitlab-analytics","last_synced_at":"2025-06-17T09:04:53.022Z","repository":{"id":45215042,"uuid":"265874954","full_name":"lpsm-dev/gitlab-analytics","owner":"lpsm-dev","description":"✔️ In this repository we will create a script to get information in GitLab API","archived":false,"fork":false,"pushed_at":"2023-12-15T02:22:34.000Z","size":65,"stargazers_count":3,"open_issues_count":2,"forks_count":0,"subscribers_count":2,"default_branch":"master","last_synced_at":"2025-02-22T04:44:29.147Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/lpsm-dev.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2020-05-21T14:49:54.000Z","updated_at":"2022-09-29T15:18:32.000Z","dependencies_parsed_at":"2022-08-29T08:31:52.379Z","dependency_job_id":null,"html_url":"https://github.com/lpsm-dev/gitlab-analytics","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/lpsm-dev/gitlab-analytics","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/lpsm-dev%2Fgitlab-analytics","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/lpsm-dev%2Fgitlab-analytics/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/lpsm-dev%2Fgitlab-analytics/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/lpsm-dev%2Fgitlab-analytics/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/lpsm-dev","download_url":"https://codeload.github.com/lpsm-dev/gitlab-analytics/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/lpsm-dev%2Fgitlab-analytics/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":260326664,"owners_count":22992377,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-11-09T01:56:03.966Z","updated_at":"2025-06-17T09:04:52.974Z","avatar_url":"https://github.com/lpsm-dev.png","language":"Python","funding_links":["https://www.buymeacoffee.com/EatdMck"],"categories":[],"sub_categories":[],"readme":"\u003cp align=\"center\"\u003e\n  \u003cimg alt=\"gitlab\" src=\"https://natanfelles.github.io/assets/img_posts/gitlab.png\" width=\"250px\" float=\"center\"/\u003e\n\u003c/p\u003e\n\n\u003ch1 align=\"center\"\u003eWelcome to GitLab Analytics Repository\u003c/h1\u003e\n\n\u003cp align=\"center\"\u003e\n  \u003cstrong\u003eIn this repository we will create a simple script to get some information in GitLab API\u003c/strong\u003e\n\u003c/p\u003e\n\n\u003cp align=\"center\"\u003e\n  \u003ca href=\"https://github.com/lpmatos/gitlab-analytics\"\u003e\n    \u003cimg alt=\"Open Source\" src=\"https://badges.frapsoft.com/os/v1/open-source.svg?v=102\"\u003e\n  \u003c/a\u003e\n\n  \u003ca href=\"https://github.com/lpmatos/gitlab-analytics/graphs/contributors\"\u003e\n    \u003cimg alt=\"GitHub Contributors\" src=\"https://img.shields.io/github/contributors/lpmatos/gitlab-analytics\"\u003e\n  \u003c/a\u003e\n\n  \u003ca href=\"https://github.com/lpmatos/gitlab-analytics\"\u003e\n    \u003cimg alt=\"GitHub Language Count\" src=\"https://img.shields.io/github/languages/count/lpmatos/gitlab-analytics\"\u003e\n  \u003c/a\u003e\n\n  \u003ca href=\"https://github.com/lpmatos/gitlab-analytics\"\u003e\n    \u003cimg alt=\"GitHub Top Language\" src=\"https://img.shields.io/github/languages/top/lpmatos/gitlab-analytics\"\u003e\n  \u003c/a\u003e\n\n  \u003ca href=\"https://github.com/lpmatos/gitlab-analytics/stargazers\"\u003e\n    \u003cimg alt=\"GitHub Stars\" src=\"https://img.shields.io/github/stars/lpmatos/gitlab-analytics?style=social\"\u003e\n  \u003c/a\u003e\n\n  \u003ca href=\"https://github.com/lpmatos/gitlab-analytics/commits/master\"\u003e\n    \u003cimg alt=\"GitHub Last Commit\" src=\"https://img.shields.io/github/last-commit/lpmatos/gitlab-analytics\"\u003e\n  \u003c/a\u003e\n\n  \u003ca href=\"https://github.com/lpmatos/gitlab-analytics\"\u003e\n    \u003cimg alt=\"Repository Size\" src=\"https://img.shields.io/github/repo-size/lpmatos/gitlab-analytics\"\u003e\n  \u003c/a\u003e\n\n  \u003ca href=\"https://github.com/lpmatos/gitlab-analytics/issues\"\u003e\n    \u003cimg alt=\"Repository Issues\" src=\"https://img.shields.io/github/issues/lpmatos/gitlab-analytics\"\u003e\n  \u003c/a\u003e\n\n  \u003ca href=\"https://github.com/lpmatos/gitlab-analytics/blob/master/LICENSE\"\u003e\n    \u003cimg alt=\"MIT License\" src=\"https://img.shields.io/github/license/lpmatos/gitlab-analytics\"\u003e\n  \u003c/a\u003e\n\u003c/p\u003e\n\n### Menu\n\n\u003cp align=\"left\"\u003e\n  \u003ca href=\"#pre-requisites\"\u003ePre-Requisites\u003c/a\u003e\u0026nbsp;\u0026nbsp;\u0026nbsp;|\u0026nbsp;\u0026nbsp;\u0026nbsp;\n  \u003ca href=\"#about\"\u003eAbout\u003c/a\u003e\u0026nbsp;\u0026nbsp;\u0026nbsp;|\u0026nbsp;\u0026nbsp;\u0026nbsp;\n  \u003ca href=\"#description\"\u003eDescription\u003c/a\u003e\u0026nbsp;\u0026nbsp;\u0026nbsp;|\u0026nbsp;\u0026nbsp;\u0026nbsp;\n  \u003ca href=\"#testing\"\u003eTesting\u003c/a\u003e\u0026nbsp;\u0026nbsp;\u0026nbsp;|\u0026nbsp;\u0026nbsp;\u0026nbsp;\n  \u003ca href=\"#how-to-contribute\"\u003eHow to contribute\u003c/a\u003e\n\u003c/p\u003e\n\n### By me a coffe\n\nPull requests are welcome. If you'd like to support the work and buy me a ☕, I greatly appreciate it!\n\n\u003ca href=\"https://www.buymeacoffee.com/EatdMck\" target=\"_blank\"\u003e\u003cimg src=\"https://www.buymeacoffee.com/assets/img/custom_images/orange_img.png\" alt=\"Buy Me A Coffee\" style=\"height: 41px !important;width: 100px !important;box-shadow: 0px 3px 2px 0px rgba(190, 190, 190, 0.5) !important;-webkit-box-shadow: 0px 3px 2px 0px rgba(190, 190, 190, 0.5) !important;\" \u003e\u003c/a\u003e\n\n### Getting Started\n\nTo use this repository you need a **git clone**:\n\n```bash\ngit clone --depth 1 https://github.com/lpmatos/gitlab-analytics.git -b master\n```\n\nThis will give access of the project on your local machine.\n\n### Pre Requisites\n\nTo this project you yeed:\n\n* Python 3.8.\n* Docker and Docker Compose.\n* GitLab Server.\n\n### Built with\n\n- [Python](https://www.python.org/)\n- [Docker](https://docs.docker.com/)\n- [Docker Compose](https://docs.docker.com/compose/)\n\n### How to use it?\n\n1. Set the gitlab environment variables.\n2. Install python packages in requirements.txt.\n2. Run this script with docker-compose, Dockerfile or into your local machine with Python command.\n3. Profit.\n\nPress CTRL + C to stop it in Docker Compose or Dockerfile.\n\n### Description\n\nIn this project we build a simples CLI application that help you to get some information in your GitLab API.\n\n### Running pip\n\nThe **pip** is a command line program. When you install **pip**, a **pip** command is added to your system, which can be run from the command prompt as follows:\n\n```bash\n$ pip \u003cpip arguments\u003e\n```\n\nIf you cannot run the pip command directly (possibly because the location where it was installed isn't on your operating systems **PATH**) then you can run **pip** via the **Python** interpreter:\n\n```bash\n$ python -m pip \u003cpip arguments\u003e\n```\n\nOn **Windows**, the py launcher can be used:\n\n```bash\n$ py -m pip \u003cpip arguments\u003e\n```\n\n### Installing Packages\n\n#### Pip\n\nThe **pip** supports installing from **PyPI**, version control, local projects, and directly from distribution files.\n\nThe most common scenario is to install from **PyPI** using Requirement specifiers.\n\n```bash\n$ pip install SomePackage            # latest version\n$ pip install SomePackage==1.0.4     # specific version\n$ pip install somePackage\u003e=1.0.4     # minimum version\n```\n\n#### Pipenv\n\n**Pipenv** is a tool that aims to bring the best of all packaging worlds (bundler, composer, npm, cargo, yarn, etc.) to the **Python** world. **Windows** is a firsts-class citizen, in our world.\n\nIt automatically creates and manages a **virtualenv** for your projects, as well as adds/removes packages from your **Pipfile** as you install/uninstall packages. It also generates the ever-important **Pipfile.lock**, which is used to produce deterministic builds.\n\n##### Installation\n\n```bash\n$ pip install pipenv\n```\n\n##### Create a TOML Spec Pipfile\n\nYou can build the **Pipfile** to specifying:\n\n* Versions of a Package.\n* Versions of **Python**.\n* Basic configurations.\n\n##### Pipenv Workflow\n\nClone/create project repository:\n\n```bash\n$ cd myproject\n```\n\nInstall from **Pipfile**, if there is one:\n\n```bash\n$ pipenv install\n```\n\nInstall from **Pipfile** dev:\n\n```bash\n$ pipenv install --dev\n```\n\n### Requirement File\n\n**Requirement File** are files containing a list of items to be installed using **pip** install like so:\n\n```bash\n$ pip install -r requirements.txt\n```\n\nLogically, a **Requirement File** is just a list of **pip** install arguments placed in a file. Note that you should not rely on the items in the file being installed by **pip** in any particular order.\n\n### Environment variables\n\n**Name**  |  **Description**\n:---:  |  :---:\n**GITLAB_URL**  |  Just your GitLab Server Host\n**GITLAB_TOKEN**  |  Just your GitLab Token\n**LOG_PATH**  |  Just the Log Path\n**LOG_FILE**  |  Just the Log File\n**LOG_LEVEL**  |  Just the Log Level\n**LOGGER_NAME**  |  Just the Logger name\n\n### 🐋 Development with Docker\n\nSteps to build the Docker Image.\n\n#### Build\n\n```bash\ndocker image build -t \u003cIMAGE_NAME\u003e -f \u003cPATH_DOCKERFILE\u003e \u003cPATH_CONTEXT_DOCKERFILE\u003e\ndocker image build -t \u003cIMAGE_NAME\u003e . (This context)\n```\n\n#### Run\n\nSteps to run the Docker Container.\n\n* **Linux** running:\n\n```bash\ndocker container run -d -p \u003cLOCAL_PORT:CONTAINER_PORT\u003e \u003cIMAGE_NAME\u003e \u003cCOMMAND\u003e\ndocker container run -it --rm --name \u003cCONTAINER_NAME\u003e -p \u003cLOCAL_PORT:CONTAINER_PORT\u003e \u003cIMAGE_NAME\u003e \u003cCOMMAND\u003e\n```\n\n* **Windows** running:\n\n```\nwinpty docker.exe container run -it --rm \u003cIMAGE_NAME\u003e \u003cCOMMAND\u003e\n```\n\nFor more information, access the [Docker](https://docs.docker.com/) documentation or [this](docs/annotations/docker.md).\n\n### 🐋 Development with Docker Compose\n\nBuild and run a docker-compose.\n\n```bash\ndocker-compose up --build\n```\n\nDown all services deployed by docker-compose.\n\n```bash\ndocker-compose down\n```\n\nDown all services and delete all images.\n\n```bash\ndocker-compose down --rmi all\n```\n\n## Usage\n\n\u003ckbd\u003epython ./main.py --help\u003c/kbd\u003e - Helper\n\n## Params\n\n![Alt text](docs/images/USAGE.PNG?raw=true \"Usage\")\n\n## ➤ Author \u003ca name = \"author\"\u003e\u003c/a\u003e\n\n👤 Hey!! If you like this project or if you find some bugs feel free to contact me in my channels:\n\n\u003e\n\u003e * Linktree: https://linktr.ee/lpmatos\n\u003e\n\n## ➤ Versioning \u003ca name = \"versioning\"\u003e\u003c/a\u003e\n\nTo check the change history, please access the [**CHANGELOG.md**](CHANGELOG.md) file.\n\n## ➤ Project status \u003ca name = \"project-status\"\u003e\u003c/a\u003e\n\nThis repository is a study project, therefore, it will not always be maintained 👻.\n\n## ➤ Donations \u003ca name = \"donations\"\u003e\u003c/a\u003e\n\n\u003cp align=\"center\"\u003e\n  \u003ca href=\"https://www.blockchain.com/pt/btc/address/bc1qn50elv826qs2qd6xhfh6n79649epqyaqmtwky5\"\u003e\n    \u003cimg alt=\"BTC Address\" src=\"https://img.shields.io/badge/BTC%20Address-black?style=for-the-badge\u0026logo=bitcoin\u0026logoColor=white\"\u003e\n  \u003c/a\u003e\n\n  \u003ca href=\"https://live.blockcypher.com/ltc/address/ltc1qwzrxmlmzzx68k2dnrcrplc4thadm75khzrznjw/\"\u003e\n    \u003cimg alt=\"Litecoin Address\" src=\"https://img.shields.io/badge/Litecoin%20Address-black?style=for-the-badge\u0026logo=litecoin\u0026logoColor=white\"\u003e\n  \u003c/a\u003e\n\u003c/p\u003e\n\n## ➤ Show your support \u003ca name = \"show-your-support\"\u003e\u003c/a\u003e\n\n\u003cdiv align=\"center\"\u003e\n\nGive me a ⭐️ if this project helped you!\n\n\u003cp\u003e\n  \u003cimg alt=\"gif-header\" src=\"https://www.icegif.com/wp-content/uploads/baby-yoda-bye-bye-icegif.gif\" width=\"350px\" float=\"center\"/\u003e\n\u003c/p\u003e\n\nMade with 💜 by [me](https://github.com/lpmatos) 👋 inspired on [readme-md-generator](https://github.com/kefranabg/readme-md-generator)\n\n\u003c/div\u003e\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Flpsm-dev%2Fgitlab-analytics","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Flpsm-dev%2Fgitlab-analytics","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Flpsm-dev%2Fgitlab-analytics/lists"}