QT/superset2
1
0
Fork 0
mirror of https://github.com/apache/superset.git synced 2026-05-07 08:54:23 +00:00
Code Issues Packages Projects Releases Wiki Activity

Finalizing the rename in the docs

Browse Source
This commit is contained in:
Maxime Beauchemin
2016-03-29 21:25:26 -07:00
parent 992bc4be22
commit 01dccde591
3 changed files with 39 additions and 39 deletions
Download Patch File Download Diff File Expand all files Collapse all files

38
_sources/installation.txt
View File

@@ -4,35 +4,35 @@ Installation & Configuration
Getting Started
---------------
Panoramix is currently only tested using Python 2.7.*. Python 3 support is
Caravel is currently only tested using Python 2.7.*. Python 3 support is
on the roadmap, Python 2.6 won't be supported.
Follow these few simple steps to install Panoramix.::
Follow these few simple steps to install Caravel.::
# Install panoramix
pip install panoramix
# Install caravel
pip install caravel
# Create an admin user
fabmanager create-admin --app panoramix
fabmanager create-admin --app caravel
# Initialize the database
panoramix db upgrade
caravel db upgrade
# Create default roles and permissions
panoramix init
caravel init
# Load some data to play with
panoramix load_examples
caravel load_examples
# Start the development web server
panoramix runserver -d
caravel runserver -d
After installation, you should be able to point your browser to the right
hostname:port [http://localhost:8088](http://localhost:8088), login using
the credential you entered while creating the admin account, and navigate to
`Menu -> Admin -> Refresh Metadata`. This action should bring in all of
your datasources for Panoramix to be aware of, and they should show up in
your datasources for Caravel to be aware of, and they should show up in
`Menu -> Datasources`, from where you can start playing with your data!
@@ -40,16 +40,16 @@ Configuration
-------------
To configure your application, you need to create a file (module)
``panoramix_config.py`` and make sure it is in your PYTHONPATH. Here are some
``caravel_config.py`` and make sure it is in your PYTHONPATH. Here are some
of the parameters you can copy / paste in that configuration module: ::
#---------------------------------------------------------
# Panoramix specifix config
# Caravel specifix config
#---------------------------------------------------------
ROW_LIMIT = 5000
WEBSERVER_THREADS = 8
PANORAMIX_WEBSERVER_PORT = 8088
CARAVEL_WEBSERVER_PORT = 8088
#---------------------------------------------------------
#---------------------------------------------------------
@@ -59,7 +59,7 @@ of the parameters you can copy / paste in that configuration module: ::
SECRET_KEY = '\2\1thisismyscretkey\1\2\e\y\y\h'
# The SQLAlchemy connection string.
SQLALCHEMY_DATABASE_URI = 'sqlite:////tmp/panoramix.db'
SQLALCHEMY_DATABASE_URI = 'sqlite:////tmp/caravel.db'
# Flask-WTF flag for CSRF
CSRF_ENABLED = True
@@ -68,24 +68,24 @@ of the parameters you can copy / paste in that configuration module: ::
DEBUG = True
This file also allows you to define configuration parameters used by
Flask App Builder, the web framework used by Panoramix. Please consult
Flask App Builder, the web framework used by Caravel. Please consult
the `Flask App Builder Documentation
<http://flask-appbuilder.readthedocs.org/en/latest/config.html>`_
for more information on how to configure Panoramix.
for more information on how to configure Caravel.
Caching
-------
Panoramix uses `Flask-Cache <https://pythonhosted.org/Flask-Cache/>`_ for
Caravel uses `Flask-Cache <https://pythonhosted.org/Flask-Cache/>`_ for
caching purpose. Configuring your caching backend is as easy as providing
a ``CACHE_CONFIG``, constant in your ``panoramix_config.py`` that
a ``CACHE_CONFIG``, constant in your ``caravel_config.py`` that
complies with the Flask-Cache specifications.
Flask-Cache supports multiple caching backends (Redis, Memcache,
SimpleCache (in-memory), or the local filesystem).
For setting your timeouts, this is done in the Panoramix metadata and goes
For setting your timeouts, this is done in the Caravel metadata and goes
up the "timeout searchpath", from your slice configuration, to your
data source's configuration, to your database's and ultimately falls back
into your global default defined in ``CACHE_CONFIG``.

38
installation.html
View File

@@ -124,47 +124,47 @@
<h1>Installation &amp; Configuration<a class="headerlink" href="#installation-configuration" title="Permalink to this headline"></a></h1>
<div class="section" id="getting-started">
<h2>Getting Started<a class="headerlink" href="#getting-started" title="Permalink to this headline"></a></h2>
<p>Panoramix is currently only tested using Python 2.7.*. Python 3 support is
<p>Caravel is currently only tested using Python 2.7.*. Python 3 support is
on the roadmap, Python 2.6 won&#8217;t be supported.</p>
<p>Follow these few simple steps to install Panoramix.:</p>
<div class="highlight-python"><div class="highlight"><pre><span></span># Install panoramix
pip install panoramix
<p>Follow these few simple steps to install Caravel.:</p>
<div class="highlight-python"><div class="highlight"><pre><span></span># Install caravel
pip install caravel
# Create an admin user
fabmanager create-admin --app panoramix
fabmanager create-admin --app caravel
# Initialize the database
panoramix db upgrade
caravel db upgrade
# Create default roles and permissions
panoramix init
caravel init
# Load some data to play with
panoramix load_examples
caravel load_examples
# Start the development web server
panoramix runserver -d
caravel runserver -d
</pre></div>
</div>
<p>After installation, you should be able to point your browser to the right
hostname:port [http://localhost:8088](http://localhost:8088), login using
the credential you entered while creating the admin account, and navigate to
<cite>Menu -&gt; Admin -&gt; Refresh Metadata</cite>. This action should bring in all of
your datasources for Panoramix to be aware of, and they should show up in
your datasources for Caravel to be aware of, and they should show up in
<cite>Menu -&gt; Datasources</cite>, from where you can start playing with your data!</p>
</div>
<div class="section" id="configuration">
<h2>Configuration<a class="headerlink" href="#configuration" title="Permalink to this headline"></a></h2>
<p>To configure your application, you need to create a file (module)
<code class="docutils literal"><span class="pre">panoramix_config.py</span></code> and make sure it is in your PYTHONPATH. Here are some
<code class="docutils literal"><span class="pre">caravel_config.py</span></code> and make sure it is in your PYTHONPATH. Here are some
of the parameters you can copy / paste in that configuration module:</p>
<div class="highlight-python"><div class="highlight"><pre><span></span><span class="c1">#---------------------------------------------------------</span>
<span class="c1"># Panoramix specifix config</span>
<span class="c1"># Caravel specifix config</span>
<span class="c1">#---------------------------------------------------------</span>
<span class="n">ROW_LIMIT</span> <span class="o">=</span> <span class="mi">5000</span>
<span class="n">WEBSERVER_THREADS</span> <span class="o">=</span> <span class="mi">8</span>
<span class="n">PANORAMIX_WEBSERVER_PORT</span> <span class="o">=</span> <span class="mi">8088</span>
<span class="n">CARAVEL_WEBSERVER_PORT</span> <span class="o">=</span> <span class="mi">8088</span>
<span class="c1">#---------------------------------------------------------</span>
<span class="c1">#---------------------------------------------------------</span>
@@ -174,7 +174,7 @@ of the parameters you can copy / paste in that configuration module:</p>
<span class="n">SECRET_KEY</span> <span class="o">=</span> <span class="s1">&#39;</span><span class="se">\2\1</span><span class="s1">thisismyscretkey</span><span class="se">\1\2</span><span class="s1">\e\y\y\h&#39;</span>
<span class="c1"># The SQLAlchemy connection string.</span>
<span class="n">SQLALCHEMY_DATABASE_URI</span> <span class="o">=</span> <span class="s1">&#39;sqlite:////tmp/panoramix.db&#39;</span>
<span class="n">SQLALCHEMY_DATABASE_URI</span> <span class="o">=</span> <span class="s1">&#39;sqlite:////tmp/caravel.db&#39;</span>
<span class="c1"># Flask-WTF flag for CSRF</span>
<span class="n">CSRF_ENABLED</span> <span class="o">=</span> <span class="bp">True</span>
@@ -184,19 +184,19 @@ of the parameters you can copy / paste in that configuration module:</p>
</pre></div>
</div>
<p>This file also allows you to define configuration parameters used by
Flask App Builder, the web framework used by Panoramix. Please consult
Flask App Builder, the web framework used by Caravel. Please consult
the <a class="reference external" href="http://flask-appbuilder.readthedocs.org/en/latest/config.html">Flask App Builder Documentation</a>
for more information on how to configure Panoramix.</p>
for more information on how to configure Caravel.</p>
</div>
<div class="section" id="caching">
<h2>Caching<a class="headerlink" href="#caching" title="Permalink to this headline"></a></h2>
<p>Panoramix uses <a class="reference external" href="https://pythonhosted.org/Flask-Cache/">Flask-Cache</a> for
<p>Caravel uses <a class="reference external" href="https://pythonhosted.org/Flask-Cache/">Flask-Cache</a> for
caching purpose. Configuring your caching backend is as easy as providing
a <code class="docutils literal"><span class="pre">CACHE_CONFIG</span></code>, constant in your <code class="docutils literal"><span class="pre">panoramix_config.py</span></code> that
a <code class="docutils literal"><span class="pre">CACHE_CONFIG</span></code>, constant in your <code class="docutils literal"><span class="pre">caravel_config.py</span></code> that
complies with the Flask-Cache specifications.</p>
<p>Flask-Cache supports multiple caching backends (Redis, Memcache,
SimpleCache (in-memory), or the local filesystem).</p>
<p>For setting your timeouts, this is done in the Panoramix metadata and goes
<p>For setting your timeouts, this is done in the Caravel metadata and goes
up the &#8220;timeout searchpath&#8221;, from your slice configuration, to your
data source&#8217;s configuration, to your database&#8217;s and ultimately falls back
into your global default defined in <code class="docutils literal"><span class="pre">CACHE_CONFIG</span></code>.</p>

2
searchindex.js
View File

@@ -1 +1 @@
Search.setIndex({envversion:46,filenames:["index","installation","user_guide"],objects:{},objnames:{},objtypes:{},terms:{"1thisismyscretkei":1,"default":1,"function":0,"new":2,"short":2,"true":1,"while":1,abl:1,about:1,access:[0,2],account:1,action:1,admin:1,affect:2,after:1,aggreg:0,all:1,allow:[0,1],alreadi:2,also:1,alter:2,annot:0,app:1,appbuild:0,appli:2,applic:1,aspect:2,authent:0,avail:[0,2],awar:1,back:1,backend:1,been:0,best:0,bring:1,browser:1,builder:1,cach:0,cache_config:1,can:[0,1,2],caravel:[0,2],certain:2,chart:2,cluster:1,collect:2,come:2,compli:1,config:1,configur:0,connect:1,constant:1,consult:1,control:0,copi:1,creat:[0,1,2],creation:0,credenti:1,csrf:1,csrf_enabl:1,css:0,current:1,custom:0,dashboard:0,data:[0,1,2],databas:[0,1],dataset:[0,2],datasourc:1,debug:1,deep:0,defin:[0,1],demonstr:2,deriv:2,develop:1,differ:2,dimens:2,displai:0,document:1,done:1,down:0,drop:0,druid:0,dynam:2,easi:1,enter:1,enterpris:0,exist:2,explor:2,expos:2,express:0,extens:0,fabmanag:1,fall:1,few:1,field:0,file:1,filesystem:1,filter:0,flag:1,flask:[0,1],follow:1,framework:1,from:[0,1,2],get:0,global:1,goe:1,granular:0,guid:0,here:1,high:[0,2],hit:1,hostnam:1,how:[0,1,2],http:1,immun:2,index:0,individu:0,inform:1,init:1,initi:1,instal:0,integr:0,intric:0,intro:0,item:1,kei:1,languag:2,layer:0,ldap:0,level:2,librari:0,load:1,load_exampl:1,local:1,localhost:1,login:1,made:0,major:0,make:1,march:0,markdown:2,memcach:1,memori:1,menu:1,metadata:1,metric:[0,2],mode:1,model:0,modul:[0,1],more:1,most:0,multipl:1,name:0,navig:[1,2],need:1,oauth:0,onc:1,onli:1,openid:0,other:2,own:2,page:0,panoramix:[0,1],panoramix_config:1,panoramix_webserver_port:1,paramet:1,past:1,permiss:[0,1],pip:1,plai:1,pleas:1,point:1,popul:1,port:1,project:0,provid:[0,1],purpos:1,python:1,pythonpath:1,quick:0,rdbm:0,readi:0,redi:1,refresh:1,remote_us:0,renam:0,rich:0,right:1,roadmap:1,role:1,row_limit:1,rule:0,run:1,runserv:1,search:0,searchpath:1,secret:1,secret_kei:1,secur:0,semant:[0,2],server:1,set:[0,1],share:0,should:[0,1],show:[0,1,2],sign:1,simpl:[0,1,2],simplecach:1,slice:[0,1],some:[0,1],soon:2,sourc:[0,1],specif:1,specifix:1,sql:0,sqlalchemi:[0,1],sqlalchemy_database_uri:1,sqlite:1,start:0,step:1,string:1,support:1,sure:1,templat:2,test:1,thei:1,them:2,theme:0,thi:[0,1,2],through:[0,2],timeout:1,tmp:1,toggl:2,ultim:1,upgrad:1,user:[0,1],video:2,view:2,visual:0,walk:2,walkthrough:2,web:1,webserver_thread:1,where:1,whether:1,which:0,who:0,widget:2,won:1,work:2,wtf:1,you:[1,2],your:[1,2]},titles:["Overview","Installation &amp; Configuration","User Guide"],titleterms:{annot:2,cach:1,configur:1,content:0,creation:2,css:2,custom:2,dashboard:2,defin:2,druid:1,express:2,featur:0,filter:2,get:1,guid:2,indic:0,instal:1,intro:2,overview:0,quick:2,slice:2,sql:2,start:1,tabl:[0,2],theme:2,user:2}})
Search.setIndex({envversion:46,filenames:["index","installation","user_guide"],objects:{},objnames:{},objtypes:{},terms:{"1thisismyscretkei":1,"default":1,"function":0,"new":2,"short":2,"true":1,"while":1,abl:1,about:1,access:[0,2],account:1,action:1,admin:1,affect:2,after:1,aggreg:0,all:1,allow:[0,1],alreadi:2,also:1,alter:2,annot:0,app:1,appbuild:0,appli:2,applic:1,aspect:2,authent:0,avail:[0,2],awar:1,back:1,backend:1,been:0,best:0,bring:1,browser:1,builder:1,cach:0,cache_config:1,can:[0,1,2],caravel:[0,1,2],caravel_config:1,caravel_webserver_port:1,certain:2,chart:2,cluster:1,collect:2,come:2,compli:1,config:1,configur:0,connect:1,constant:1,consult:1,control:0,copi:1,creat:[0,1,2],creation:0,credenti:1,csrf:1,csrf_enabl:1,css:0,current:1,custom:0,dashboard:0,data:[0,1,2],databas:[0,1],dataset:[0,2],datasourc:1,debug:1,deep:0,defin:[0,1],demonstr:2,deriv:2,develop:1,differ:2,dimens:2,displai:0,document:1,done:1,down:0,drop:0,druid:0,dynam:2,easi:1,enter:1,enterpris:0,exist:2,explor:2,expos:2,express:0,extens:0,fabmanag:1,fall:1,few:1,field:0,file:1,filesystem:1,filter:0,flag:1,flask:[0,1],follow:1,framework:1,from:[0,1,2],get:0,global:1,goe:1,granular:0,guid:0,here:1,high:[0,2],hit:1,hostnam:1,how:[0,1,2],http:1,immun:2,index:0,individu:0,inform:1,init:1,initi:1,instal:0,integr:0,intric:0,intro:0,item:1,kei:1,languag:2,layer:0,ldap:0,level:2,librari:0,load:1,load_exampl:1,local:1,localhost:1,login:1,made:0,major:0,make:1,march:0,markdown:2,memcach:1,memori:1,menu:1,metadata:1,metric:[0,2],mode:1,model:0,modul:[0,1],more:1,most:0,multipl:1,name:0,navig:[1,2],need:1,oauth:0,onc:1,onli:1,openid:0,other:2,own:2,page:0,panoramix:0,paramet:1,past:1,permiss:[0,1],pip:1,plai:1,pleas:1,point:1,popul:1,port:1,project:0,provid:[0,1],purpos:1,python:1,pythonpath:1,quick:0,rdbm:0,readi:0,redi:1,refresh:1,remote_us:0,renam:0,rich:0,right:1,roadmap:1,role:1,row_limit:1,rule:0,run:1,runserv:1,search:0,searchpath:1,secret:1,secret_kei:1,secur:0,semant:[0,2],server:1,set:[0,1],share:0,should:[0,1],show:[0,1,2],sign:1,simpl:[0,1,2],simplecach:1,slice:[0,1],some:[0,1],soon:2,sourc:[0,1],specif:1,specifix:1,sql:0,sqlalchemi:[0,1],sqlalchemy_database_uri:1,sqlite:1,start:0,step:1,string:1,support:1,sure:1,templat:2,test:1,thei:1,them:2,theme:0,thi:[0,1,2],through:[0,2],timeout:1,tmp:1,toggl:2,ultim:1,upgrad:1,user:[0,1],video:2,view:2,visual:0,walk:2,walkthrough:2,web:1,webserver_thread:1,where:1,whether:1,which:0,who:0,widget:2,won:1,work:2,wtf:1,you:[1,2],your:[1,2]},titles:["Overview","Installation &amp; Configuration","User Guide"],titleterms:{annot:2,cach:1,configur:1,content:0,creation:2,css:2,custom:2,dashboard:2,defin:2,druid:1,express:2,featur:0,filter:2,get:1,guid:2,indic:0,instal:1,intro:2,overview:0,quick:2,slice:2,sql:2,start:1,tabl:[0,2],theme:2,user:2}})