https://github.com/vchrombie/gareth
Tool to manage the developer installation of GrimoireLab
https://github.com/vchrombie/gareth
automation chaoss grimoirelab
Last synced: about 1 month ago
JSON representation
Tool to manage the developer installation of GrimoireLab
- Host: GitHub
- URL: https://github.com/vchrombie/gareth
- Owner: vchrombie
- License: gpl-3.0
- Created: 2021-02-27T05:31:47.000Z (about 4 years ago)
- Default Branch: master
- Last Pushed: 2021-07-10T16:41:31.000Z (almost 4 years ago)
- Last Synced: 2025-03-14T09:05:38.239Z (2 months ago)
- Topics: automation, chaoss, grimoirelab
- Language: Python
- Homepage: https://pypi.org/project/gareth/
- Size: 39.1 KB
- Stars: 2
- Watchers: 1
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# gareth
Tool to manage the developer installation of GrimoireLab.
This software is licensed under GPL3 or later.
## Requirements
* Python >= 3.6
* Poetry >= 1.0
* Click >= 7.1.2
* PyGithub >= 1.55
* GitPython >= 3.1.15
## Installation
### Getting the source code
Clone the repository
```
$ git clone https://github.com/vchrombie/gareth/
$ cd gareth
```
### Prerequisites
#### Poetry
We use [Poetry](https://python-poetry.org/docs/) for managing the project.
You can install it following [these steps](https://python-poetry.org/docs/#installation).
We use [Bitergia/release-tools](https://github.com/Bitergia/release-tools) for managing
the releases.
### Installation
Install the required dependencies (this will also create a virtual environment)
```
$ poetry install
```
Activate the virtual environment
```
$ poetry shell
```
## Usage
Once you install the tool, you can use it with the `gareth` command.
```
$ gareth --help
Usage: gareth [OPTIONS]
Tool to manage the developer installation of GrimoireLab.
Options:
-t, --token TEXT GitHub API Token.
-s, --source TEXT The source folder of the dev env. [default: sources]
--create Create the developer setup.
--update Update the developer setup.
--help Show this message and exit.
```
Create the developer environment setup
```
$ gareth -t xxxx -s sources --create
```
Update the developer environment setup
```
$ gareth -s sources --update
```
## Contributions
All the contributions are welcome. Please feel free to open an issue or a PR.
If you are opening any PR for the code, please be sure to add a
[changelog](https://github.com/Bitergia/release-tools#changelog) entry.
## License
Licensed under GNU General Public License (GPL), version 3 or later.