Welcome to appi’s documentation!

Appi is a portage python interface. It is meant to be an alternative to the standard portage module, although, today, it is at a very early stage. It is designed to be straightforward to use, well-documented and have easy to read source code.

• Install appi
  • Installation from portage tree
  • Installation from flora overlay
  • Installation from pypi
  • Installation from git repository
• Get Started
  • Play with atoms
    • Check atom validity
    • Inspect atom parts
    • And much more!
  • Go on with ebuilds
    • Check ebuild validity
    • Inspect ebuild parts
    • And much more
  • Finally, let’s checkout versions
    • Inspect version parts
    • Compare versions

• Reference
  • appi
    • appi.conf
      • appi.conf.Profile
      • appi.conf.Repository
    • appi.exception
      • appi.exception.AppiError
      • appi.exception.AtomError
      • appi.exception.EbuildError
      • appi.exception.PortageError
      • appi.exception.VersionError
    • appi.DependAtom
    • appi.Ebuild
      • Ebuild(path)
      • Attributes
      • String representation
      • get_version() -> appi.Version
      • matches_atom(atom) -> bool
      • is_installed() -> bool
      • is_in_tree() -> bool
    • appi.QueryAtom
      • QueryAtom(atom_string, strict=True)
      • Attributes
      • String Representation
      • get_version() -> appi.Version
      • get_repository() -> appi.conf.Repository
      • list_matching_ebuilds() -> {appi.Ebuild, …}
      • matches_existing_ebuild() -> bool
      • is_installed() -> bool
      • is_in_tree() -> bool
    • appi.Version
      • Version(version_string)
      • Attributes
      • compare(other) -> int
      • startswith(version) -> bool
      • get_upstream_version() -> Version