Skip to main content

python-gitea

Python CI pre-commit.ci status Documentation Status codecov PyPI Version Python Versions License: MIT Security: bandit DOI SPEC 0 — Minimum Supported Dependencies

A Python package for interacting with the Gitea API. It provides a simple, intuitive interface to access Gitea repositories, users, organizations, issues, and more, enabling seamless integration with Gitea instances for automation, data retrieval, and management tasks.

Features

  • Full API Coverage: Repositories, users, organizations, issues, pull requests, comments, labels, milestones, notifications, projects, and Actions workflows, runs, and job logs.
  • Easy Authentication: Token-based authentication, with multiple saved accounts and a default-account fallback.
  • Asynchronous Support: Built with async/await for non-blocking operations alongside the synchronous client.
  • Type Hints: Full type annotations for better IDE support and code reliability.
  • Command-Line Interface: Interact with the Gitea API directly from the terminal for quick, scriptable operations without writing code.
  • Comprehensive Documentation: Detailed guides and a generated API reference.

Quick Start

1. Install

uv venv --python 3.13
source .venv/bin/activate  # On Windows: .venv\Scripts\activate
uv pip install python-gitea

2. Configure an account

gitea-cli config add --name my_account --token YOUR_API_TOKEN --base-url https://gitea.example.com

3. Use the CLI

# List issues of a repository
gitea-cli issue list --owner my-org --repository my-repo

# Get a user
gitea-cli user get --username my-org

4. Use the Python API

from gitea.client.gitea import Gitea

with Gitea(token="YOUR_API_TOKEN", base_url="https://gitea.example.com") as client:
    issues, _ = client.issue.list_issues(owner="my-org", repository="my-repo")

For details, see the Quick Start, Configuration, and Python API guides in the documentation.

Installation

We recommend using uv to manage virtual environments for installing python-gitea.

If you don't have uv installed, you can install it with pip. See the project pages for more details:

  • Install via pip: pip install --upgrade pip && pip install uv
  • Project pages: uv on PyPI | uv on GitHub
  • Full documentation and usage guide: uv docs

Requirements

  • Python 3.13 or higher
  • Operating System: Linux, macOS, or Windows

Install from PyPI

The recommended way to install python-gitea is from PyPI:

# Create a virtual environment (recommended with uv)
uv venv --python 3.13
source .venv/bin/activate  # On Windows: .venv\Scripts\activate
uv pip install python-gitea

Optional Dependencies

For development or specific features:

# Development dependencies (testing, linting, etc.)
uv pip install python-gitea[dev]

# Documentation dependencies
uv pip install python-gitea[docs]

# All dependencies
uv pip install python-gitea[dev,docs]

Install from Source

For the latest development version:

git clone git@github.com:isaac-cf-wong/python-gitea.git
cd python-gitea
# Create a virtual environment (recommended with uv)
uv venv --python 3.13
source .venv/bin/activate  # On Windows: .venv\Scripts\activate
uv pip install .

Development Installation

To set up for development:

git clone git@github.com:isaac-cf-wong/python-gitea.git
cd python-gitea

# Create a virtual environment (recommended with uv)
uv venv --python 3.13
source .venv/bin/activate  # On Windows: .venv\Scripts\activate
uv sync --group dev

# Install pre-commit hooks
uv run prek install

Verify Installation

Check that python-gitea is installed correctly:

gitea-cli --help
python -c "import gitea; print(gitea.__version__)"

Documentation

Full documentation is available at https://isaac-cf-wong.github.io/python-gitea.

Contributing

Contributions are welcome! Please read the Contributing Guide before opening a pull request.

Testing

Run the test suite:

uv run pytest

License

This project is licensed under the MIT License - see the LICENSE file for details.

Support

For questions, issues, or contributions, please:

Changelog

See Release Notes for version history.

Metadata

Release files for python-gitea 0.14.0

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for python-gitea 0.14.0
File Size Uploaded Provenance Actions
python_gitea-0.14.0.tar.gz 521.8 kB Without provenance Details for python_gitea-0.14.0.tar.gz

Built distribution (wheel)

Table of built distributions (wheels) for python-gitea 0.14.0
File Interpreter ABI Platform Actions
python_gitea-0.14.0-py3-none-any.whl Python 3 none any Details for python_gitea-0.14.0-py3-none-any.whl

Total release size: 808.9 kB

Release files / python_gitea-0.14.0.tar.gz

Download URL python_gitea-0.14.0.tar.gz
Size 521.8 kB
Tags Source
SHA-256 checksum
How to use checksums
828bdd7c6f48d05c9adb7850c22bc08f5ca3027ca1f314ad43f35a282f145a38
BLAKE2b-256 checksum
How to use checksums
4053ebbac3fddd55d4978953b5aade56fbe9715a4a9d11dbc9d7572ae32bc5fa
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via uv/0.13.7 {"installer":{"name":"uv","version":"0.13.7","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"26.04","id":"resolute","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":true}

Release files / python_gitea-0.14.0-py3-none-any.whl

Download URL python_gitea-0.14.0-py3-none-any.whl
Size 287.1 kB
Tags Python 3
SHA-256 checksum
How to use checksums
574cbf9bf0a66928f5fa9e89213c6ab333250c4942cb01462aeb4378f0c583a8
BLAKE2b-256 checksum
How to use checksums
cf03befb6c00a4b842e14b6b2509531a31dd7c7be1381861b0e354a537448452
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via uv/0.13.7 {"installer":{"name":"uv","version":"0.13.7","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"26.04","id":"resolute","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":true}

Security for python-gitea 0.14.0

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

No provenance found

None of the files in this release were uploaded with provenance metadata.

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.

Release history Release notifications | RSS feed

This release

0.14.0 This release

2 release files No provenance

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page