<!DOCTYPE html>
<html lang="en">
<head>
  <meta charset="utf-8">
  <meta name="viewport" content="width=device-width, initial-scale=1.0">
  <meta http-equiv="X-UA-Compatible" content="ie=edge">
  <link rel="stylesheet" href="../../../static/styles.css?h=dff0aaad">
  <link rel="stylesheet" href="../../../static/pygments.css">
  <link rel="shortcut icon" href="../../../static/favicon.png?h=fa09bedd">
  <title>Environment | Documentation | Lektor Static Content Management System</title>
</head>
<body class="default">
  <nav class="navbar navbar-inverse navbar-static-top">
    <div class="container">
      <div class="navbar-header">
        <button type="button" class="navbar-toggle collapsed"
          data-toggle="collapse" data-target="#navbar"
          aria-expanded="false" aria-controls="navbar">
          <span class="sr-only">Toggle navigation</span>
          <span class="icon-bar"></span>
          <span class="icon-bar"></span>
          <span class="icon-bar"></span>
        </button>
        <a class="navbar-brand" href="../../../">Lektor</a>
      </div>
      <div id="navbar" class="collapse navbar-collapse">
        <ul class="nav navbar-nav">
          
            <li><a href="../../../downloads/">Download</a></li>
          
            <li class="active"><a href="../../">Documentation</a></li>
          
            <li><a href="../../../showcase/">Showcase</a></li>
          
            <li><a href="../../../plugins/">Plugins</a></li>
          
            <li><a href="../../../community/">Community</a></li>
          
            <li><a href="../../../blog/">Blog</a></li>
          
        </ul>
      </div>
    </div>
  </nav>

  <div class="body-wrapper">
    
    <div class="container">
      
  <div class="row">
    <div class="col-sm-3">
      <ul class="tree-nav nocontent">
        <li><a href="../../">Welcome</a></li>
        
        
          <li><a href="../../what/">What is Lektor</a>
            
        
          <li><a href="../../installation/">Installation</a>
            
        
          <li><a href="../../quickstart/">Quickstart</a>
            
        
          <li><a href="../../project/">Project</a>
            
        
          <li><a href="../../content/">Content</a>
            
        
          <li><a href="../../templates/">Templates</a>
            
        
          <li><a href="../../themes/">Themes</a>
            
        
          <li><a href="../../guides/">Guides</a>
            
        
          <li><a href="../../deployment/">Deployment</a>
            
        
          <li><a href="../../plugins/">Plugins</a>
            
        
          <li><a href="../../models/">Data Modelling</a>
            
        
          <li><a href="../../cli/">Command Line</a>
            
        
          <li><a href="../">API</a>
            
            <ul>
          <li><a href="../build/">Build System</a>
            
        
          <li><a href="../databags/">Databags</a>
            
        
          <li><a href="../db/">Database</a>
            
        
          <li class="active"><a href="./">Environment</a>
            
            <ul>
          <li><a href="add-build-program/">add_build_program()</a>
            
        
          <li><a href="add-publisher/">add_publisher()</a>
            
        
          <li><a href="add-type/">add_type()</a>
            
        
          <li><a href="generator/">generator()</a>
            
        
          <li><a href="jinja-env/">jinja_env</a>
            
        
          <li><a href="load-config/">load_config()</a>
            
        
          <li><a href="load-plugins/">load_plugins()</a>
            
        
          <li><a href="new-pad/">new_pad()</a>
            
        
          <li><a href="render-template/">render_template()</a>
            
        
          <li><a href="urlresolver/">urlresolver()</a>
            
        
          <li><a href="virtualpathresolver/">virtualpathresolver()</a>
            
        </ul>
            
        
          <li><a href="../plugins/">Plugins</a>
            
        
          <li><a href="../project/">Project</a>
            
        
          <li><a href="../publisher/">Publisher</a>
            
        
          <li><a href="../templates/">Template API</a>
            
        
          <li><a href="../utils/">Utilities</a>
            
        </ul>
            
        
          <li><a href="../../search/">Search</a>
            
        
      </ul>

      
      <div class="visible-md-block visible-lg-block">
        <h4>This Page</h4>
        <ul class="toc">
        
          <li><a href="#example">Example</a></li>
        
        </ul>
      </div>
      
    </div>

    <div class="col-sm-9 doc-styling">
      
  
    <h1><i class="glyphicon glyphicon-leaf"></i> <code class="mod">lektor.environment.</code><code class="obj">Environment</code></h1>
  


      <ul class=page-meta>
      
      
      
      </ul>

      <p>This class holds all the relevant information for building a Lektor
<a href="../project/" class="ref">Project</a>.  It can be reused between builds and only
holds state that is immutable after initialization.  For instance it
will hold all loaded plugins, the configuration for the Jinja 2
template engine and more.</p>
<p>Plugins have access to the environment at any point by accessing <code>self.env</code>.</p>
<h2 id="example">Example</h2><div class="hll"><pre><span></span><span class="kn">from</span> <span class="nn">lektor.project</span> <span class="kn">import</span> <span class="n">Project</span>

<span class="n">project</span> <span class="o">=</span> <span class="n">Project</span><span class="o">.</span><span class="n">discover</span><span class="p">()</span>
<span class="n">env</span> <span class="o">=</span> <span class="n">project</span><span class="o">.</span><span class="n">make_env</span><span class="p">()</span>
</pre></div>

      

      

      
      <div class="child-pages nocontent">
        
          <div class="row">
            
            <div class="col-md-6 child">
              <h4>
                <i class="glyphicon glyphicon-cog"></i>
                <a href="add-build-program/">add_build_program()</a>
              </h4>
              
                <p class="summary">Registers a build program for a source object.</p>
              
            </div>
            
            <div class="col-md-6 child">
              <h4>
                <i class="glyphicon glyphicon-cog"></i>
                <a href="add-publisher/">add_publisher()</a>
              </h4>
              
                <p class="summary">Registers a publisher class with the environment.</p>
              
            </div>
            
          </div>
        
          <div class="row">
            
            <div class="col-md-6 child">
              <h4>
                <i class="glyphicon glyphicon-cog"></i>
                <a href="add-type/">add_type()</a>
              </h4>
              
                <p class="summary">Adds a new field type to the environment.</p>
              
            </div>
            
            <div class="col-md-6 child">
              <h4>
                <i class="glyphicon glyphicon-cog"></i>
                <a href="generator/">generator()</a>
              </h4>
              
                <p class="summary">Registers a custom generator function.</p>
              
            </div>
            
          </div>
        
          <div class="row">
            
            <div class="col-md-6 child">
              <h4>
                <i class="glyphicon glyphicon-info-sign"></i>
                <a href="jinja-env/">jinja_env</a>
              </h4>
              
                <p class="summary">The configured Jinja 2 Environment.</p>
              
            </div>
            
            <div class="col-md-6 child">
              <h4>
                <i class="glyphicon glyphicon-cog"></i>
                <a href="load-config/">load_config()</a>
              </h4>
              
                <p class="summary">Loads the current config from the project file.</p>
              
            </div>
            
          </div>
        
          <div class="row">
            
            <div class="col-md-6 child">
              <h4>
                <i class="glyphicon glyphicon-cog"></i>
                <a href="load-plugins/">load_plugins()</a>
              </h4>
              
                <p class="summary">Loads the available plugins for the environment.</p>
              
            </div>
            
            <div class="col-md-6 child">
              <h4>
                <i class="glyphicon glyphicon-cog"></i>
                <a href="new-pad/">new_pad()</a>
              </h4>
              
                <p class="summary">Creates a brand new database pad.</p>
              
            </div>
            
          </div>
        
          <div class="row">
            
            <div class="col-md-6 child">
              <h4>
                <i class="glyphicon glyphicon-cog"></i>
                <a href="render-template/">render_template()</a>
              </h4>
              
                <p class="summary">Renders a template from the template folder.</p>
              
            </div>
            
            <div class="col-md-6 child">
              <h4>
                <i class="glyphicon glyphicon-cog"></i>
                <a href="urlresolver/">urlresolver()</a>
              </h4>
              
                <p class="summary">Registers a custom URL resolver function.</p>
              
            </div>
            
          </div>
        
          <div class="row">
            
            <div class="col-md-6 child">
              <h4>
                <i class="glyphicon glyphicon-cog"></i>
                <a href="virtualpathresolver/">virtualpathresolver()</a>
              </h4>
              
                <p class="summary">Registers a virtual path resolver with the environment.</p>
              
            </div>
            
          </div>
        
      </div>
      

      
      <div class="comment-box">
        <h2>Comments</h2>
        
<div id="disqus_thread"></div>
<script>
  var disqus_config = function() { this.page.identifier = "/docs/api/environment"; this.page.url = "https://www.getlektor.com/docs/api/environment/"; };
  (function() {
    var d = document, s = d.createElement('script');
    s.src = '//lektordocumentation.disqus.com/embed.js';
    s.setAttribute('data-timestamp', +new Date());
    (d.head || d.body).appendChild(s);
  })();
</script>
<noscript>
  Please enable JavaScript to view the <a href="https://disqus.com/?ref_noscript"
    rel="nofollow">comments powered by Disqus.</a>
</noscript>

      </div>
      
    </div>
  </div>

    </div>
    
  </div>

  
  <div class="bottomsummary">
    <div class="container">
    </div>
  </div>
  

  
  <footer>
    <div class="container">
      <div class="row">
        <div class="col-sm-4 icon-bar">
          <a href="https://github.com/lektor/lektor/" title="Lektor on GitHub"
            ><i class="fa fa-github"></i></a>
          <a href="https://github.com/lektor/lektor/issues/" title="Report Issues for Lektor"
            ><i class="fa fa-bug"></i></a>
          <a href="https://twitter.com/getlektor" title="Find Lektor on Twitter"
            ><i class="fa fa-twitter"></i></a>
          <a href="https://gitter.im/lektor/lektor" title="Chat on Gitter"
            ><i class="fa fa-comment"></i></a>
          <a href="https://github.com/lektor/lektor-website/tree/master/content/docs/api/environment/contents.lr" title="View source for this page"><i class="fa fa-code"></i></a>
        </div>
        <div class="col-sm-8">
          <a href="../../../license/">License & Copyright</a> •
          <a href="../../../contact/">Contact</a> •
          Made with <i class="fa fa-fw fa-heart" title="Heart"><span hidden>Heart</span></i> in Carinthia
        </div>
      </div>
    </div>
  </footer>
  

  <script type=text/javascript src="../../../static/app.js?h=dcf26092" charset="utf-8"></script>
  <script>
    ((window.gitter = {}).chat = {}).options = {
      room: 'lektor/lektor',
      activationElement: null
    };
    document.write('<button class="js-gitter-toggle-chat-button">Toggle Chat</button>');
    var dnt = navigator.doNotTrack || window.doNotTrack || navigator.msDoNotTrack;
    if (dnt != "1" && dnt != "yes") {
    window.ga=window.ga||function(){(ga.q=ga.q||[]).push(arguments)};ga.l=+new Date;
      ga('create', 'UA-70822533-1', 'auto');
      ga('set', 'anonymizeIp', true);
      ga('send', 'pageview');
    } else {
      console.debug("Respecting Do-Not-Track, not running analytics.");
    }
  </script>
  <script async src='https://www.google-analytics.com/analytics.js'></script>
  <script async defer id="github-bjs" src="https://buttons.github.io/buttons.js"></script>
  <script>!function(d,s,id){var js,fjs=d.getElementsByTagName(s)[0],p=/^http:/.test(d.location)?'http':'https';if(!d.getElementById(id)){js=d.createElement(s);js.id=id;js.src=p+'://platform.twitter.com/widgets.js';fjs.parentNode.insertBefore(js,fjs);}}(document, 'script', 'twitter-wjs');</script>
  <script src="https://sidecar.gitter.im/dist/sidecar.v1.js" async defer></script>
</body>
</html>