Welcome to Pycroft’s documentation!

Contents:

• Welcome to Pycroft’s documentation!

Guides

Guides

• Minimal setup
• Git
• Docker
• Database setup
• PyCharm Integration
• Tests
• Troubleshooting
• Alembic
• Celery

Explanations

Explanations

• Docker architecture

Reference Documentation

Reference documentation

• pycroft
  • What belongs in this package
  • Subpackages
  • Submodules
• web
  • web
  • Subpackages
  • Submodules
• ldap_sync
  • ldap_sync.__main__
  • sync_production()
  • sync_fake()
  • fetch_and_sync()
  • try_setup_sentry()
  • trigger_sentry()
  • add_stdout_logging()
  • main()
  • ldap_sync.concepts.action
  • Action
  • AddAction
  • ModifyAction
  • DeleteAction
  • IdleAction
  • ldap_sync.concepts.record
  • escape_and_normalize_attrs()
  • Record
  • UserRecord
  • GroupRecord
  • RecordState
  • ldap_sync.concepts.types
  • DN
  • LdapRecord
  • ldap_sync.sources.db
  • _fetch_db_groups()
  • _fetch_db_properties()
  • _fetch_db_users()
  • establish_and_return_session()
  • fetch_db_groups()
  • fetch_db_properties()
  • fetch_db_users()
  • EXPORTED_PROPERTIES
  • ldap_sync.sources.ldap
  • _fetch_ldap_entries()
  • _fetch_ldap_groups()
  • _fetch_ldap_properties()
  • _fetch_ldap_users()
  • establish_and_return_ldap_connection()
  • fake_connection()
  • fetch_ldap_groups()
  • fetch_ldap_properties()
  • fetch_ldap_users()
  • ldap_sync.config
  • SyncConfig
  • get_config()
  • get_config_or_exit()
  • ldap_sync.conversion
  • db_user_to_record()
  • db_group_to_record()
  • dn_from_username()
  • dn_from_cn()
  • ldap_user_to_record()
  • ldap_group_to_record()
  • ldap_sync.execution
  • execute_real()
  • debug_whether_success()
  • ldap_sync.record_diff
  • diff_attributes()
  • diff_user_attributes()
  • diff_records()
  • iter_zip_dicts()
  • bulk_diff_records()

Indices and tables

Indices and tables

• Index
• Module Index
• Search Page

Architecture decision records

Architecture decision records

• ADR001 – Use jQuery in typescript modules exclusively
• ADR002 - Continue using pickle as default serializer
• ADR003 - Use ``.table_valued`` wrapper for table valued sql functions
• ADR004 - Deprecate usage of ``session`` proxy in favor of dependency injection
• ADR005 - Improved exception handling in views
• ADR006
• ADRXXX