Skip to main content
Join the official 2019 Python Developers SurveyStart the survey!

Python SDK for Gitea - A painless, self-hosted Git service

Project description

Gitea Python SDK

This documentation describes the Gitea API.

This Python package is automatically generated by the Swagger Codegen project:

  • API version: 1.1.1
  • Package version: 1.0.0
  • Build package: io.swagger.codegen.languages.PythonClientCodegen

Requirements.

Python 2.7 and 3.4+

Installation & Usage

pip install

If the python package is hosted on Github, you can install directly from Github

pip install git+https://github.com/dblueai/giteapy.git

(you may need to run pip with root permission: sudo pip install git+https://github.com/dblueai/giteapy.git)

Then import the package:

import giteapy

Setuptools

Install via Setuptools.

python setup.py install --user

(or sudo python setup.py install to install the package for all users)

Then import the package:

import giteapy

Getting Started

Please follow the installation procedure and then run the following:

from __future__ import print_function
import time
import giteapy
from giteapy.rest import ApiException
from pprint import pprint

# Configure API key authorization: AccessToken
configuration = giteapy.Configuration()
configuration.api_key['access_token'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['access_token'] = 'Bearer'
# Configure API key authorization: AuthorizationHeaderToken
configuration = giteapy.Configuration()
configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['Authorization'] = 'Bearer'
# Configure HTTP basic authorization: BasicAuth
configuration = giteapy.Configuration()
configuration.username = 'YOUR_USERNAME'
configuration.password = 'YOUR_PASSWORD'
# Configure API key authorization: SudoHeader
configuration = giteapy.Configuration()
configuration.api_key['Sudo'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['Sudo'] = 'Bearer'
# Configure API key authorization: SudoParam
configuration = giteapy.Configuration()
configuration.api_key['sudo'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['sudo'] = 'Bearer'
# Configure API key authorization: Token
configuration = giteapy.Configuration()
configuration.api_key['token'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['token'] = 'Bearer'

# create an instance of the API class
api_instance = giteapy.AdminApi(giteapy.ApiClient(configuration))
username = 'username_example' # str | username of the user that will own the created organization
organization = giteapy.CreateOrgOption() # CreateOrgOption |

try:
    # Create an organization
    api_response = api_instance.admin_create_org(username, organization)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling AdminApi->admin_create_org: %s\n" % e)

Documentation for API Endpoints

All URIs are relative to http://localhost:3000/api/v1

Class Method HTTP request Description
AdminApi admin_create_org POST /admin/users/{username}/orgs Create an organization
AdminApi admin_create_public_key POST /admin/users/{username}/keys Add a public key on behalf of a user
AdminApi admin_create_repo POST /admin/users/{username}/repos Create a repository on behalf a user
AdminApi admin_create_user POST /admin/users Create a user
AdminApi admin_delete_user DELETE /admin/users/{username} Delete a user
AdminApi admin_delete_user_public_key DELETE /admin/users/{username}/keys/{id} Delete a user's public key
AdminApi admin_edit_user PATCH /admin/users/{username} Edit an existing user
AdminApi admin_get_all_orgs GET /admin/orgs List all organizations
AdminApi admin_get_all_users GET /admin/users List all users
IssueApi issue_add_label POST /repos/{owner}/{repo}/issues/{index}/labels Add a label to an issue
IssueApi issue_add_time POST /repos/{owner}/{repo}/issues/{id}/times Add a tracked time to a issue
IssueApi issue_clear_labels DELETE /repos/{owner}/{repo}/issues/{index}/labels Remove all labels from an issue
IssueApi issue_create_comment POST /repos/{owner}/{repo}/issues/{index}/comments Add a comment to an issue
IssueApi issue_create_issue POST /repos/{owner}/{repo}/issues Create an issue. If using deadline only the date will be taken into account, and time of day ignored.
IssueApi issue_create_label POST /repos/{owner}/{repo}/labels Create a label
IssueApi issue_create_milestone POST /repos/{owner}/{repo}/milestones Create a milestone
IssueApi issue_delete_comment DELETE /repos/{owner}/{repo}/issues/comments/{id} Delete a comment
IssueApi issue_delete_comment_deprecated DELETE /repos/{owner}/{repo}/issues/{index}/comments/{id} Delete a comment
IssueApi issue_delete_label DELETE /repos/{owner}/{repo}/labels/{id} Delete a label
IssueApi issue_delete_milestone DELETE /repos/{owner}/{repo}/milestones/{id} Delete a milestone
IssueApi issue_edit_comment PATCH /repos/{owner}/{repo}/issues/comments/{id} Edit a comment
IssueApi issue_edit_comment_deprecated PATCH /repos/{owner}/{repo}/issues/{index}/comments/{id} Edit a comment
IssueApi issue_edit_issue PATCH /repos/{owner}/{repo}/issues/{index} Edit an issue. If using deadline only the date will be taken into account, and time of day ignored.
IssueApi issue_edit_issue_deadline POST /repos/{owner}/{repo}/issues/{index}/deadline Set an issue deadline. If set to null, the deadline is deleted. If using deadline only the date will be taken into account, and time of day ignored.
IssueApi issue_edit_label PATCH /repos/{owner}/{repo}/labels/{id} Update a label
IssueApi issue_edit_milestone PATCH /repos/{owner}/{repo}/milestones/{id} Update a milestone
IssueApi issue_get_comments GET /repos/{owner}/{repo}/issues/{index}/comments List all comments on an issue
IssueApi issue_get_issue GET /repos/{owner}/{repo}/issues/{index} Get an issue
IssueApi issue_get_label GET /repos/{owner}/{repo}/labels/{id} Get a single label
IssueApi issue_get_labels GET /repos/{owner}/{repo}/issues/{index}/labels Get an issue's labels
IssueApi issue_get_milestone GET /repos/{owner}/{repo}/milestones/{id} Get a milestone
IssueApi issue_get_milestones_list GET /repos/{owner}/{repo}/milestones Get all of a repository's opened milestones
IssueApi issue_get_repo_comments GET /repos/{owner}/{repo}/issues/comments List all comments in a repository
IssueApi issue_list_issues GET /repos/{owner}/{repo}/issues List a repository's issues
IssueApi issue_list_labels GET /repos/{owner}/{repo}/labels Get all of a repository's labels
IssueApi issue_remove_label DELETE /repos/{owner}/{repo}/issues/{index}/labels/{id} Remove a label from an issue
IssueApi issue_replace_labels PUT /repos/{owner}/{repo}/issues/{index}/labels Replace an issue's labels
IssueApi issue_start_stop_watch POST /repos/{owner}/{repo}/issues/{index}/stopwatch/start Start stopwatch on an issue.
IssueApi issue_stop_watch POST /repos/{owner}/{repo}/issues/{index}/stopwatch/stop Stop an issue's existing stopwatch.
IssueApi issue_tracked_times GET /repos/{owner}/{repo}/issues/{id}/times List an issue's tracked times
MiscellaneousApi get_signing_key GET /signing-key.gpg Get default signing-key.gpg
MiscellaneousApi get_version GET /version Returns the version of the Gitea application
MiscellaneousApi render_markdown POST /markdown Render a markdown document as HTML
MiscellaneousApi render_markdown_raw POST /markdown/raw Render raw markdown as HTML
OrganizationApi create_org_repo POST /org/{org}/repos Create a repository in an organization
OrganizationApi org_add_team_member PUT /teams/{id}/members/{username} Add a team member
OrganizationApi org_add_team_repository PUT /teams/{id}/repos/{org}/{repo} Add a repository to a team
OrganizationApi org_conceal_member DELETE /orgs/{org}/public_members/{username} Conceal a user's membership
OrganizationApi org_create POST /orgs Create an organization
OrganizationApi org_create_hook POST /orgs/{org}/hooks/ Create a hook
OrganizationApi org_create_team POST /orgs/{org}/teams Create a team
OrganizationApi org_delete DELETE /orgs/{org} Delete an organization
OrganizationApi org_delete_hook DELETE /orgs/{org}/hooks/{id} Delete a hook
OrganizationApi org_delete_member DELETE /orgs/{org}/members/{username} Remove a member from an organization
OrganizationApi org_delete_team DELETE /teams/{id} Delete a team
OrganizationApi org_edit PATCH /orgs/{org} Edit an organization
OrganizationApi org_edit_hook PATCH /orgs/{org}/hooks/{id} Update a hook
OrganizationApi org_edit_team PATCH /teams/{id} Edit a team
OrganizationApi org_get GET /orgs/{org} Get an organization
OrganizationApi org_get_hook GET /orgs/{org}/hooks/{id} Get a hook
OrganizationApi org_get_team GET /teams/{id} Get a team
OrganizationApi org_is_member GET /orgs/{org}/members/{username} Check if a user is a member of an organization
OrganizationApi org_is_public_member GET /orgs/{org}/public_members/{username} Check if a user is a public member of an organization
OrganizationApi org_list_current_user_orgs GET /user/orgs List the current user's organizations
OrganizationApi org_list_hooks GET /orgs/{org}/hooks List an organization's webhooks
OrganizationApi org_list_members GET /orgs/{org}/members List an organization's members
OrganizationApi org_list_public_members GET /orgs/{org}/public_members List an organization's public members
OrganizationApi org_list_repos GET /orgs/{org}/repos List an organization's repos
OrganizationApi org_list_team_member GET /teams/{id}/members/{username} List a particular member of team
OrganizationApi org_list_team_members GET /teams/{id}/members List a team's members
OrganizationApi org_list_team_repos GET /teams/{id}/repos List a team's repos
OrganizationApi org_list_teams GET /orgs/{org}/teams List an organization's teams
OrganizationApi org_list_user_orgs GET /users/{username}/orgs List a user's organizations
OrganizationApi org_publicize_member PUT /orgs/{org}/public_members/{username} Publicize a user's membership
OrganizationApi org_remove_team_member DELETE /teams/{id}/members/{username} Remove a team member
OrganizationApi org_remove_team_repository DELETE /teams/{id}/repos/{org}/{repo} Remove a repository from a team
OrganizationApi team_search GET /orgs/{org}/teams/search Search for teams within an organization
RepositoryApi create_current_user_repo POST /user/repos Create a repository
RepositoryApi create_fork POST /repos/{owner}/{repo}/forks Fork a repository
RepositoryApi get_blob GET /repos/{owner}/{repo}/git/blobs/{sha} Gets the blob of a repository.
RepositoryApi get_tag GET /repos/{owner}/{repo}/git/tags/{sha} Gets the tag object of an annotated tag (not lightweight tags)
RepositoryApi get_tree GET /repos/{owner}/{repo}/git/trees/{sha} Gets the tree of a repository.
RepositoryApi list_forks GET /repos/{owner}/{repo}/forks List a repository's forks
RepositoryApi repo_add_collaborator PUT /repos/{owner}/{repo}/collaborators/{collaborator} Add a collaborator to a repository
RepositoryApi repo_add_topc PUT /repos/{owner}/{repo}/topics/{topic} Add a topic to a repository
RepositoryApi repo_check_collaborator GET /repos/{owner}/{repo}/collaborators/{collaborator} Check if a user is a collaborator of a repository
RepositoryApi repo_create_file POST /repos/{owner}/{repo}/contents/{filepath} Create a file in a repository
RepositoryApi repo_create_hook POST /repos/{owner}/{repo}/hooks Create a hook
RepositoryApi repo_create_key POST /repos/{owner}/{repo}/keys Add a key to a repository
RepositoryApi repo_create_pull_request POST /repos/{owner}/{repo}/pulls Create a pull request
RepositoryApi repo_create_release POST /repos/{owner}/{repo}/releases Create a release
RepositoryApi repo_create_release_attachment POST /repos/{owner}/{repo}/releases/{id}/assets Create a release attachment
RepositoryApi repo_create_status POST /repos/{owner}/{repo}/statuses/{sha} Create a commit status
RepositoryApi repo_delete DELETE /repos/{owner}/{repo} Delete a repository
RepositoryApi repo_delete_collaborator DELETE /repos/{owner}/{repo}/collaborators/{collaborator} Delete a collaborator from a repository
RepositoryApi repo_delete_file DELETE /repos/{owner}/{repo}/contents/{filepath} Delete a file in a repository
RepositoryApi repo_delete_git_hook DELETE /repos/{owner}/{repo}/hooks/git/{id} Delete a Git hook in a repository
RepositoryApi repo_delete_hook DELETE /repos/{owner}/{repo}/hooks/{id} Delete a hook in a repository
RepositoryApi repo_delete_key DELETE /repos/{owner}/{repo}/keys/{id} Delete a key from a repository
RepositoryApi repo_delete_release DELETE /repos/{owner}/{repo}/releases/{id} Delete a release
RepositoryApi repo_delete_release_attachment DELETE /repos/{owner}/{repo}/releases/{id}/assets/{attachment_id} Delete a release attachment
RepositoryApi repo_delete_topic DELETE /repos/{owner}/{repo}/topics/{topic} Delete a topic from a repository
RepositoryApi repo_edit PATCH /repos/{owner}/{repo} Edit a repository's properties. Only fields that are set will be changed.
RepositoryApi repo_edit_git_hook PATCH /repos/{owner}/{repo}/hooks/git/{id} Edit a Git hook in a repository
RepositoryApi repo_edit_hook PATCH /repos/{owner}/{repo}/hooks/{id} Edit a hook in a repository
RepositoryApi repo_edit_pull_request PATCH /repos/{owner}/{repo}/pulls/{index} Update a pull request
RepositoryApi repo_edit_release PATCH /repos/{owner}/{repo}/releases/{id} Update a release
RepositoryApi repo_edit_release_attachment PATCH /repos/{owner}/{repo}/releases/{id}/assets/{attachment_id} Edit a release attachment
RepositoryApi repo_get GET /repos/{owner}/{repo} Get a repository
RepositoryApi repo_get_all_commits GET /repos/{owner}/{repo}/commits Get a list of all commits from a repository
RepositoryApi repo_get_archive GET /repos/{owner}/{repo}/archive/{archive} Get an archive of a repository
RepositoryApi repo_get_branch GET /repos/{owner}/{repo}/branches/{branch} Retrieve a specific branch from a repository
RepositoryApi repo_get_by_id GET /repositories/{id} Get a repository by id
RepositoryApi repo_get_combined_status_by_ref GET /repos/{owner}/{repo}/commits/{ref}/statuses Get a commit's combined status, by branch/tag/commit reference
RepositoryApi repo_get_contents GET /repos/{owner}/{repo}/contents/{filepath} Gets the metadata and contents (if a file) of an entry in a repository, or a list of entries if a dir
RepositoryApi repo_get_contents_list GET /repos/{owner}/{repo}/contents Gets the metadata of all the entries of the root dir
RepositoryApi repo_get_editor_config GET /repos/{owner}/{repo}/editorconfig/{filepath} Get the EditorConfig definitions of a file in a repository
RepositoryApi repo_get_git_hook GET /repos/{owner}/{repo}/hooks/git/{id} Get a Git hook
RepositoryApi repo_get_hook GET /repos/{owner}/{repo}/hooks/{id} Get a hook
RepositoryApi repo_get_key GET /repos/{owner}/{repo}/keys/{id} Get a repository's key by id
RepositoryApi repo_get_pull_request GET /repos/{owner}/{repo}/pulls/{index} Get a pull request
RepositoryApi repo_get_raw_file GET /repos/{owner}/{repo}/raw/{filepath} Get a file from a repository
RepositoryApi repo_get_release GET /repos/{owner}/{repo}/releases/{id} Get a release
RepositoryApi repo_get_release_attachment GET /repos/{owner}/{repo}/releases/{id}/assets/{attachment_id} Get a release attachment
RepositoryApi repo_get_single_commit GET /repos/{owner}/{repo}/git/commits/{sha} Get a single commit from a repository
RepositoryApi repo_list_all_git_refs GET /repos/{owner}/{repo}/git/refs Get specified ref or filtered repository's refs
RepositoryApi repo_list_branches GET /repos/{owner}/{repo}/branches List a repository's branches
RepositoryApi repo_list_collaborators GET /repos/{owner}/{repo}/collaborators List a repository's collaborators
RepositoryApi repo_list_git_hooks GET /repos/{owner}/{repo}/hooks/git List the Git hooks in a repository
RepositoryApi repo_list_git_refs GET /repos/{owner}/{repo}/git/refs/{ref} Get specified ref or filtered repository's refs
RepositoryApi repo_list_hooks GET /repos/{owner}/{repo}/hooks List the hooks in a repository
RepositoryApi repo_list_keys GET /repos/{owner}/{repo}/keys List a repository's keys
RepositoryApi repo_list_pull_requests GET /repos/{owner}/{repo}/pulls List a repo's pull requests
RepositoryApi repo_list_release_attachments GET /repos/{owner}/{repo}/releases/{id}/assets List release's attachments
RepositoryApi repo_list_releases GET /repos/{owner}/{repo}/releases List a repo's releases
RepositoryApi repo_list_stargazers GET /repos/{owner}/{repo}/stargazers List a repo's stargazers
RepositoryApi repo_list_statuses GET /repos/{owner}/{repo}/statuses/{sha} Get a commit's statuses
RepositoryApi repo_list_subscribers GET /repos/{owner}/{repo}/subscribers List a repo's watchers
RepositoryApi repo_list_tags GET /repos/{owner}/{repo}/tags List a repository's tags
RepositoryApi repo_list_topics GET /repos/{owner}/{repo}/topics Get list of topics that a repository has
RepositoryApi repo_merge_pull_request POST /repos/{owner}/{repo}/pulls/{index}/merge Merge a pull request
RepositoryApi repo_migrate POST /repos/migrate Migrate a remote git repository
RepositoryApi repo_mirror_sync POST /repos/{owner}/{repo}/mirror-sync Sync a mirrored repository
RepositoryApi repo_pull_request_is_merged GET /repos/{owner}/{repo}/pulls/{index}/merge Check if a pull request has been merged
RepositoryApi repo_search GET /repos/search Search for repositories
RepositoryApi repo_signing_key GET /repos/{owner}/{repo}/signing-key.gpg Get signing-key.gpg for given repository
RepositoryApi repo_test_hook POST /repos/{owner}/{repo}/hooks/{id}/tests Test a push webhook
RepositoryApi repo_tracked_times GET /repos/{owner}/{repo}/times List a repo's tracked times
RepositoryApi repo_update_file PUT /repos/{owner}/{repo}/contents/{filepath} Update a file in a repository
RepositoryApi repo_update_topics PUT /repos/{owner}/{repo}/topics Replace list of topics for a repository
RepositoryApi topic_search GET /topics/search search topics via keyword
RepositoryApi user_current_check_subscription GET /repos/{owner}/{repo}/subscription Check if the current user is watching a repo
RepositoryApi user_current_delete_subscription DELETE /repos/{owner}/{repo}/subscription Unwatch a repo
RepositoryApi user_current_put_subscription PUT /repos/{owner}/{repo}/subscription Watch a repo
UserApi create_current_user_repo POST /user/repos Create a repository
UserApi user_add_email POST /user/emails Add email addresses
UserApi user_check_following GET /users/{follower}/following/{followee} Check if one user is following another user
UserApi user_create_token POST /users/{username}/tokens Create an access token
UserApi user_current_check_following GET /user/following/{username} Check whether a user is followed by the authenticated user
UserApi user_current_check_starring GET /user/starred/{owner}/{repo} Whether the authenticated is starring the repo
UserApi user_current_delete_follow DELETE /user/following/{username} Unfollow a user
UserApi user_current_delete_gpg_key DELETE /user/gpg_keys/{id} Remove a GPG key
UserApi user_current_delete_key DELETE /user/keys/{id} Delete a public key
UserApi user_current_delete_star DELETE /user/starred/{owner}/{repo} Unstar the given repo
UserApi user_current_get_gpg_key GET /user/gpg_keys/{id} Get a GPG key
UserApi user_current_get_key GET /user/keys/{id} Get a public key
UserApi user_current_list_followers GET /user/followers List the authenticated user's followers
UserApi user_current_list_following GET /user/following List the users that the authenticated user is following
UserApi user_current_list_gpg_keys GET /user/gpg_keys List the authenticated user's GPG keys
UserApi user_current_list_keys GET /user/keys List the authenticated user's public keys
UserApi user_current_list_repos GET /user/repos List the repos that the authenticated user owns or has access to
UserApi user_current_list_starred GET /user/starred The repos that the authenticated user has starred
UserApi user_current_list_subscriptions GET /user/subscriptions List repositories watched by the authenticated user
UserApi user_current_post_gpg_key POST /user/gpg_keys Create a GPG key
UserApi user_current_post_key POST /user/keys Create a public key
UserApi user_current_put_follow PUT /user/following/{username} Follow a user
UserApi user_current_put_star PUT /user/starred/{owner}/{repo} Star the given repo
UserApi user_current_tracked_times GET /user/times List the current user's tracked times
UserApi user_delete_access_token DELETE /users/{username}/tokens/{token} delete an access token
UserApi user_delete_email DELETE /user/emails Delete email addresses
UserApi user_get GET /users/{username} Get a user
UserApi user_get_current GET /user Get the authenticated user
UserApi user_get_heatmap_data GET /users/{username}/heatmap Get a user's heatmap
UserApi user_get_tokens GET /users/{username}/tokens List the authenticated user's access tokens
UserApi user_list_emails GET /user/emails List the authenticated user's email addresses
UserApi user_list_followers GET /users/{username}/followers List the given user's followers
UserApi user_list_following GET /users/{username}/following List the users that the given user is following
UserApi user_list_gpg_keys GET /users/{username}/gpg_keys List the given user's GPG keys
UserApi user_list_keys GET /users/{username}/keys List the given user's public keys
UserApi user_list_repos GET /users/{username}/repos List the repos owned by the given user
UserApi user_list_starred GET /users/{username}/starred The repos that the given user has starred
UserApi user_list_subscriptions GET /users/{username}/subscriptions List the repositories watched by a user
UserApi user_list_teams GET /user/teams List all the teams a user belongs to
UserApi user_search GET /users/search Search for users
UserApi user_tracked_times GET /repos/{owner}/{repo}/times/{user} List a user's tracked times in a repo

Documentation For Models

Documentation For Authorization

AccessToken

  • Type: API key
  • API key parameter name: access_token
  • Location: URL query string

AuthorizationHeaderToken

  • Type: API key
  • API key parameter name: Authorization
  • Location: HTTP header

BasicAuth

  • Type: HTTP basic authentication

SudoHeader

  • Type: API key
  • API key parameter name: Sudo
  • Location: HTTP header

SudoParam

  • Type: API key
  • API key parameter name: sudo
  • Location: URL query string

Token

  • Type: API key
  • API key parameter name: token
  • Location: URL query string

Author

  • Rajesh Hegde

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Files for giteapy, version 1.0.7
Filename, size File type Python version Upload date Hashes
Filename, size giteapy-1.0.7.tar.gz (124.6 kB) File type Source Python version None Upload date Hashes View hashes

Supported by

Elastic Elastic Search Pingdom Pingdom Monitoring Google Google BigQuery Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN SignalFx SignalFx Supporter DigiCert DigiCert EV certificate StatusPage StatusPage Status page