patrickbucher / gitea-api

Scripts for the Gitea API, useful for classrooms.

Gitea API

Some Python (3.10) scripts to access the Gitea API, using the click and requests libraries.

Setup

Create a virtual environment, and activate it:

$ python -m venv env
$ . env/bin/activate

Install the dependencies:

$ pip install -r requirements.txt

Generate a token for your Gitea profile and store it under .token, or create a new one:

$ ./gitea.py new-token --username patrick --password [prompted if missing]

Show help:

$ ./gitea.py --help

Bulk Registration

Create a YAML file for bulk registration (bulk-registration.yaml):

teams:
  - teamname: alligators
    description: Team Alligators
    users:
      - username: rudi_loehlein
        fullname: Rudi Löhlein
        email: [e-mail]
      - username: mai_ling
        fullname: Mai Ling
        email: [e-mail]
  - teamname: badgers
    description: Team Badgers
    users:
      - username: john_doe
        fullname: John Doe
        email: [e-mail]
      - username: jane_done
        fullname: Jane Done
        email: [e-mail]

Using the bulk-register command, and a given organization name (--org):

$ ./gitea.py bulk-register --org demo --bulkfile bulk-registrations.yaml

The following steps are performed:

1. Each listed team is created with the given parameters, and added to the given organization.
2. Each listed user is created with the given parameters, and added to the team.

So a user belongs to exactly one team.

TODO

• email preferences for new users: use "only on mention", if possible