diff --git a/README.md b/README.md index 6e1223a..f833c7c 100644 --- a/README.md +++ b/README.md @@ -1,9 +1,31 @@ # Gitea.py -Python Wrapper for Gitea API. +Python Wrapper for Gitea API (WIP) -### Dependencies + # Sample usage. -- **Python 3** + from Gitea import Gitea + ''' + gitea = Gitea() + ''' + # It will ask you your Gitea instance url and your access token to it and save the config to config/gitea.txt + + # Current implemented Gitea API endpoints you can call: + + gitea.admin_users_create() + gitea.admin_users_list() + gitea.notifications_new() + gitea.repos_issues_search() + gitea.repos_owner_repo_issues() + gitea.repos_owner_repo_issues_comments() + + Some of above methods will need required params that will be shown to you when running them. In ex.: + + gitea.repos_issues_search() + *** TypeError: repos_issues_search() missing 1 required positional argument: 'owner' + + Just pass the param to the object like this: + + gitea.repos_issues_search("your_gitea_username")