EspressoDB
latest

Contents:

  • EspressoDB
    • What does EspressoDB provide?
    • How to install it?
    • What’s the story behind it?
    • Who is responsible for it?
    • Contributing
    • License
  • How to use EspressoDB
    • TL;DR
    • Details
      • Install EspressoDB
      • Start a project
      • Configure your project
      • Create or update the database
        • Create migrations
        • Migrate changes
      • Launch a local web app
      • Create a new app
      • Install your project locally
  • The example project
    • What can I do?
      • Install the project
      • The public views
        • The home page
        • The doc page
        • The population views
        • The login page
        • The Hamiltonian status page
      • The private views
        • The notifications page
        • The admin pages
      • Using your project in external modules
        • Installing your module
        • Using tables
        • The add_data.py script
    • How do I set up the example project myself?
      • Create your own project
        • Start the project
      • Create the hamiltonians app
        • Creating the infrastructure
        • Creating tables
      • Adding data
        • The admin page
        • Data scripts
      • Providing short cuts with class methods
      • Adding tables with relationships
        • Updating the models
        • Updating the run script
      • Creating web views for summaries
        • Adjusting the index template
        • Views with plots
  • FAQ
    • Q: Why (or when) should I use EspressoDB?
    • Q: How do I interact with EspressoDB projects?
    • Q: What should I know to get started with EspressoDB?
    • Q: What are possible deployment scenarios?
    • Q: Who can access the data which is stored using EspressoDB?
    • Q: How does EspressoDB help to ensure data integrity?
  • Advanced features of EspressoDB
    • Consistency checks
      • TL;DR
      • The need for checks
      • The basic idea
      • Disable checks
      • Raised exceptions
      • Many-to-many checks
    • Pre-save functionality
      • TL;DR
      • Implementing a code version storage
    • Automated cross-checks
      • Updating default behavior
    • More complicated tables
      • In which scenario are they helpful
      • Implementation of common base
        • The implementation
        • Underlaying tables
        • Unique constraints
        • Queries and member access
  • Customizing EspressoDB
    • Admin page
    • Navigation customizations
  • API Reference of EspressoDB
    • espressodb.base
      • admin
      • exceptions
      • models
      • signals
      • static
      • urls
      • views
      • utilities
        • apps
        • blackmagicsorcery
        • markdown
        • models
      • templatetags
        • base_extras
    • espressodb.documentation
      • urls
      • views
      • templatetags
        • documentation_extras
    • espressodb.notifications
      • models
      • urls
      • views
      • templatetags
        • notifications_extras
    • espressodb.management
      • utilities
        • files
        • settings
        • version
      • checks
        • migrations
      • commands
        • info
        • startapp
        • startproject
    • Summary of EspressoDB functionality
      • URLs
        • Module: espressodb.base.urls
        • Module: espressodb.documentation.urls
        • Module: espressodb.notifications.urls
      • Templatetags
        • Module: espressodb.base.templatetags.base_extras
        • Module: espressodb.documentation.templatetags.documentation_extras
        • Module: espressodb.notifications.templatetags.notifications_extras
  • Contributing to EspressoDB
    • Guiding principles
    • What we are looking for
    • Community: questions & discussions
    • Filing issues
      • Filing Bugs
    • Your first contribution
      • Tests
      • Preferred style of code
      • Versioning
EspressoDB
  • Docs »
  • The example project
  • Edit on GitHub

The example project¶

EspressoDB aims to create projects fast. In this section,

  1. we want to present an example project and a few of EspressoDB’s features.

  2. we guide to the process which creates this project.

Contents:

  • What can I do?
    • Install the project
    • The public views
      • The home page
      • The doc page
      • The population views
      • The login page
      • The Hamiltonian status page
    • The private views
      • The notifications page
      • The admin pages
    • Using your project in external modules
      • Installing your module
      • Using tables
      • The add_data.py script
  • How do I set up the example project myself?
    • Create your own project
      • Start the project
    • Create the hamiltonians app
      • Creating the infrastructure
      • Creating tables
    • Adding data
      • The admin page
      • Data scripts
    • Providing short cuts with class methods
    • Adding tables with relationships
      • Updating the models
      • Updating the run script
    • Creating web views for summaries
      • Adjusting the index template
      • Views with plots
        • Creating a template view
        • Creating the template
        • Update the urls
        • Preparing data
        • Preparing the plot
        • Wrapping things together
        • Summary
Next Previous

© Copyright 2019, Christopher Körber, Jason Chang Revision 70f88f33.

Built with Sphinx using a theme provided by Read the Docs.