Allura API

This documents the python classes available to Allura tools and extensions.

If you are looking for the web REST API, see Public API Documentation

• allura.app
  • AdminControllerMixin
  • Application
    • Application.AttachmentClass
    • Application.DiscussionClass
    • Application.PostClass
    • Application.acl
    • Application.activity_extras
    • Application.activity_name
    • Application.admin_menu()
    • Application.bulk_export()
    • Application.default_options()
    • Application.default_redirect()
    • Application.describe_permission()
    • Application.doap()
    • Application.email_address
    • Application.handle_artifact_message()
    • Application.handle_message()
    • Application.has_access()
    • Application.has_resource()
    • Application.icon_url()
    • Application.install()
    • Application.installable
    • Application.is_visible_to()
    • Application.main_menu()
    • Application.options_on_install()
    • Application.parent_security_context()
    • Application.sidebar_menu()
    • Application.sidebar_menu_js()
    • Application.sitemap_xml()
    • Application.status_int()
    • Application.subscribe()
    • Application.subscribe_admins()
    • Application.uninstall()
    • Application.uninstallable
    • Application.unsubscribe()
    • Application.validate_mount_point()
  • ConfigOption
    • ConfigOption.default
    • ConfigOption.render_attrs()
  • DefaultAdminController
    • DefaultAdminController.configure()
    • DefaultAdminController.edit_label()
    • DefaultAdminController.index()
    • DefaultAdminController.options()
    • DefaultAdminController.permissions()
    • DefaultAdminController.update()
    • DefaultAdminController.update_label()
  • SitemapEntry
    • SitemapEntry.bind_app()
    • SitemapEntry.extend()
    • SitemapEntry.matches_url()
  • WebhooksLookup
• allura.controllers
  • RestController
    • RestController.index()
  • ProjectAdminRestController
    • ProjectAdminRestController.admin_options()
    • ProjectAdminRestController.export()
    • ProjectAdminRestController.export_status()
    • ProjectAdminRestController.install_tool()
    • ProjectAdminRestController.installable_tools()
• allura.ext
  • allura.ext.personal_dashboard
    • ActivitySection
    • DashboardController
    • DashboardSectionBase
    • MergeRequestsSection
    • ProjectsSection
    • TicketsSection
  • allura.ext.user_profile
    • PersonalDataSection
    • ProfileSectionBase
    • ProjectsSection
    • SkillsSection
    • SocialSection
    • ToolsSection
    • UserProfileApp
    • UserProfileController
• allura.lib
  • allura.lib.decorators
    • event_handler
    • getattr_()
    • memoize()
    • memoize_cleanup()
    • memorable_forget()
    • require_method()
    • require_post
    • task()
  • allura.lib.helpers
    • DateTimeConverter
    • absurl()
    • ago()
    • auditlog_user()
    • config_with_prefix()
    • convert_bools()
    • emojize()
    • encode_keys()
    • exceptionless
    • fixed_attrs_proxy
    • get_current_reaction()
    • get_first()
    • get_tool_packages()
    • get_user_status()
    • iter_entry_points()
    • log_if_changed()
    • login_overlay()
    • make_safe_path_portion()
    • ming_config()
    • ming_config_from_ini()
    • notifications_disabled()
    • null_contextmanager()
    • paging_sanitizer()
    • push_context()
    • querystring()
    • rate_limit()
    • render_any_markup()
    • set_context()
    • slugify()
    • strip_bad_unicode()
    • topological_sort()
    • unidiff()
    • urlopen()
    • urlquote_path_only()
  • allura.lib.multifactor
    • GoogleAuthenticatorFile
    • GoogleAuthenticatorPamFilesystemRecoveryCodeService
    • GoogleAuthenticatorPamFilesystemTotpService
    • MongodbRecoveryCodeService
    • MongodbTotpService
    • RecoveryCodeService
    • TotpService
    • check_rate_limit()
  • allura.lib.package_path_loader
    • Dotted notation
    • Overriding dotted notation
    • PackagePathLoader
  • allura.lib.phone
    • PhoneService
  • allura.lib.plugin
    • AdminExtension
    • AuthenticationProvider
    • ImportIdConverter
    • LdapAuthenticationProvider
    • LdapUserPreferencesProvider
    • LocalAuthenticationProvider
    • LocalProjectRegistrationProvider
    • LocalUserPreferencesProvider
    • ProjectRegistrationProvider
    • ResponsiveTheme
    • SiteAdminExtension
    • ThemeProvider
    • UserPreferencesProvider
    • ldap_conn()
    • ldap_conn_staysopen()
    • ldap_user_dn()
  • allura.lib.security
    • Credentials
    • HIBPClientError
    • HIBPCompromisedCredentials
    • RoleCache
    • all_allowed()
    • has_access()
    • is_site_admin()
    • require()
    • require_authenticated()
  • allura.lib.spam
    • ChainedSpamFilter
    • SpamFilter
• allura.model
  • allura.model.artifact
    • Artifact
    • Snapshot
    • VersionedArtifact
    • Message
    • Feed
    • VotableArtifact
    • MovedArtifact
  • allura.model.auth
    • User
    • ProjectRole
    • AuditLog
  • allura.model.monq_model
    • MonQTask
  • allura.model.neighborhood
    • Neighborhood
    • NeighborhoodFile
  • allura.model.notification
    • Mailbox
    • Notification
    • SiteNotification
  • allura.model.project
    • AppConfig
    • Project
    • ProjectCategory
    • ProjectFile
    • ProjectNameFieldProperty
    • TroveCategory
    • TroveCategoryMapperExtension
  • allura.model.session
    • ArtifactSessionExtension
    • BatchIndexer
    • ExplicitFlushOnlySessionExtension
    • IndexerSessionExtension
    • ManagedSessionExtension
    • substitute_extensions()
  • allura.model.timeline
    • ActivityNode
    • ActivityObject
    • Aggregator
    • Director
    • TransientActor
    • get_activity_object()
    • perm_check()
  • allura.model.types
    • ACE
    • ACL
    • MarkdownCache
  • allura.model.webhook
    • Webhook
• allura.scripts
• allura.tasks
  • install_app()
  • bulk_export()
  • sendmail()
  • sendsimplemail()
• allura.webhooks
  • RepoPushWebhookSender
    • RepoPushWebhookSender.get_payload()
  • WebhookController
    • WebhookController.create_form
    • WebhookController.edit_form
  • WebhookCreateForm
  • WebhookEditForm
  • WebhookSender
    • WebhookSender.controller
    • WebhookSender.enforce_limit()
    • WebhookSender.get_payload()
    • WebhookSender.send()
  • WebhookValidator