https://github.com/gerijacki/github_api_manager
Aplicació per administrar totes les interaccións de git de manera automatitzada i personalitzada per terminal
https://github.com/gerijacki/github_api_manager
api github github-api python3 scripts
Last synced: 4 days ago
JSON representation
Aplicació per administrar totes les interaccións de git de manera automatitzada i personalitzada per terminal
- Host: GitHub
- URL: https://github.com/gerijacki/github_api_manager
- Owner: Gerijacki
- License: mit
- Created: 2025-01-31T15:45:32.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2025-02-24T16:36:53.000Z (about 1 year ago)
- Last Synced: 2025-10-20T10:33:36.682Z (7 months ago)
- Topics: api, github, github-api, python3, scripts
- Language: Python
- Homepage:
- Size: 85.9 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Contributing: .github/CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
README
# GitHub Api Manager
Una aplicació per gestionar GitHub des de la línia de comandaments. Aquesta aplicació et permet interactuar amb diversos aspectes de GitHub, com gestionar repositoris, organitzacions, membres, etc., directament des del terminal via l'api oficial de github.
## Setup
Per començar a utilitzar l'aplicació, primer cal generar un `.env`. Això ho podem fer duplicant el `.env-example` i afegint el nostre token corresponent de github. [Documentació oficial](https://docs.github.com/en/rest/authentication/authenticating-to-the-rest-api?apiVersion=2022-11-28)
## Instal·lació
Ara cal instal·lar les dependències necessàries. Pots fer-ho amb el següent comandament:
```bash
pip install -r requirements.txt
```
## Execució
Per executar l'aplicació, simplement crida el fitxer principal (`app.py`) des del terminal:
```bash
python app.py
```
Això iniciarà la interfície de línia de comandaments on podràs interactuar amb les funcionalitats de l'aplicació.
## Docker
També pots executar l'aplicació utilitzant Docker. Primer, assegura't de tenir Docker i Docker Compose instal·lats.
Construir la imatge Docker
```bash
docker-compose build
```
Executar l'aplicació amb Docker
```bash
docker-compose up
```
Això iniciarà l'aplicació dins d'un contenidor Docker.
## Tests
Per assegurar-te que l'aplicació funciona correctament, pots executar els tests unitats. Per a això, utilitzem la biblioteca `unittest`. Per executar-los, utilitza el següent comandament:
```bash
python -m unittest discover src/tests
```
Aquest comandament descobrirà i executarà tots els tests definits en el directori `src/tests` de l'aplicació.
## Documentació de l'API utilitzada
L'aplicació fa servir l'API de **GitHub REST** per realitzar diverses operacions. [Documentació oficial](https://docs.github.com/en/rest)
---