From c8ebd7e1e65d27842f4f2f61bcd158af5c40ae36 Mon Sep 17 00:00:00 2001 From: Langenfeld Date: Tue, 12 Jan 2021 10:37:18 +0100 Subject: [PATCH] installation in readme --- README.md | 16 +++++++++++----- 1 file changed, 11 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index e8a5cc6..e935da4 100644 --- a/README.md +++ b/README.md @@ -1,12 +1,12 @@ # py-gitea -A very simple API client for Gitea version 1.9.0. +A very simple API client for Gitea version 1.13.x. -This has been somewhat tested (and used!), so most things should work as expected. +This has been somewhat tested (and used), so most things should work as expected. -Note that not the full Swagger-API is accessible. The implemented part is -focused on Organization/Team/Repository/User-creation, also putting users in -Teams in Organizations and adding Repositories to Teams. +Note that not the full Swagger-API is accessible. The whole implementation is focused +on making access and working with Organizations, Teams, Repositories and Users as pain +free as possible. Originally forked from https://github.com/m301/py-gitea. @@ -15,6 +15,8 @@ Originally forked from https://github.com/m301/py-gitea. First get a `gitea` object wrapping access and authentication (via an api token) for your gitea instance: ```python +from gitea import * + gitea = Gitea(URL, TOKEN) ``` @@ -67,6 +69,10 @@ for team in teams: ``` +## Installation + +Use ``pip install py-gitea`` to install. + ## Tests Tests can be run with: