forked from wonderful/docker-k8s-devops
add:file
This commit is contained in:
parent
c452c154f6
commit
1b6bef2d4d
29
README.md
29
README.md
|
|
@ -1,2 +1,29 @@
|
|||
# docker-k8s-devops
|
||||
# 慕课网Docker DevOps课程源码
|
||||
|
||||
本代码仓库会不定期进行更新。请大家关注。
|
||||
|
||||
**大家遇到问题请不要在此代码仓库里提issue，请在慕课网课程问答区提问，谢谢**
|
||||
|
||||
|
||||
大家如果发现任何错误，可以在慕课网问答区提问，或者直接在此提交merge request，提交更改。
|
||||
|
||||
## 关于翻墙
|
||||
|
||||
本课程里部分link可能需要翻墙，大家如果自己没有VPN的话，可以尝试蓝灯
|
||||
|
||||
https://github.com/getlantern/forum
|
||||
|
||||
## 本课程的一些常用链接汇总
|
||||
|
||||
Vagrant下载 https://www.vagrantup.com/downloads.html
|
||||
|
||||
Virtualbox 5.1下载 https://www.virtualbox.org/wiki/Download_Old_Builds_5_1
|
||||
|
||||
Docker国内源安装 https://get.daocloud.io/#install-docker
|
||||
|
||||
Docker官方网站 https://www.docker.com/
|
||||
|
||||
Docker官方文档中心 https://docs.docker.com/
|
||||
|
||||
DockerHub https://hub.docker.com/
|
||||
|
||||
|
|
|
|||
|
|
@ -0,0 +1,34 @@
|
|||
# -*- mode: ruby -*-
|
||||
# vi: set ft=ruby :
|
||||
|
||||
Vagrant.require_version ">= 1.6.0"
|
||||
|
||||
boxes = [
|
||||
{
|
||||
:name => "docker-host",
|
||||
:eth1 => "192.168.205.10",
|
||||
:mem => "1024",
|
||||
:cpu => "1"
|
||||
}
|
||||
]
|
||||
|
||||
Vagrant.configure(2) do |config|
|
||||
|
||||
config.vm.box = "centos/7"
|
||||
boxes.each do |opts|
|
||||
config.vm.define opts[:name] do |config|
|
||||
config.vm.hostname = opts[:name]
|
||||
config.vm.provider "vmware_fusion" do |v|
|
||||
v.vmx["memsize"] = opts[:mem]
|
||||
v.vmx["numvcpus"] = opts[:cpu]
|
||||
end
|
||||
config.vm.provider "virtualbox" do |v|
|
||||
v.customize ["modifyvm", :id, "--memory", opts[:mem]]
|
||||
v.customize ["modifyvm", :id, "--cpus", opts[:cpu]]
|
||||
end
|
||||
config.vm.network :private_network, ip: opts[:eth1]
|
||||
end
|
||||
end
|
||||
config.vm.synced_folder "./labs", "/home/vagrant/labs"
|
||||
config.vm.provision "shell", privileged: true, path: "./setup.sh"
|
||||
end
|
||||
|
|
@ -0,0 +1,3 @@
|
|||
FROM centos
|
||||
ENV name Docker
|
||||
CMD echo "hello $name"
|
||||
|
|
@ -0,0 +1,2 @@
|
|||
FROM centos
|
||||
RUN yum install -y vim
|
||||
|
|
@ -0,0 +1,3 @@
|
|||
FROM ubuntu
|
||||
RUN apt-get update && apt-get install -y python
|
||||
|
||||
|
|
@ -0,0 +1,7 @@
|
|||
FROM python:2.7
|
||||
LABEL maintainer="Peng Xiao<xiaoquwl@gmail.com>"
|
||||
RUN pip install flask
|
||||
COPY app.py /app/
|
||||
WORKDIR /app
|
||||
EXPOSE 5000
|
||||
CMD ["python", "app.py"]
|
||||
|
|
@ -0,0 +1,7 @@
|
|||
from flask import Flask
|
||||
app = Flask(__name__)
|
||||
@app.route('/')
|
||||
def hello():
|
||||
return "hello docker"
|
||||
if __name__ == '__main__':
|
||||
app.run(host="0.0.0.0", port=5000)
|
||||
|
|
@ -0,0 +1,3 @@
|
|||
FROM scratch
|
||||
ADD hello /
|
||||
CMD ["/hello"]
|
||||
Binary file not shown.
|
|
@ -0,0 +1,6 @@
|
|||
#include<stdio.h>
|
||||
|
||||
int main()
|
||||
{
|
||||
printf("hello docker\n");
|
||||
}
|
||||
|
|
@ -0,0 +1,4 @@
|
|||
FROM ubuntu
|
||||
RUN apt-get update && apt-get install -y stress
|
||||
ENTRYPOINT ["/usr/bin/stress"]
|
||||
CMD []
|
||||
|
|
@ -0,0 +1,13 @@
|
|||
#/bin/sh
|
||||
|
||||
# install some tools
|
||||
sudo yum install -y git vim gcc glibc-static telnet bridge-utils net-tools
|
||||
|
||||
# install docker
|
||||
curl -fsSL get.docker.com -o get-docker.sh
|
||||
sh get-docker.sh
|
||||
|
||||
# start docker service
|
||||
sudo systemctl start docker
|
||||
|
||||
rm -rf get-docker.sh
|
||||
|
|
@ -0,0 +1,45 @@
|
|||
# -*- mode: ruby -*-
|
||||
# vi: set ft=ruby :
|
||||
|
||||
Vagrant.require_version ">= 1.6.0"
|
||||
|
||||
boxes = [
|
||||
{
|
||||
:name => "docker-node1",
|
||||
:eth1 => "192.168.205.10",
|
||||
:mem => "1024",
|
||||
:cpu => "1"
|
||||
},
|
||||
{
|
||||
:name => "docker-node2",
|
||||
:eth1 => "192.168.205.11",
|
||||
:mem => "1024",
|
||||
:cpu => "1"
|
||||
}
|
||||
]
|
||||
|
||||
Vagrant.configure(2) do |config|
|
||||
|
||||
config.vm.box = "centos/7"
|
||||
|
||||
boxes.each do |opts|
|
||||
config.vm.define opts[:name] do |config|
|
||||
config.vm.hostname = opts[:name]
|
||||
config.vm.provider "vmware_fusion" do |v|
|
||||
v.vmx["memsize"] = opts[:mem]
|
||||
v.vmx["numvcpus"] = opts[:cpu]
|
||||
end
|
||||
|
||||
config.vm.provider "virtualbox" do |v|
|
||||
v.customize ["modifyvm", :id, "--memory", opts[:mem]]
|
||||
v.customize ["modifyvm", :id, "--cpus", opts[:cpu]]
|
||||
end
|
||||
|
||||
config.vm.network :private_network, ip: opts[:eth1]
|
||||
end
|
||||
end
|
||||
|
||||
config.vm.synced_folder "./labs", "/home/vagrant/labs"
|
||||
config.vm.provision "shell", privileged: true, path: "./setup.sh"
|
||||
|
||||
end
|
||||
|
|
@ -0,0 +1,7 @@
|
|||
FROM python:2.7
|
||||
LABEL maintaner="Peng Xiao xiaoquwl@gmail.com"
|
||||
COPY . /app
|
||||
WORKDIR /app
|
||||
RUN pip install flask redis
|
||||
EXPOSE 5000
|
||||
CMD [ "python", "app.py" ]
|
||||
|
|
@ -0,0 +1,17 @@
|
|||
from flask import Flask
|
||||
from redis import Redis
|
||||
import os
|
||||
import socket
|
||||
|
||||
app = Flask(__name__)
|
||||
redis = Redis(host=os.environ.get('REDIS_HOST', '127.0.0.1'), port=6379)
|
||||
|
||||
|
||||
@app.route('/')
|
||||
def hello():
|
||||
redis.incr('hits')
|
||||
return 'Hello Container World! I have been seen %s times and my hostname is %s.\n' % (redis.get('hits'),socket.gethostname())
|
||||
|
||||
|
||||
if __name__ == "__main__":
|
||||
app.run(host="0.0.0.0", port=5000, debug=True)
|
||||
|
|
@ -0,0 +1,152 @@
|
|||
# Mutil-host networking with etcd
|
||||
|
||||
## setup etcd cluster
|
||||
|
||||
在docker-node1上
|
||||
|
||||
```
|
||||
ubuntu@docker-node1:~$ wget https://github.com/coreos/etcd/releases/download/v3.0.12/etcd-v3.0.12-linux-amd64.tar.gz
|
||||
ubuntu@docker-node1:~$ tar zxvf etcd-v3.0.12-linux-amd64.tar.gz
|
||||
ubuntu@docker-node1:~$ cd etcd-v3.0.12-linux-amd64
|
||||
ubuntu@docker-node1:~$ nohup ./etcd --name docker-node1 --initial-advertise-peer-urls http://192.168.205.10:2380 \
|
||||
--listen-peer-urls http://192.168.205.10:2380 \
|
||||
--listen-client-urls http://192.168.205.10:2379,http://127.0.0.1:2379 \
|
||||
--advertise-client-urls http://192.168.205.10:2379 \
|
||||
--initial-cluster-token etcd-cluster \
|
||||
--initial-cluster docker-node1=http://192.168.205.10:2380,docker-node2=http://192.168.205.11:2380 \
|
||||
--initial-cluster-state new&
|
||||
```
|
||||
|
||||
|
||||
在docker-node2上
|
||||
|
||||
```
|
||||
ubuntu@docker-node2:~$ wget https://github.com/coreos/etcd/releases/download/v3.0.12/etcd-v3.0.12-linux-amd64.tar.gz
|
||||
ubuntu@docker-node2:~$ tar zxvf etcd-v3.0.12-linux-amd64.tar.gz
|
||||
ubuntu@docker-node2:~$ cd etcd-v3.0.12-linux-amd64/
|
||||
ubuntu@docker-node2:~$ nohup ./etcd --name docker-node2 --initial-advertise-peer-urls http://192.168.205.11:2380 \
|
||||
--listen-peer-urls http://192.168.205.11:2380 \
|
||||
--listen-client-urls http://192.168.205.11:2379,http://127.0.0.1:2379 \
|
||||
--advertise-client-urls http://192.168.205.11:2379 \
|
||||
--initial-cluster-token etcd-cluster \
|
||||
--initial-cluster docker-node1=http://192.168.205.10:2380,docker-node2=http://192.168.205.11:2380 \
|
||||
--initial-cluster-state new&
|
||||
```
|
||||
|
||||
检查cluster状态
|
||||
|
||||
```
|
||||
ubuntu@docker-node2:~/etcd-v3.0.12-linux-amd64$ ./etcdctl cluster-health
|
||||
member 21eca106efe4caee is healthy: got healthy result from http://192.168.205.10:2379
|
||||
member 8614974c83d1cc6d is healthy: got healthy result from http://192.168.205.11:2379
|
||||
cluster is healthy
|
||||
```
|
||||
|
||||
## 重启docker服务
|
||||
|
||||
|
||||
在docker-node1上
|
||||
|
||||
```
|
||||
$ sudo service docker stop
|
||||
$ sudo /usr/bin/dockerd -H tcp://0.0.0.0:2375 -H unix:///var/run/docker.sock --cluster-store=etcd://192.168.205.10:2379 --cluster-advertise=192.168.205.10:2375&
|
||||
```
|
||||
|
||||
在docker-node2上
|
||||
|
||||
```
|
||||
$ sudo service docker stop
|
||||
$ sudo /usr/bin/dockerd -H tcp://0.0.0.0:2375 -H unix:///var/run/docker.sock --cluster-store=etcd://192.168.205.11:2379 --cluster-advertise=192.168.205.11:2375&
|
||||
```
|
||||
|
||||
## 创建overlay network
|
||||
|
||||
在docker-node1上创建一个demo的overlay network
|
||||
|
||||
```
|
||||
ubuntu@docker-node1:~$ sudo docker network ls
|
||||
NETWORK ID NAME DRIVER SCOPE
|
||||
0e7bef3f143a bridge bridge local
|
||||
a5c7daf62325 host host local
|
||||
3198cae88ab4 none null local
|
||||
ubuntu@docker-node1:~$ sudo docker network create -d overlay demo
|
||||
3d430f3338a2c3496e9edeccc880f0a7affa06522b4249497ef6c4cd6571eaa9
|
||||
ubuntu@docker-node1:~$ sudo docker network ls
|
||||
NETWORK ID NAME DRIVER SCOPE
|
||||
0e7bef3f143a bridge bridge local
|
||||
3d430f3338a2 demo overlay global
|
||||
a5c7daf62325 host host local
|
||||
3198cae88ab4 none null local
|
||||
ubuntu@docker-node1:~$ sudo docker network inspect demo
|
||||
[
|
||||
{
|
||||
"Name": "demo",
|
||||
"Id": "3d430f3338a2c3496e9edeccc880f0a7affa06522b4249497ef6c4cd6571eaa9",
|
||||
"Scope": "global",
|
||||
"Driver": "overlay",
|
||||
"EnableIPv6": false,
|
||||
"IPAM": {
|
||||
"Driver": "default",
|
||||
"Options": {},
|
||||
"Config": [
|
||||
{
|
||||
"Subnet": "10.0.0.0/24",
|
||||
"Gateway": "10.0.0.1/24"
|
||||
}
|
||||
]
|
||||
},
|
||||
"Internal": false,
|
||||
"Containers": {},
|
||||
"Options": {},
|
||||
"Labels": {}
|
||||
}
|
||||
]
|
||||
```
|
||||
|
||||
我们会看到在node2上，这个demo的overlay network会被同步创建
|
||||
|
||||
```
|
||||
ubuntu@docker-node2:~$ sudo docker network ls
|
||||
NETWORK ID NAME DRIVER SCOPE
|
||||
c9947d4c3669 bridge bridge local
|
||||
3d430f3338a2 demo overlay global
|
||||
fa5168034de1 host host local
|
||||
c2ca34abec2a none null local
|
||||
```
|
||||
|
||||
通过查看etcd的key-value, 我们获取到，这个demo的network是通过etcd从node1同步到node2的
|
||||
|
||||
```
|
||||
ubuntu@docker-node2:~/etcd-v3.0.12-linux-amd64$ ./etcdctl ls /docker
|
||||
/docker/network
|
||||
/docker/nodes
|
||||
ubuntu@docker-node2:~/etcd-v3.0.12-linux-amd64$ ./etcdctl ls /docker/nodes
|
||||
/docker/nodes/192.168.205.11:2375
|
||||
/docker/nodes/192.168.205.10:2375
|
||||
ubuntu@docker-node2:~/etcd-v3.0.12-linux-amd64$ ./etcdctl ls /docker/network/v1.0/network
|
||||
/docker/network/v1.0/network/3d430f3338a2c3496e9edeccc880f0a7affa06522b4249497ef6c4cd6571eaa9
|
||||
ubuntu@docker-node2:~/etcd-v3.0.12-linux-amd64$ ./etcdctl get /docker/network/v1.0/network/3d430f3338a2c3496e9edeccc880f0a7affa06522b4249497ef6c4cd6571eaa9 | jq .
|
||||
{
|
||||
"addrSpace": "GlobalDefault",
|
||||
"enableIPv6": false,
|
||||
"generic": {
|
||||
"com.docker.network.enable_ipv6": false,
|
||||
"com.docker.network.generic": {}
|
||||
},
|
||||
"id": "3d430f3338a2c3496e9edeccc880f0a7affa06522b4249497ef6c4cd6571eaa9",
|
||||
"inDelete": false,
|
||||
"ingress": false,
|
||||
"internal": false,
|
||||
"ipamOptions": {},
|
||||
"ipamType": "default",
|
||||
"ipamV4Config": "[{\"PreferredPool\":\"\",\"SubPool\":\"\",\"Gateway\":\"\",\"AuxAddresses\":null}]",
|
||||
"ipamV4Info": "[{\"IPAMData\":\"{\\\"AddressSpace\\\":\\\"GlobalDefault\\\",\\\"Gateway\\\":\\\"10.0.0.1/24\\\",\\\"Pool\\\":\\\"10.0.0.0/24\\\"}\",\"PoolID\":\"GlobalDefault/10.0.0.0/24\"}]",
|
||||
"labels": {},
|
||||
"name": "demo",
|
||||
"networkType": "overlay",
|
||||
"persist": true,
|
||||
"postIPv6": false,
|
||||
"scope": "global"
|
||||
}
|
||||
```
|
||||
|
||||
|
|
@ -0,0 +1,12 @@
|
|||
# this same shows how we can extend/change an existing official image from Docker Hub
|
||||
|
||||
FROM nginx:latest
|
||||
# highly recommend you always pin versions for anything beyond dev/learn
|
||||
|
||||
WORKDIR /usr/share/nginx/html
|
||||
# change working directory to root of nginx webhost
|
||||
# using WORKDIR is prefered to using 'RUN cd /some/path'
|
||||
|
||||
COPY index.html index.html
|
||||
|
||||
# I don't have to specify EXPOSE or CMD because they're in my FROM
|
||||
|
|
@ -0,0 +1,13 @@
|
|||
<!doctype html>
|
||||
<html lang="en">
|
||||
<head>
|
||||
<meta charset="utf-8">
|
||||
|
||||
<title>hello</title>
|
||||
|
||||
</head>
|
||||
|
||||
<body>
|
||||
<h1>Hello Docker! </h1>
|
||||
</body>
|
||||
</html>
|
||||
|
|
@ -0,0 +1,8 @@
|
|||
FROM python:2.7-alpine
|
||||
LABEL maintainer="Peng Xiao<xiaoquwl@gmail.com>"
|
||||
RUN pip install flask Flask-Script
|
||||
COPY . /app/
|
||||
WORKDIR /app
|
||||
EXPOSE 5000
|
||||
ENTRYPOINT [ "python", "manage.py" ]
|
||||
CMD []
|
||||
|
|
@ -0,0 +1,12 @@
|
|||
from flask import Flask
|
||||
app = Flask(__name__)
|
||||
@app.route('/')
|
||||
def hello():
|
||||
return "hello dockeddr"
|
||||
|
||||
from flask_script import Manager
|
||||
|
||||
manager = Manager(app)
|
||||
|
||||
if __name__ == '__main__':
|
||||
manager.run()
|
||||
|
|
@ -0,0 +1,16 @@
|
|||
[run]
|
||||
source = skeleton
|
||||
omit =
|
||||
skeleton/tests/*
|
||||
*/__init__.py
|
||||
|
||||
[report]
|
||||
exclude_lines =
|
||||
def __repr__
|
||||
def __str__
|
||||
def parse_args
|
||||
pragma: no cover
|
||||
raise NotImplementedError
|
||||
if __name__ == .__main__.:
|
||||
|
||||
ignore_errors = True
|
||||
|
|
@ -0,0 +1,91 @@
|
|||
# Byte-compiled / optimized / DLL files
|
||||
__pycache__/
|
||||
*.py[cod]
|
||||
*$py.class
|
||||
|
||||
# C extensions
|
||||
*.so
|
||||
|
||||
# Distribution / packaging
|
||||
.Python
|
||||
env/
|
||||
build/
|
||||
develop-eggs/
|
||||
dist/
|
||||
downloads/
|
||||
eggs/
|
||||
.eggs/
|
||||
lib/
|
||||
lib64/
|
||||
parts/
|
||||
sdist/
|
||||
var/
|
||||
*.egg-info/
|
||||
.installed.cfg
|
||||
*.egg
|
||||
|
||||
# PyInstaller
|
||||
# Usually these files are written by a python script from a template
|
||||
# before PyInstaller builds the exe, so as to inject date/other infos into it.
|
||||
*.manifest
|
||||
*.spec
|
||||
|
||||
# Installer logs
|
||||
pip-log.txt
|
||||
pip-delete-this-directory.txt
|
||||
|
||||
# Unit test / coverage reports
|
||||
htmlcov/
|
||||
.tox/
|
||||
.coverage
|
||||
.coverage.*
|
||||
.cache
|
||||
nosetests.xml
|
||||
coverage.xml
|
||||
*,cover
|
||||
.hypothesis/
|
||||
|
||||
# Translations
|
||||
*.mo
|
||||
*.pot
|
||||
|
||||
# Django stuff:
|
||||
*.log
|
||||
local_settings.py
|
||||
|
||||
# Flask stuff:
|
||||
instance/
|
||||
.webassets-cache
|
||||
|
||||
# Scrapy stuff:
|
||||
.scrapy
|
||||
|
||||
# Sphinx documentation
|
||||
docs/_build/
|
||||
|
||||
# PyBuilder
|
||||
target/
|
||||
|
||||
# IPython Notebook
|
||||
.ipynb_checkpoints
|
||||
|
||||
# pyenv
|
||||
.python-version
|
||||
|
||||
# celery beat schedule file
|
||||
celerybeat-schedule
|
||||
|
||||
# dotenv
|
||||
.env
|
||||
|
||||
# virtualenv
|
||||
venv/
|
||||
ENV/
|
||||
|
||||
# Spyder project settings
|
||||
.spyderproject
|
||||
|
||||
# Rope project settings
|
||||
.ropeproject
|
||||
|
||||
*.sqlite
|
||||
|
|
@ -0,0 +1,62 @@
|
|||
variables:
|
||||
GIT_SSL_NO_VERIFY: "1"
|
||||
|
||||
stages:
|
||||
- test
|
||||
- build
|
||||
- deploy
|
||||
|
||||
pep8:
|
||||
stage: test
|
||||
image: python:2.7
|
||||
script:
|
||||
- pip install tox
|
||||
- tox -e pep8
|
||||
tags:
|
||||
- python27
|
||||
|
||||
unittest-py27:
|
||||
stage: test
|
||||
image: python:2.7
|
||||
script:
|
||||
- pip install tox
|
||||
- tox -e py27
|
||||
tags:
|
||||
- python27
|
||||
|
||||
unittest-py34:
|
||||
stage: test
|
||||
image: python:3.4
|
||||
script:
|
||||
- pip install tox
|
||||
- tox -e py34
|
||||
tags:
|
||||
- python34
|
||||
|
||||
sphnix:
|
||||
stage: test
|
||||
image: python:2.7
|
||||
script:
|
||||
- pip install tox
|
||||
- tox -e docs
|
||||
tags:
|
||||
- python27
|
||||
|
||||
build:
|
||||
stage: build
|
||||
tags:
|
||||
- shell
|
||||
script:
|
||||
- docker build -t skeleton .
|
||||
only:
|
||||
- master
|
||||
|
||||
deploy:
|
||||
stage: deploy
|
||||
tags:
|
||||
- shell
|
||||
script:
|
||||
- scripts/deploy.sh
|
||||
- export
|
||||
only:
|
||||
- master
|
||||
|
|
@ -0,0 +1,28 @@
|
|||
### Summary
|
||||
|
||||
(Summarize the bug encountered concisely)
|
||||
|
||||
### Steps to reproduce
|
||||
|
||||
(How one can reproduce the issue - this is very important)
|
||||
|
||||
### Expected behavior
|
||||
|
||||
(What you should see instead)
|
||||
|
||||
### Actual behaviour
|
||||
|
||||
(What actually happens)
|
||||
|
||||
### Relevant logs and/or screenshots
|
||||
|
||||
(Paste any relevant logs - please use code blocks (```) to format console output,
|
||||
logs, and code as it's very hard to read otherwise.)
|
||||
|
||||
|
||||
### Possible fixes
|
||||
|
||||
(If you can, link to the line of code that might be responsible for the problem)
|
||||
|
||||
|
||||
/label ~"Bug"
|
||||
|
|
@ -0,0 +1,7 @@
|
|||
### Feature Description
|
||||
|
||||
|
||||
### Implementation
|
||||
|
||||
|
||||
/label ~"Feature"
|
||||
|
|
@ -0,0 +1,15 @@
|
|||
**1. Explain what do you want to merge**
|
||||
|
||||
-
|
||||
-
|
||||
|
||||
**2. Does this MR meet the acceptance criteria?**
|
||||
|
||||
- [ ] I have read [Contribution guidelines](https://as-gitlab.cisco.com/demo/skeleton/blob/master/CONTRIBUTING.md)
|
||||
- [ ] I have run the command `tox` locally and get successful results.
|
||||
- [ ] Branch has no merge conflicts with master (if you do - rebase it please)
|
||||
|
||||
**3. What are the relevant issue numbers?**
|
||||
|
||||
|
||||
Thanks for your MR, you're awesome! :+1:
|
||||
|
|
@ -0,0 +1,18 @@
|
|||
# Hacking Guide
|
||||
|
||||
## Code style
|
||||
|
||||
Step 1: Read http://www.python.org/dev/peps/pep-0008/
|
||||
|
||||
Step 2: Read http://www.python.org/dev/peps/pep-0008/ again
|
||||
|
||||
Step 3: Read on
|
||||
|
||||
## Running Tests
|
||||
|
||||
Run tox
|
||||
|
||||
```
|
||||
$ cd skeleton
|
||||
$ tox
|
||||
```
|
||||
|
|
@ -0,0 +1,8 @@
|
|||
FROM python:2.7
|
||||
LABEL maintainer="Peng Xiao<xiaoquwl@gmail.com>"
|
||||
|
||||
COPY . /skeleton
|
||||
WORKDIR /skeleton
|
||||
RUN pip install -r requirements.txt
|
||||
EXPOSE 5000
|
||||
ENTRYPOINT ["scripts/dev.sh"]
|
||||
|
|
@ -0,0 +1,8 @@
|
|||
The MIT License (MIT)
|
||||
Copyright (c) 2016 Michael Herman
|
||||
|
||||
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
|
||||
|
||||
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
|
||||
|
||||
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
|
||||
|
|
@ -0,0 +1,58 @@
|
|||
[](https://gitlab-demo.com/Demo/flask-skeleton/commits/master)
|
||||
[](https://gitlab-demo.com/Demo/flask-skeleton/commits/master)
|
||||
|
||||
|
||||
# Flask Skeleton
|
||||
|
||||
Flask starter project...
|
||||
|
||||
## Quick Start
|
||||
|
||||
### Basics
|
||||
|
||||
1. Activate a virtualenv
|
||||
1. Install the requirements
|
||||
|
||||
### Set Environment Variables
|
||||
|
||||
Update *skeleton/server/config.py*, and then run:
|
||||
|
||||
```sh
|
||||
$ export APP_SETTINGS="skeleton.server.config.DevelopmentConfig"
|
||||
```
|
||||
|
||||
or
|
||||
|
||||
```sh
|
||||
$ export APP_SETTINGS="skeleton.server.config.ProductionConfig"
|
||||
```
|
||||
|
||||
### Create DB
|
||||
|
||||
```sh
|
||||
$ python manage.py create_db
|
||||
$ python manage.py db init
|
||||
$ python manage.py db migrate
|
||||
$ python manage.py create_admin
|
||||
$ python manage.py create_data
|
||||
```
|
||||
|
||||
### Run the Application
|
||||
|
||||
```sh
|
||||
$ python manage.py runserver
|
||||
```
|
||||
|
||||
So access the application at the address [http://localhost:5000/](http://localhost:5000/)
|
||||
|
||||
> Want to specify a different port?
|
||||
|
||||
> ```sh
|
||||
> $ python manage.py runserver -h 0.0.0.0 -p 8080
|
||||
> ```
|
||||
|
||||
### Testing1
|
||||
|
||||
```
|
||||
$ tox
|
||||
```
|
||||
|
|
@ -0,0 +1,225 @@
|
|||
# Makefile for Sphinx documentation
|
||||
#
|
||||
|
||||
# You can set these variables from the command line.
|
||||
SPHINXOPTS =
|
||||
SPHINXBUILD = sphinx-build
|
||||
PAPER =
|
||||
BUILDDIR = build
|
||||
|
||||
# Internal variables.
|
||||
PAPEROPT_a4 = -D latex_paper_size=a4
|
||||
PAPEROPT_letter = -D latex_paper_size=letter
|
||||
ALLSPHINXOPTS = -d $(BUILDDIR)/doctrees $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) source
|
||||
# the i18n builder cannot share the environment and doctrees with the others
|
||||
I18NSPHINXOPTS = $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) source
|
||||
|
||||
.PHONY: help
|
||||
help:
|
||||
@echo "Please use \`make <target>' where <target> is one of"
|
||||
@echo " html to make standalone HTML files"
|
||||
@echo " dirhtml to make HTML files named index.html in directories"
|
||||
@echo " singlehtml to make a single large HTML file"
|
||||
@echo " pickle to make pickle files"
|
||||
@echo " json to make JSON files"
|
||||
@echo " htmlhelp to make HTML files and a HTML help project"
|
||||
@echo " qthelp to make HTML files and a qthelp project"
|
||||
@echo " applehelp to make an Apple Help Book"
|
||||
@echo " devhelp to make HTML files and a Devhelp project"
|
||||
@echo " epub to make an epub"
|
||||
@echo " epub3 to make an epub3"
|
||||
@echo " latex to make LaTeX files, you can set PAPER=a4 or PAPER=letter"
|
||||
@echo " latexpdf to make LaTeX files and run them through pdflatex"
|
||||
@echo " latexpdfja to make LaTeX files and run them through platex/dvipdfmx"
|
||||
@echo " text to make text files"
|
||||
@echo " man to make manual pages"
|
||||
@echo " texinfo to make Texinfo files"
|
||||
@echo " info to make Texinfo files and run them through makeinfo"
|
||||
@echo " gettext to make PO message catalogs"
|
||||
@echo " changes to make an overview of all changed/added/deprecated items"
|
||||
@echo " xml to make Docutils-native XML files"
|
||||
@echo " pseudoxml to make pseudoxml-XML files for display purposes"
|
||||
@echo " linkcheck to check all external links for integrity"
|
||||
@echo " doctest to run all doctests embedded in the documentation (if enabled)"
|
||||
@echo " coverage to run coverage check of the documentation (if enabled)"
|
||||
@echo " dummy to check syntax errors of document sources"
|
||||
|
||||
.PHONY: clean
|
||||
clean:
|
||||
rm -rf $(BUILDDIR)/*
|
||||
|
||||
.PHONY: html
|
||||
html:
|
||||
$(SPHINXBUILD) -b html $(ALLSPHINXOPTS) $(BUILDDIR)/html
|
||||
@echo
|
||||
@echo "Build finished. The HTML pages are in $(BUILDDIR)/html."
|
||||
|
||||
.PHONY: dirhtml
|
||||
dirhtml:
|
||||
$(SPHINXBUILD) -b dirhtml $(ALLSPHINXOPTS) $(BUILDDIR)/dirhtml
|
||||
@echo
|
||||
@echo "Build finished. The HTML pages are in $(BUILDDIR)/dirhtml."
|
||||
|
||||
.PHONY: singlehtml
|
||||
singlehtml:
|
||||
$(SPHINXBUILD) -b singlehtml $(ALLSPHINXOPTS) $(BUILDDIR)/singlehtml
|
||||
@echo
|
||||
@echo "Build finished. The HTML page is in $(BUILDDIR)/singlehtml."
|
||||
|
||||
.PHONY: pickle
|
||||
pickle:
|
||||
$(SPHINXBUILD) -b pickle $(ALLSPHINXOPTS) $(BUILDDIR)/pickle
|
||||
@echo
|
||||
@echo "Build finished; now you can process the pickle files."
|
||||
|
||||
.PHONY: json
|
||||
json:
|
||||
$(SPHINXBUILD) -b json $(ALLSPHINXOPTS) $(BUILDDIR)/json
|
||||
@echo
|
||||
@echo "Build finished; now you can process the JSON files."
|
||||
|
||||
.PHONY: htmlhelp
|
||||
htmlhelp:
|
||||
$(SPHINXBUILD) -b htmlhelp $(ALLSPHINXOPTS) $(BUILDDIR)/htmlhelp
|
||||
@echo
|
||||
@echo "Build finished; now you can run HTML Help Workshop with the" \
|
||||
".hhp project file in $(BUILDDIR)/htmlhelp."
|
||||
|
||||
.PHONY: qthelp
|
||||
qthelp:
|
||||
$(SPHINXBUILD) -b qthelp $(ALLSPHINXOPTS) $(BUILDDIR)/qthelp
|
||||
@echo
|
||||
@echo "Build finished; now you can run "qcollectiongenerator" with the" \
|
||||
".qhcp project file in $(BUILDDIR)/qthelp, like this:"
|
||||
@echo "# qcollectiongenerator $(BUILDDIR)/qthelp/yacore.qhcp"
|
||||
@echo "To view the help file:"
|
||||
@echo "# assistant -collectionFile $(BUILDDIR)/qthelp/yacore.qhc"
|
||||
|
||||
.PHONY: applehelp
|
||||
applehelp:
|
||||
$(SPHINXBUILD) -b applehelp $(ALLSPHINXOPTS) $(BUILDDIR)/applehelp
|
||||
@echo
|
||||
@echo "Build finished. The help book is in $(BUILDDIR)/applehelp."
|
||||
@echo "N.B. You won't be able to view it unless you put it in" \
|
||||
"~/Library/Documentation/Help or install it in your application" \
|
||||
"bundle."
|
||||
|
||||
.PHONY: devhelp
|
||||
devhelp:
|
||||
$(SPHINXBUILD) -b devhelp $(ALLSPHINXOPTS) $(BUILDDIR)/devhelp
|
||||
@echo
|
||||
@echo "Build finished."
|
||||
@echo "To view the help file:"
|
||||
@echo "# mkdir -p $$HOME/.local/share/devhelp/yacore"
|
||||
@echo "# ln -s $(BUILDDIR)/devhelp $$HOME/.local/share/devhelp/yacore"
|
||||
@echo "# devhelp"
|
||||
|
||||
.PHONY: epub
|
||||
epub:
|
||||
$(SPHINXBUILD) -b epub $(ALLSPHINXOPTS) $(BUILDDIR)/epub
|
||||
@echo
|
||||
@echo "Build finished. The epub file is in $(BUILDDIR)/epub."
|
||||
|
||||
.PHONY: epub3
|
||||
epub3:
|
||||
$(SPHINXBUILD) -b epub3 $(ALLSPHINXOPTS) $(BUILDDIR)/epub3
|
||||
@echo
|
||||
@echo "Build finished. The epub3 file is in $(BUILDDIR)/epub3."
|
||||
|
||||
.PHONY: latex
|
||||
latex:
|
||||
$(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
|
||||
@echo
|
||||
@echo "Build finished; the LaTeX files are in $(BUILDDIR)/latex."
|
||||
@echo "Run \`make' in that directory to run these through (pdf)latex" \
|
||||
"(use \`make latexpdf' here to do that automatically)."
|
||||
|
||||
.PHONY: latexpdf
|
||||
latexpdf:
|
||||
$(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
|
||||
@echo "Running LaTeX files through pdflatex..."
|
||||
$(MAKE) -C $(BUILDDIR)/latex all-pdf
|
||||
@echo "pdflatex finished; the PDF files are in $(BUILDDIR)/latex."
|
||||
|
||||
.PHONY: latexpdfja
|
||||
latexpdfja:
|
||||
$(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
|
||||
@echo "Running LaTeX files through platex and dvipdfmx..."
|
||||
$(MAKE) -C $(BUILDDIR)/latex all-pdf-ja
|
||||
@echo "pdflatex finished; the PDF files are in $(BUILDDIR)/latex."
|
||||
|
||||
.PHONY: text
|
||||
text:
|
||||
$(SPHINXBUILD) -b text $(ALLSPHINXOPTS) $(BUILDDIR)/text
|
||||
@echo
|
||||
@echo "Build finished. The text files are in $(BUILDDIR)/text."
|
||||
|
||||
.PHONY: man
|
||||
man:
|
||||
$(SPHINXBUILD) -b man $(ALLSPHINXOPTS) $(BUILDDIR)/man
|
||||
@echo
|
||||
@echo "Build finished. The manual pages are in $(BUILDDIR)/man."
|
||||
|
||||
.PHONY: texinfo
|
||||
texinfo:
|
||||
$(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo
|
||||
@echo
|
||||
@echo "Build finished. The Texinfo files are in $(BUILDDIR)/texinfo."
|
||||
@echo "Run \`make' in that directory to run these through makeinfo" \
|
||||
"(use \`make info' here to do that automatically)."
|
||||
|
||||
.PHONY: info
|
||||
info:
|
||||
$(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo
|
||||
@echo "Running Texinfo files through makeinfo..."
|
||||
make -C $(BUILDDIR)/texinfo info
|
||||
@echo "makeinfo finished; the Info files are in $(BUILDDIR)/texinfo."
|
||||
|
||||
.PHONY: gettext
|
||||
gettext:
|
||||
$(SPHINXBUILD) -b gettext $(I18NSPHINXOPTS) $(BUILDDIR)/locale
|
||||
@echo
|
||||
@echo "Build finished. The message catalogs are in $(BUILDDIR)/locale."
|
||||
|
||||
.PHONY: changes
|
||||
changes:
|
||||
$(SPHINXBUILD) -b changes $(ALLSPHINXOPTS) $(BUILDDIR)/changes
|
||||
@echo
|
||||
@echo "The overview file is in $(BUILDDIR)/changes."
|
||||
|
||||
.PHONY: linkcheck
|
||||
linkcheck:
|
||||
$(SPHINXBUILD) -b linkcheck $(ALLSPHINXOPTS) $(BUILDDIR)/linkcheck
|
||||
@echo
|
||||
@echo "Link check complete; look for any errors in the above output " \
|
||||
"or in $(BUILDDIR)/linkcheck/output.txt."
|
||||
|
||||
.PHONY: doctest
|
||||
doctest:
|
||||
$(SPHINXBUILD) -b doctest $(ALLSPHINXOPTS) $(BUILDDIR)/doctest
|
||||
@echo "Testing of doctests in the sources finished, look at the " \
|
||||
"results in $(BUILDDIR)/doctest/output.txt."
|
||||
|
||||
.PHONY: coverage
|
||||
coverage:
|
||||
$(SPHINXBUILD) -b coverage $(ALLSPHINXOPTS) $(BUILDDIR)/coverage
|
||||
@echo "Testing of coverage in the sources finished, look at the " \
|
||||
"results in $(BUILDDIR)/coverage/python.txt."
|
||||
|
||||
.PHONY: xml
|
||||
xml:
|
||||
$(SPHINXBUILD) -b xml $(ALLSPHINXOPTS) $(BUILDDIR)/xml
|
||||
@echo
|
||||
@echo "Build finished. The XML files are in $(BUILDDIR)/xml."
|
||||
|
||||
.PHONY: pseudoxml
|
||||
pseudoxml:
|
||||
$(SPHINXBUILD) -b pseudoxml $(ALLSPHINXOPTS) $(BUILDDIR)/pseudoxml
|
||||
@echo
|
||||
@echo "Build finished. The pseudo-XML files are in $(BUILDDIR)/pseudoxml."
|
||||
|
||||
.PHONY: dummy
|
||||
dummy:
|
||||
$(SPHINXBUILD) -b dummy $(ALLSPHINXOPTS) $(BUILDDIR)/dummy
|
||||
@echo
|
||||
@echo "Build finished. Dummy builder generates no files."
|
||||
|
|
@ -0,0 +1,281 @@
|
|||
@ECHO OFF
|
||||
|
||||
REM Command file for Sphinx documentation
|
||||
|
||||
if "%SPHINXBUILD%" == "" (
|
||||
set SPHINXBUILD=sphinx-build
|
||||
)
|
||||
set BUILDDIR=build
|
||||
set ALLSPHINXOPTS=-d %BUILDDIR%/doctrees %SPHINXOPTS% source
|
||||
set I18NSPHINXOPTS=%SPHINXOPTS% source
|
||||
if NOT "%PAPER%" == "" (
|
||||
set ALLSPHINXOPTS=-D latex_paper_size=%PAPER% %ALLSPHINXOPTS%
|
||||
set I18NSPHINXOPTS=-D latex_paper_size=%PAPER% %I18NSPHINXOPTS%
|
||||
)
|
||||
|
||||
if "%1" == "" goto help
|
||||
|
||||
if "%1" == "help" (
|
||||
:help
|
||||
echo.Please use `make ^<target^>` where ^<target^> is one of
|
||||
echo. html to make standalone HTML files
|
||||
echo. dirhtml to make HTML files named index.html in directories
|
||||
echo. singlehtml to make a single large HTML file
|
||||
echo. pickle to make pickle files
|
||||
echo. json to make JSON files
|
||||
echo. htmlhelp to make HTML files and a HTML help project
|
||||
echo. qthelp to make HTML files and a qthelp project
|
||||
echo. devhelp to make HTML files and a Devhelp project
|
||||
echo. epub to make an epub
|
||||
echo. epub3 to make an epub3
|
||||
echo. latex to make LaTeX files, you can set PAPER=a4 or PAPER=letter
|
||||
echo. text to make text files
|
||||
echo. man to make manual pages
|
||||
echo. texinfo to make Texinfo files
|
||||
echo. gettext to make PO message catalogs
|
||||
echo. changes to make an overview over all changed/added/deprecated items
|
||||
echo. xml to make Docutils-native XML files
|
||||
echo. pseudoxml to make pseudoxml-XML files for display purposes
|
||||
echo. linkcheck to check all external links for integrity
|
||||
echo. doctest to run all doctests embedded in the documentation if enabled
|
||||
echo. coverage to run coverage check of the documentation if enabled
|
||||
echo. dummy to check syntax errors of document sources
|
||||
goto end
|
||||
)
|
||||
|
||||
if "%1" == "clean" (
|
||||
for /d %%i in (%BUILDDIR%\*) do rmdir /q /s %%i
|
||||
del /q /s %BUILDDIR%\*
|
||||
goto end
|
||||
)
|
||||
|
||||
|
||||
REM Check if sphinx-build is available and fallback to Python version if any
|
||||
%SPHINXBUILD% 1>NUL 2>NUL
|
||||
if errorlevel 9009 goto sphinx_python
|
||||
goto sphinx_ok
|
||||
|
||||
:sphinx_python
|
||||
|
||||
set SPHINXBUILD=python -m sphinx.__init__
|
||||
%SPHINXBUILD% 2> nul
|
||||
if errorlevel 9009 (
|
||||
echo.
|
||||
echo.The 'sphinx-build' command was not found. Make sure you have Sphinx
|
||||
echo.installed, then set the SPHINXBUILD environment variable to point
|
||||
echo.to the full path of the 'sphinx-build' executable. Alternatively you
|
||||
echo.may add the Sphinx directory to PATH.
|
||||
echo.
|
||||
echo.If you don't have Sphinx installed, grab it from
|
||||
echo.http://sphinx-doc.org/
|
||||
exit /b 1
|
||||
)
|
||||
|
||||
:sphinx_ok
|
||||
|
||||
|
||||
if "%1" == "html" (
|
||||
%SPHINXBUILD% -b html %ALLSPHINXOPTS% %BUILDDIR%/html
|
||||
if errorlevel 1 exit /b 1
|
||||
echo.
|
||||
echo.Build finished. The HTML pages are in %BUILDDIR%/html.
|
||||
goto end
|
||||
)
|
||||
|
||||
if "%1" == "dirhtml" (
|
||||
%SPHINXBUILD% -b dirhtml %ALLSPHINXOPTS% %BUILDDIR%/dirhtml
|
||||
if errorlevel 1 exit /b 1
|
||||
echo.
|
||||
echo.Build finished. The HTML pages are in %BUILDDIR%/dirhtml.
|
||||
goto end
|
||||
)
|
||||
|
||||
if "%1" == "singlehtml" (
|
||||
%SPHINXBUILD% -b singlehtml %ALLSPHINXOPTS% %BUILDDIR%/singlehtml
|
||||
if errorlevel 1 exit /b 1
|
||||
echo.
|
||||
echo.Build finished. The HTML pages are in %BUILDDIR%/singlehtml.
|
||||
goto end
|
||||
)
|
||||
|
||||
if "%1" == "pickle" (
|
||||
%SPHINXBUILD% -b pickle %ALLSPHINXOPTS% %BUILDDIR%/pickle
|
||||
if errorlevel 1 exit /b 1
|
||||
echo.
|
||||
echo.Build finished; now you can process the pickle files.
|
||||
goto end
|
||||
)
|
||||
|
||||
if "%1" == "json" (
|
||||
%SPHINXBUILD% -b json %ALLSPHINXOPTS% %BUILDDIR%/json
|
||||
if errorlevel 1 exit /b 1
|
||||
echo.
|
||||
echo.Build finished; now you can process the JSON files.
|
||||
goto end
|
||||
)
|
||||
|
||||
if "%1" == "htmlhelp" (
|
||||
%SPHINXBUILD% -b htmlhelp %ALLSPHINXOPTS% %BUILDDIR%/htmlhelp
|
||||
if errorlevel 1 exit /b 1
|
||||
echo.
|
||||
echo.Build finished; now you can run HTML Help Workshop with the ^
|
||||
.hhp project file in %BUILDDIR%/htmlhelp.
|
||||
goto end
|
||||
)
|
||||
|
||||
if "%1" == "qthelp" (
|
||||
%SPHINXBUILD% -b qthelp %ALLSPHINXOPTS% %BUILDDIR%/qthelp
|
||||
if errorlevel 1 exit /b 1
|
||||
echo.
|
||||
echo.Build finished; now you can run "qcollectiongenerator" with the ^
|
||||
.qhcp project file in %BUILDDIR%/qthelp, like this:
|
||||
echo.^> qcollectiongenerator %BUILDDIR%\qthelp\yacore.qhcp
|
||||
echo.To view the help file:
|
||||
echo.^> assistant -collectionFile %BUILDDIR%\qthelp\yacore.ghc
|
||||
goto end
|
||||
)
|
||||
|
||||
if "%1" == "devhelp" (
|
||||
%SPHINXBUILD% -b devhelp %ALLSPHINXOPTS% %BUILDDIR%/devhelp
|
||||
if errorlevel 1 exit /b 1
|
||||
echo.
|
||||
echo.Build finished.
|
||||
goto end
|
||||
)
|
||||
|
||||
if "%1" == "epub" (
|
||||
%SPHINXBUILD% -b epub %ALLSPHINXOPTS% %BUILDDIR%/epub
|
||||
if errorlevel 1 exit /b 1
|
||||
echo.
|
||||
echo.Build finished. The epub file is in %BUILDDIR%/epub.
|
||||
goto end
|
||||
)
|
||||
|
||||
if "%1" == "epub3" (
|
||||
%SPHINXBUILD% -b epub3 %ALLSPHINXOPTS% %BUILDDIR%/epub3
|
||||
if errorlevel 1 exit /b 1
|
||||
echo.
|
||||
echo.Build finished. The epub3 file is in %BUILDDIR%/epub3.
|
||||
goto end
|
||||
)
|
||||
|
||||
if "%1" == "latex" (
|
||||
%SPHINXBUILD% -b latex %ALLSPHINXOPTS% %BUILDDIR%/latex
|
||||
if errorlevel 1 exit /b 1
|
||||
echo.
|
||||
echo.Build finished; the LaTeX files are in %BUILDDIR%/latex.
|
||||
goto end
|
||||
)
|
||||
|
||||
if "%1" == "latexpdf" (
|
||||
%SPHINXBUILD% -b latex %ALLSPHINXOPTS% %BUILDDIR%/latex
|
||||
cd %BUILDDIR%/latex
|
||||
make all-pdf
|
||||
cd %~dp0
|
||||
echo.
|
||||
echo.Build finished; the PDF files are in %BUILDDIR%/latex.
|
||||
goto end
|
||||
)
|
||||
|
||||
if "%1" == "latexpdfja" (
|
||||
%SPHINXBUILD% -b latex %ALLSPHINXOPTS% %BUILDDIR%/latex
|
||||
cd %BUILDDIR%/latex
|
||||
make all-pdf-ja
|
||||
cd %~dp0
|
||||
echo.
|
||||
echo.Build finished; the PDF files are in %BUILDDIR%/latex.
|
||||
goto end
|
||||
)
|
||||
|
||||
if "%1" == "text" (
|
||||
%SPHINXBUILD% -b text %ALLSPHINXOPTS% %BUILDDIR%/text
|
||||
if errorlevel 1 exit /b 1
|
||||
echo.
|
||||
echo.Build finished. The text files are in %BUILDDIR%/text.
|
||||
goto end
|
||||
)
|
||||
|
||||
if "%1" == "man" (
|
||||
%SPHINXBUILD% -b man %ALLSPHINXOPTS% %BUILDDIR%/man
|
||||
if errorlevel 1 exit /b 1
|
||||
echo.
|
||||
echo.Build finished. The manual pages are in %BUILDDIR%/man.
|
||||
goto end
|
||||
)
|
||||
|
||||
if "%1" == "texinfo" (
|
||||
%SPHINXBUILD% -b texinfo %ALLSPHINXOPTS% %BUILDDIR%/texinfo
|
||||
if errorlevel 1 exit /b 1
|
||||
echo.
|
||||
echo.Build finished. The Texinfo files are in %BUILDDIR%/texinfo.
|
||||
goto end
|
||||
)
|
||||
|
||||
if "%1" == "gettext" (
|
||||
%SPHINXBUILD% -b gettext %I18NSPHINXOPTS% %BUILDDIR%/locale
|
||||
if errorlevel 1 exit /b 1
|
||||
echo.
|
||||
echo.Build finished. The message catalogs are in %BUILDDIR%/locale.
|
||||
goto end
|
||||
)
|
||||
|
||||
if "%1" == "changes" (
|
||||
%SPHINXBUILD% -b changes %ALLSPHINXOPTS% %BUILDDIR%/changes
|
||||
if errorlevel 1 exit /b 1
|
||||
echo.
|
||||
echo.The overview file is in %BUILDDIR%/changes.
|
||||
goto end
|
||||
)
|
||||
|
||||
if "%1" == "linkcheck" (
|
||||
%SPHINXBUILD% -b linkcheck %ALLSPHINXOPTS% %BUILDDIR%/linkcheck
|
||||
if errorlevel 1 exit /b 1
|
||||
echo.
|
||||
echo.Link check complete; look for any errors in the above output ^
|
||||
or in %BUILDDIR%/linkcheck/output.txt.
|
||||
goto end
|
||||
)
|
||||
|
||||
if "%1" == "doctest" (
|
||||
%SPHINXBUILD% -b doctest %ALLSPHINXOPTS% %BUILDDIR%/doctest
|
||||
if errorlevel 1 exit /b 1
|
||||
echo.
|
||||
echo.Testing of doctests in the sources finished, look at the ^
|
||||
results in %BUILDDIR%/doctest/output.txt.
|
||||
goto end
|
||||
)
|
||||
|
||||
if "%1" == "coverage" (
|
||||
%SPHINXBUILD% -b coverage %ALLSPHINXOPTS% %BUILDDIR%/coverage
|
||||
if errorlevel 1 exit /b 1
|
||||
echo.
|
||||
echo.Testing of coverage in the sources finished, look at the ^
|
||||
results in %BUILDDIR%/coverage/python.txt.
|
||||
goto end
|
||||
)
|
||||
|
||||
if "%1" == "xml" (
|
||||
%SPHINXBUILD% -b xml %ALLSPHINXOPTS% %BUILDDIR%/xml
|
||||
if errorlevel 1 exit /b 1
|
||||
echo.
|
||||
echo.Build finished. The XML files are in %BUILDDIR%/xml.
|
||||
goto end
|
||||
)
|
||||
|
||||
if "%1" == "pseudoxml" (
|
||||
%SPHINXBUILD% -b pseudoxml %ALLSPHINXOPTS% %BUILDDIR%/pseudoxml
|
||||
if errorlevel 1 exit /b 1
|
||||
echo.
|
||||
echo.Build finished. The pseudo-XML files are in %BUILDDIR%/pseudoxml.
|
||||
goto end
|
||||
)
|
||||
|
||||
if "%1" == "dummy" (
|
||||
%SPHINXBUILD% -b dummy %ALLSPHINXOPTS% %BUILDDIR%/dummy
|
||||
if errorlevel 1 exit /b 1
|
||||
echo.
|
||||
echo.Build finished. Dummy builder generates no files.
|
||||
goto end
|
||||
)
|
||||
|
||||
:end
|
||||
|
|
@ -0,0 +1,342 @@
|
|||
# -*- coding: utf-8 -*-
|
||||
#
|
||||
# skeleton documentation build configuration file, created by
|
||||
# sphinx-quickstart on Mon Aug 1 21:41:36 2016.
|
||||
#
|
||||
# This file is execfile()d with the current directory set to its
|
||||
# containing dir.
|
||||
#
|
||||
# Note that not all possible configuration values are present in this
|
||||
# autogenerated file.
|
||||
#
|
||||
# All configuration values have a default; values that are commented out
|
||||
# serve to show the default.
|
||||
|
||||
# If extensions (or modules to document with autodoc) are in another directory,
|
||||
# add these directories to sys.path here. If the directory is relative to the
|
||||
# documentation root, use os.path.abspath to make it absolute, like shown here.
|
||||
#
|
||||
# import os
|
||||
# import sys
|
||||
# sys.path.insert(0, os.path.abspath('.'))
|
||||
|
||||
# -- General configuration ------------------------------------------------
|
||||
|
||||
# If your documentation needs a minimal Sphinx version, state it here.
|
||||
#
|
||||
# needs_sphinx = '1.0'
|
||||
|
||||
# Add any Sphinx extension module names here, as strings. They can be
|
||||
# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
|
||||
# ones.
|
||||
extensions = [
|
||||
'sphinx.ext.autodoc',
|
||||
'sphinx.ext.viewcode',
|
||||
]
|
||||
|
||||
# Add any paths that contain templates here, relative to this directory.
|
||||
templates_path = ['_templates']
|
||||
|
||||
# The suffix(es) of source filenames.
|
||||
# You can specify multiple suffix as a list of string:
|
||||
#
|
||||
# source_suffix = ['.rst', '.md']
|
||||
source_suffix = '.rst'
|
||||
|
||||
# The encoding of source files.
|
||||
#
|
||||
# source_encoding = 'utf-8-sig'
|
||||
|
||||
# The master toctree document.
|
||||
master_doc = 'index'
|
||||
|
||||
# General information about the project.
|
||||
project = u'skeleton'
|
||||
copyright = u'2016, Peng Xiao'
|
||||
author = u'Peng Xiao'
|
||||
|
||||
# The version info for the project you're documenting, acts as replacement for
|
||||
# |version| and |release|, also used in various other places throughout the
|
||||
# built documents.
|
||||
#
|
||||
# The short X.Y version.
|
||||
version = u'1.0'
|
||||
# The full version, including alpha/beta/rc tags.
|
||||
release = u'1.0'
|
||||
|
||||
# The language for content autogenerated by Sphinx. Refer to documentation
|
||||
# for a list of supported languages.
|
||||
#
|
||||
# This is also used if you do content translation via gettext catalogs.
|
||||
# Usually you set "language" from the command line for these cases.
|
||||
language = None
|
||||
|
||||
# There are two options for replacing |today|: either, you set today to some
|
||||
# non-false value, then it is used:
|
||||
#
|
||||
# today = ''
|
||||
#
|
||||
# Else, today_fmt is used as the format for a strftime call.
|
||||
#
|
||||
# today_fmt = '%B %d, %Y'
|
||||
|
||||
# List of patterns, relative to source directory, that match files and
|
||||
# directories to ignore when looking for source files.
|
||||
# This patterns also effect to html_static_path and html_extra_path
|
||||
exclude_patterns = []
|
||||
|
||||
# The reST default role (used for this markup: `text`) to use for all
|
||||
# documents.
|
||||
#
|
||||
# default_role = None
|
||||
|
||||
# If true, '()' will be appended to :func: etc. cross-reference text.
|
||||
#
|
||||
# add_function_parentheses = True
|
||||
|
||||
# If true, the current module name will be prepended to all description
|
||||
# unit titles (such as .. function::).
|
||||
#
|
||||
# add_module_names = True
|
||||
|
||||
# If true, sectionauthor and moduleauthor directives will be shown in the
|
||||
# output. They are ignored by default.
|
||||
#
|
||||
# show_authors = False
|
||||
|
||||
# The name of the Pygments (syntax highlighting) style to use.
|
||||
pygments_style = 'sphinx'
|
||||
|
||||
# A list of ignored prefixes for module index sorting.
|
||||
# modindex_common_prefix = []
|
||||
|
||||
# If true, keep warnings as "system message" paragraphs in the built documents.
|
||||
# keep_warnings = False
|
||||
|
||||
# If true, `todo` and `todoList` produce output, else they produce nothing.
|
||||
todo_include_todos = False
|
||||
|
||||
|
||||
# -- Options for HTML output ----------------------------------------------
|
||||
|
||||
# The theme to use for HTML and HTML Help pages. See the documentation for
|
||||
# a list of builtin themes.
|
||||
#
|
||||
# html_theme = 'alabaster'
|
||||
html_theme = 'sphinx_rtd_theme'
|
||||
|
||||
# Theme options are theme-specific and customize the look and feel of a theme
|
||||
# further. For a list of options available for each theme, see the
|
||||
# documentation.
|
||||
#
|
||||
# html_theme_options = {}
|
||||
|
||||
# Add any paths that contain custom themes here, relative to this directory.
|
||||
# html_theme_path = []
|
||||
|
||||
# The name for this set of Sphinx documents.
|
||||
# "<project> v<release> documentation" by default.
|
||||
#
|
||||
# html_title = u'skeleton v1.0'
|
||||
|
||||
# A shorter title for the navigation bar. Default is the same as html_title.
|
||||
#
|
||||
# html_short_title = None
|
||||
|
||||
# The name of an image file (relative to this directory) to place at the top
|
||||
# of the sidebar.
|
||||
#
|
||||
# html_logo = None
|
||||
|
||||
# The name of an image file (relative to this directory) to use as a favicon of
|
||||
# the docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32
|
||||
# pixels large.
|
||||
#
|
||||
# html_favicon = None
|
||||
|
||||
# Add any paths that contain custom static files (such as style sheets) here,
|
||||
# relative to this directory. They are copied after the builtin static files,
|
||||
# so a file named "default.css" will overwrite the builtin "default.css".
|
||||
html_static_path = ['_static']
|
||||
|
||||
# Add any extra paths that contain custom files (such as robots.txt or
|
||||
# .htaccess) here, relative to this directory. These files are copied
|
||||
# directly to the root of the documentation.
|
||||
#
|
||||
# html_extra_path = []
|
||||
|
||||
# If not None, a 'Last updated on:' timestamp is inserted at every page
|
||||
# bottom, using the given strftime format.
|
||||
# The empty string is equivalent to '%b %d, %Y'.
|
||||
#
|
||||
# html_last_updated_fmt = None
|
||||
|
||||
# If true, SmartyPants will be used to convert quotes and dashes to
|
||||
# typographically correct entities.
|
||||
#
|
||||
# html_use_smartypants = True
|
||||
|
||||
# Custom sidebar templates, maps document names to template names.
|
||||
#
|
||||
# html_sidebars = {}
|
||||
|
||||
# Additional templates that should be rendered to pages, maps page names to
|
||||
# template names.
|
||||
#
|
||||
# html_additional_pages = {}
|
||||
|
||||
# If false, no module index is generated.
|
||||
#
|
||||
# html_domain_indices = True
|
||||
|
||||
# If false, no index is generated.
|
||||
#
|
||||
# html_use_index = True
|
||||
|
||||
# If true, the index is split into individual pages for each letter.
|
||||
#
|
||||
# html_split_index = False
|
||||
|
||||
# If true, links to the reST sources are added to the pages.
|
||||
#
|
||||
# html_show_sourcelink = True
|
||||
|
||||
# If true, "Created using Sphinx" is shown in the HTML footer. Default is True.
|
||||
#
|
||||
# html_show_sphinx = True
|
||||
|
||||
# If true, "(C) Copyright ..." is shown in the HTML footer. Default is True.
|
||||
#
|
||||
# html_show_copyright = True
|
||||
|
||||
# If true, an OpenSearch description file will be output, and all pages will
|
||||
# contain a <link> tag referring to it. The value of this option must be the
|
||||
# base URL from which the finished HTML is served.
|
||||
#
|
||||
# html_use_opensearch = ''
|
||||
|
||||
# This is the file name suffix for HTML files (e.g. ".xhtml").
|
||||
# html_file_suffix = None
|
||||
|
||||
# Language to be used for generating the HTML full-text search index.
|
||||
# Sphinx supports the following languages:
|
||||
# 'da', 'de', 'en', 'es', 'fi', 'fr', 'hu', 'it', 'ja'
|
||||
# 'nl', 'no', 'pt', 'ro', 'ru', 'sv', 'tr', 'zh'
|
||||
#
|
||||
# html_search_language = 'en'
|
||||
|
||||
# A dictionary with options for the search language support, empty by default.
|
||||
# 'ja' uses this config value.
|
||||
# 'zh' user can custom change `jieba` dictionary path.
|
||||
#
|
||||
# html_search_options = {'type': 'default'}
|
||||
|
||||
# The name of a javascript file (relative to the configuration directory) that
|
||||
# implements a search results scorer. If empty, the default will be used.
|
||||
#
|
||||
# html_search_scorer = 'scorer.js'
|
||||
|
||||
# Output file base name for HTML help builder.
|
||||
htmlhelp_basename = 'skeletondoc'
|
||||
|
||||
# -- Options for LaTeX output ---------------------------------------------
|
||||
|
||||
latex_elements = {
|
||||
# The paper size ('letterpaper' or 'a4paper').
|
||||
#
|
||||
# 'papersize': 'letterpaper',
|
||||
|
||||
# The font size ('10pt', '11pt' or '12pt').
|
||||
#
|
||||
# 'pointsize': '10pt',
|
||||
|
||||
# Additional stuff for the LaTeX preamble.
|
||||
#
|
||||
# 'preamble': '',
|
||||
|
||||
# Latex figure (float) alignment
|
||||
#
|
||||
# 'figure_align': 'htbp',
|
||||
}
|
||||
|
||||
# Grouping the document tree into LaTeX files. List of tuples
|
||||
# (source start file, target name, title,
|
||||
# author, documentclass [howto, manual, or own class]).
|
||||
latex_documents = [
|
||||
(master_doc, 'skeleton.tex', u'skeleton Documentation',
|
||||
u'Peng Xiao', 'manual'),
|
||||
]
|
||||
|
||||
# The name of an image file (relative to this directory) to place at the top of
|
||||
# the title page.
|
||||
#
|
||||
# latex_logo = None
|
||||
|
||||
# For "manual" documents, if this is true, then toplevel headings are parts,
|
||||
# not chapters.
|
||||
#
|
||||
# latex_use_parts = False
|
||||
|
||||
# If true, show page references after internal links.
|
||||
#
|
||||
# latex_show_pagerefs = False
|
||||
|
||||
# If true, show URL addresses after external links.
|
||||
#
|
||||
# latex_show_urls = False
|
||||
|
||||
# Documents to append as an appendix to all manuals.
|
||||
#
|
||||
# latex_appendices = []
|
||||
|
||||
# It false, will not define \strong, \code, itleref, \crossref ... but only
|
||||
# \sphinxstrong, ..., \sphinxtitleref, ... To help avoid clash with user added
|
||||
# packages.
|
||||
#
|
||||
# latex_keep_old_macro_names = True
|
||||
|
||||
# If false, no module index is generated.
|
||||
#
|
||||
# latex_domain_indices = True
|
||||
|
||||
|
||||
# -- Options for manual page output ---------------------------------------
|
||||
|
||||
# One entry per manual page. List of tuples
|
||||
# (source start file, name, description, authors, manual section).
|
||||
man_pages = [
|
||||
(master_doc, 'skeleton', u'skeleton Documentation',
|
||||
[author], 1)
|
||||
]
|
||||
|
||||
# If true, show URL addresses after external links.
|
||||
#
|
||||
# man_show_urls = False
|
||||
|
||||
|
||||
# -- Options for Texinfo output -------------------------------------------
|
||||
|
||||
# Grouping the document tree into Texinfo files. List of tuples
|
||||
# (source start file, target name, title, author,
|
||||
# dir menu entry, description, category)
|
||||
texinfo_documents = [
|
||||
(master_doc, 'skeleton', u'skeleton Documentation',
|
||||
author, 'skeleton', 'One line description of project.',
|
||||
'Miscellaneous'),
|
||||
]
|
||||
|
||||
# Documents to append as an appendix to all manuals.
|
||||
#
|
||||
# texinfo_appendices = []
|
||||
|
||||
# If false, no module index is generated.
|
||||
#
|
||||
# texinfo_domain_indices = True
|
||||
|
||||
# How to display URL addresses: 'footnote', 'no', or 'inline'.
|
||||
#
|
||||
# texinfo_show_urls = 'footnote'
|
||||
|
||||
# If true, do not generate a @detailmenu in the "Top" node's menu.
|
||||
#
|
||||
# texinfo_no_detailmenu = False
|
||||
|
|
@ -0,0 +1,25 @@
|
|||
.. yacore documentation master file, created by
|
||||
sphinx-quickstart on Mon Aug 1 21:41:36 2016.
|
||||
You can adapt this file completely to your liking, but it should at least
|
||||
contain the root `toctree` directive.
|
||||
|
||||
Welcome to yacore's documentation!
|
||||
==================================
|
||||
|
||||
This is a test line
|
||||
test again
|
||||
test
|
||||
Contents:
|
||||
|
||||
.. toctree::
|
||||
:maxdepth: 2
|
||||
|
||||
|
||||
|
||||
Indices and tables
|
||||
==================
|
||||
|
||||
* :ref:`genindex`
|
||||
* :ref:`modindex`
|
||||
* :ref:`search`
|
||||
|
||||
|
|
@ -0,0 +1,56 @@
|
|||
# manage.py
|
||||
|
||||
import unittest
|
||||
|
||||
from flask_script import Manager
|
||||
from flask_migrate import Migrate, MigrateCommand
|
||||
|
||||
from skeleton.server import app, db
|
||||
from skeleton.server.models import User
|
||||
|
||||
|
||||
migrate = Migrate(app, db)
|
||||
manager = Manager(app)
|
||||
|
||||
# migrations
|
||||
manager.add_command('db', MigrateCommand)
|
||||
|
||||
|
||||
@manager.command
|
||||
def test():
|
||||
"""Runs the unit tests without coverage."""
|
||||
tests = unittest.TestLoader().discover('tests', pattern='test*.py')
|
||||
result = unittest.TextTestRunner(verbosity=2).run(tests)
|
||||
if result.wasSuccessful():
|
||||
return 0
|
||||
else:
|
||||
return 1
|
||||
|
||||
|
||||
@manager.command
|
||||
def create_db():
|
||||
"""Creates the db tables."""
|
||||
db.create_all()
|
||||
|
||||
|
||||
@manager.command
|
||||
def drop_db():
|
||||
"""Drops the db tables."""
|
||||
db.drop_all()
|
||||
|
||||
|
||||
@manager.command
|
||||
def create_admin():
|
||||
"""Creates the admin user."""
|
||||
db.session.add(User(email='admin@cisco.com', password='admin', admin=True))
|
||||
db.session.commit()
|
||||
|
||||
|
||||
@manager.command
|
||||
def create_data():
|
||||
"""Creates sample data."""
|
||||
pass
|
||||
|
||||
|
||||
if __name__ == '__main__':
|
||||
manager.run()
|
||||
|
|
@ -0,0 +1 @@
|
|||
Generic single-database configuration.
|
||||
|
|
@ -0,0 +1,45 @@
|
|||
# A generic, single database configuration.
|
||||
|
||||
[alembic]
|
||||
# template used to generate migration files
|
||||
# file_template = %%(rev)s_%%(slug)s
|
||||
|
||||
# set to 'true' to run the environment during
|
||||
# the 'revision' command, regardless of autogenerate
|
||||
# revision_environment = false
|
||||
|
||||
|
||||
# Logging configuration
|
||||
[loggers]
|
||||
keys = root,sqlalchemy,alembic
|
||||
|
||||
[handlers]
|
||||
keys = console
|
||||
|
||||
[formatters]
|
||||
keys = generic
|
||||
|
||||
[logger_root]
|
||||
level = WARN
|
||||
handlers = console
|
||||
qualname =
|
||||
|
||||
[logger_sqlalchemy]
|
||||
level = WARN
|
||||
handlers =
|
||||
qualname = sqlalchemy.engine
|
||||
|
||||
[logger_alembic]
|
||||
level = INFO
|
||||
handlers =
|
||||
qualname = alembic
|
||||
|
||||
[handler_console]
|
||||
class = StreamHandler
|
||||
args = (sys.stderr,)
|
||||
level = NOTSET
|
||||
formatter = generic
|
||||
|
||||
[formatter_generic]
|
||||
format = %(levelname)-5.5s [%(name)s] %(message)s
|
||||
datefmt = %H:%M:%S
|
||||
|
|
@ -0,0 +1,87 @@
|
|||
from __future__ import with_statement
|
||||
from alembic import context
|
||||
from sqlalchemy import engine_from_config, pool
|
||||
from logging.config import fileConfig
|
||||
import logging
|
||||
|
||||
# this is the Alembic Config object, which provides
|
||||
# access to the values within the .ini file in use.
|
||||
config = context.config
|
||||
|
||||
# Interpret the config file for Python logging.
|
||||
# This line sets up loggers basically.
|
||||
fileConfig(config.config_file_name)
|
||||
logger = logging.getLogger('alembic.env')
|
||||
|
||||
# add your model's MetaData object here
|
||||
# for 'autogenerate' support
|
||||
# from myapp import mymodel
|
||||
# target_metadata = mymodel.Base.metadata
|
||||
from flask import current_app
|
||||
config.set_main_option('sqlalchemy.url',
|
||||
current_app.config.get('SQLALCHEMY_DATABASE_URI'))
|
||||
target_metadata = current_app.extensions['migrate'].db.metadata
|
||||
|
||||
# other values from the config, defined by the needs of env.py,
|
||||
# can be acquired:
|
||||
# my_important_option = config.get_main_option("my_important_option")
|
||||
# ... etc.
|
||||
|
||||
|
||||
def run_migrations_offline():
|
||||
"""Run migrations in 'offline' mode.
|
||||
|
||||
This configures the context with just a URL
|
||||
and not an Engine, though an Engine is acceptable
|
||||
here as well. By skipping the Engine creation
|
||||
we don't even need a DBAPI to be available.
|
||||
|
||||
Calls to context.execute() here emit the given string to the
|
||||
script output.
|
||||
|
||||
"""
|
||||
url = config.get_main_option("sqlalchemy.url")
|
||||
context.configure(url=url)
|
||||
|
||||
with context.begin_transaction():
|
||||
context.run_migrations()
|
||||
|
||||
|
||||
def run_migrations_online():
|
||||
"""Run migrations in 'online' mode.
|
||||
|
||||
In this scenario we need to create an Engine
|
||||
and associate a connection with the context.
|
||||
|
||||
"""
|
||||
|
||||
# this callback is used to prevent an auto-migration from being generated
|
||||
# when there are no changes to the schema
|
||||
# reference: http://alembic.readthedocs.org/en/latest/cookbook.html
|
||||
def process_revision_directives(context, revision, directives):
|
||||
if getattr(config.cmd_opts, 'autogenerate', False):
|
||||
script = directives[0]
|
||||
if script.upgrade_ops.is_empty():
|
||||
directives[:] = []
|
||||
logger.info('No changes in schema detected.')
|
||||
|
||||
engine = engine_from_config(config.get_section(config.config_ini_section),
|
||||
prefix='sqlalchemy.',
|
||||
poolclass=pool.NullPool)
|
||||
|
||||
connection = engine.connect()
|
||||
context.configure(connection=connection,
|
||||
target_metadata=target_metadata,
|
||||
process_revision_directives=process_revision_directives,
|
||||
**current_app.extensions['migrate'].configure_args)
|
||||
|
||||
try:
|
||||
with context.begin_transaction():
|
||||
context.run_migrations()
|
||||
finally:
|
||||
connection.close()
|
||||
|
||||
if context.is_offline_mode():
|
||||
run_migrations_offline()
|
||||
else:
|
||||
run_migrations_online()
|
||||
|
|
@ -0,0 +1,22 @@
|
|||
"""${message}
|
||||
|
||||
Revision ID: ${up_revision}
|
||||
Revises: ${down_revision}
|
||||
Create Date: ${create_date}
|
||||
|
||||
"""
|
||||
|
||||
# revision identifiers, used by Alembic.
|
||||
revision = ${repr(up_revision)}
|
||||
down_revision = ${repr(down_revision)}
|
||||
|
||||
from alembic import op
|
||||
import sqlalchemy as sa
|
||||
${imports if imports else ""}
|
||||
|
||||
def upgrade():
|
||||
${upgrades if upgrades else "pass"}
|
||||
|
||||
|
||||
def downgrade():
|
||||
${downgrades if downgrades else "pass"}
|
||||
|
|
@ -0,0 +1,26 @@
|
|||
alembic==0.8.6
|
||||
bcrypt==3.1.0
|
||||
blinker==1.4
|
||||
cffi==1.7.0
|
||||
click==6.6
|
||||
dominate==2.2.1
|
||||
Flask==0.10.1
|
||||
Flask-Bcrypt==0.7.1
|
||||
Flask-Bootstrap==3.3.6.0
|
||||
Flask-DebugToolbar==0.10.0
|
||||
Flask-Login==0.3.2
|
||||
Flask-Migrate==1.8.1
|
||||
Flask-Script==2.0.5
|
||||
Flask-SQLAlchemy==2.1
|
||||
Flask-WTF==0.12
|
||||
itsdangerous==0.24
|
||||
Jinja2==2.8
|
||||
Mako==1.0.4
|
||||
MarkupSafe==0.23
|
||||
pycparser==2.14
|
||||
python-editor==1.0.1
|
||||
six==1.10.0
|
||||
SQLAlchemy==1.0.14
|
||||
visitor==0.1.3
|
||||
Werkzeug==0.11.10
|
||||
WTForms==2.1
|
||||
|
|
@ -0,0 +1,5 @@
|
|||
#!/usr/bin/env bash
|
||||
|
||||
docker ps -a | grep penxiao_skeleton | awk '{print$1}' | xargs docker stop
|
||||
docker ps -a | grep penxiao_skeleton | awk '{print$1}' | xargs docker rm
|
||||
docker run -d -p 80:5000 --name penxiao_skeleton skeleton
|
||||
|
|
@ -0,0 +1,7 @@
|
|||
#!/usr/bin/env bash
|
||||
|
||||
export APP_SETTINGS="skeleton.server.config.ProductionConfig"
|
||||
python manage.py create_db
|
||||
python manage.py create_admin
|
||||
python manage.py create_data
|
||||
python manage.py runserver -h 0.0.0.0
|
||||
|
|
@ -0,0 +1,5 @@
|
|||
/* custom css */
|
||||
|
||||
.site-content {
|
||||
padding-top: 75px;
|
||||
}
|
||||
|
|
@ -0,0 +1,5 @@
|
|||
// custom javascript
|
||||
|
||||
$( document ).ready(function() {
|
||||
console.log('Sanity Check!');
|
||||
});
|
||||
|
|
@ -0,0 +1,66 @@
|
|||
<!DOCTYPE html>
|
||||
<html>
|
||||
|
||||
<head>
|
||||
<meta charset="utf-8">
|
||||
<title>Flask Skeleton{% block title %}{% endblock %}</title>
|
||||
<!-- meta -->
|
||||
<meta name="description" content="">
|
||||
<meta name="author" content="">
|
||||
<meta name="viewport" content="width=device-width,initial-scale=1">
|
||||
<!-- styles -->
|
||||
<link href="//maxcdn.bootstrapcdn.com/bootswatch/3.3.1/yeti/bootstrap.min.css" rel="stylesheet" media="screen">
|
||||
<link href="{{url_for('static', filename='main.css')}}" rel="stylesheet" media="screen">
|
||||
{% block css %}{% endblock %}
|
||||
</head>
|
||||
|
||||
<body>
|
||||
|
||||
{% include 'header.html' %}
|
||||
|
||||
<div class="site-content">
|
||||
<div class="container">
|
||||
|
||||
<!-- messages -->
|
||||
{% with messages = get_flashed_messages(with_categories=true) %}
|
||||
{% if messages %}
|
||||
<br>
|
||||
<div class="row">
|
||||
<div class="col-md-12">
|
||||
{% for category, message in messages %}
|
||||
<div class="alert alert-{{ category }}">
|
||||
<a class="close" title="Close" href="#" data-dismiss="alert">×</a>
|
||||
{{message}}
|
||||
</div>
|
||||
{% endfor %}
|
||||
</div>
|
||||
</div>
|
||||
{% endif %}
|
||||
{% endwith %}
|
||||
|
||||
|
||||
<!-- child template -->
|
||||
{% block content %}{% endblock %}
|
||||
|
||||
<br>
|
||||
|
||||
<!-- errors -->
|
||||
{% if error %}
|
||||
<p class="error"><strong>Error:</strong> {{ error }}</p>
|
||||
{% endif %}
|
||||
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<br><br>
|
||||
|
||||
{% include 'footer.html' %}
|
||||
|
||||
<!-- scripts -->
|
||||
<script src="//code.jquery.com/jquery-1.11.2.min.js" type="text/javascript"></script>
|
||||
<script src="//maxcdn.bootstrapcdn.com/bootstrap/3.3.1/js/bootstrap.min.js" type="text/javascript"></script>
|
||||
<script src="{{url_for('static', filename='main.js')}}" type="text/javascript"></script>
|
||||
{% block js %}{% endblock %}
|
||||
|
||||
</body>
|
||||
</html>
|
||||
|
|
@ -0,0 +1,12 @@
|
|||
{% extends "_base.html" %}
|
||||
|
||||
{% block page_title %}- Unauthorized{% endblock %}
|
||||
|
||||
{% block content %}
|
||||
<div class="jumbotron">
|
||||
<div class="text-center">
|
||||
<h1>401</h1>
|
||||
<p>You are not authorized to view this page. Please <a href="{{ url_for('main.login')}}">log in</a>.</p>
|
||||
</div>
|
||||
</div>
|
||||
{% endblock %}
|
||||
|
|
@ -0,0 +1,12 @@
|
|||
{% extends "_base.html" %}
|
||||
|
||||
{% block page_title %}- Unauthorized{% endblock %}
|
||||
|
||||
{% block content %}
|
||||
<div class="jumbotron">
|
||||
<div class="text-center">
|
||||
<h1>401</h1>
|
||||
<p>You are not authorized to view this page. Please <a href="{{ url_for('main.login')}}">log in</a>.</p>
|
||||
</div>
|
||||
</div>
|
||||
{% endblock %}
|
||||
|
|
@ -0,0 +1,12 @@
|
|||
{% extends "_base.html" %}
|
||||
|
||||
{% block page_title %}- Page Not Found{% endblock %}
|
||||
|
||||
{% block content %}
|
||||
<div class="jumbotron">
|
||||
<div class="text-center">
|
||||
<h1>404</h1>
|
||||
<p>Sorry. The requested page doesn't exist. Go <a href="{{ url_for('main.home')}}">home</a>.</p>
|
||||
</div>
|
||||
</div>
|
||||
{% endblock %}
|
||||
|
|
@ -0,0 +1,12 @@
|
|||
{% extends "_base.html" %}
|
||||
|
||||
{% block page_title %}- Server Error{% endblock %}
|
||||
|
||||
{% block content %}
|
||||
<div class="jumbotron">
|
||||
<div class="text-center">
|
||||
<h1>500</h1>
|
||||
<p>Sorry. Something went terribly wrong. Go <a href="{{ url_for('main.home')}}">home</a>.</p>
|
||||
</div>
|
||||
</div>
|
||||
{% endblock %}
|
||||
|
|
@ -0,0 +1,7 @@
|
|||
<footer>
|
||||
<div class="container">
|
||||
<small>
|
||||
<span>© <a href="mailto:xiaoquwl@gmail.com">Flask Demo</a></span>
|
||||
</small>
|
||||
</div>
|
||||
</footer>
|
||||
|
|
@ -0,0 +1,35 @@
|
|||
<header class="site-header">
|
||||
<!-- Navigation -->
|
||||
<nav class="navbar navbar-default navbar-fixed-top" role="navigation">
|
||||
<div class="container">
|
||||
<!-- Brand and toggle get grouped for better mobile display -->
|
||||
<div class="navbar-header">
|
||||
<button type="button" class="navbar-toggle" data-toggle="collapse" data-target="#bs-example-navbar-collapse-1">
|
||||
<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="{{ url_for('main.home') }}">Flask-Skeleton</a>
|
||||
</div>
|
||||
<!-- Collect the nav links, forms, and other content for toggling -->
|
||||
<div class="collapse navbar-collapse" id="bs-example-navbar-collapse-1">
|
||||
<ul class="nav navbar-nav">
|
||||
<li><a href="{{ url_for('main.about') }}">About</a></li>
|
||||
{% if current_user.is_authenticated %}
|
||||
<li><a href="{{ url_for('user.members') }}">Members</a></li>
|
||||
{% endif %}
|
||||
</ul>
|
||||
<ul class="nav navbar-nav navbar-right">
|
||||
{% if current_user.is_authenticated %}
|
||||
<li><a href="{{ url_for('user.logout') }}">Logout</a></li>
|
||||
{% else %}
|
||||
<li><a href="{{ url_for('user.login') }}"><span class="glyphicon glyphicon-user"></span> Register/Login</a></li>
|
||||
{% endif %}
|
||||
</ul>
|
||||
</div>
|
||||
<!-- /.navbar-collapse -->
|
||||
</div>
|
||||
<!-- /.container -->
|
||||
</nav>
|
||||
</header>
|
||||
|
|
@ -0,0 +1,11 @@
|
|||
{% extends "_base.html" %}
|
||||
|
||||
{% block content %}
|
||||
|
||||
<div class="body-content">
|
||||
<div class="row">
|
||||
<h1>About</h1>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
{% endblock %}
|
||||
|
|
@ -0,0 +1,11 @@
|
|||
{% extends "_base.html" %}
|
||||
|
||||
{% block content %}
|
||||
|
||||
<div class="body-content">
|
||||
<div class="row">
|
||||
<h1>Welcome!</h1>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
{% endblock %}
|
||||
|
|
@ -0,0 +1,33 @@
|
|||
{% extends '_base.html' %}
|
||||
{% import "bootstrap/wtf.html" as wtf %}
|
||||
|
||||
{% block content %}
|
||||
|
||||
<header class="content-header">
|
||||
<h1>Please login</h1>
|
||||
</header>
|
||||
|
||||
<br>
|
||||
|
||||
|
||||
<form class="form" role="form" method="post" action="">
|
||||
|
||||
{{ form.csrf_token }}
|
||||
{{ form.hidden_tag() }}
|
||||
{{ wtf.form_errors(form, hiddens="only") }}
|
||||
|
||||
|
||||
<div class="col-lg-4 col-sm-4">
|
||||
|
||||
{{ wtf.form_field(form.email) }}
|
||||
{{ wtf.form_field(form.password) }}
|
||||
|
||||
<button class="btn btn-success" type="submit">Sign In!</button>
|
||||
<br><br>
|
||||
<p>Need to <a href="{{ url_for('user.register') }}">Register</a>?</p>
|
||||
</div>
|
||||
|
||||
</form>
|
||||
|
||||
|
||||
{% endblock content %}
|
||||
|
|
@ -0,0 +1,5 @@
|
|||
{% extends "_base.html" %}
|
||||
{% block content %}
|
||||
<h1>Welcome, <em>{{ current_user.email }}</em>!</h1>
|
||||
<h3>This is the members-only page :)</h3>
|
||||
{% endblock %}
|
||||
|
|
@ -0,0 +1,35 @@
|
|||
{% extends '_base.html' %}
|
||||
{% import "bootstrap/wtf.html" as wtf %}
|
||||
|
||||
{% block content %}
|
||||
|
||||
<header class="content-header">
|
||||
<h1>Please Register</h1>
|
||||
</header>
|
||||
|
||||
<br>
|
||||
|
||||
|
||||
<form class="form" role="form" method="post" action="">
|
||||
|
||||
{{ form.csrf_token }}
|
||||
{{ form.hidden_tag() }}
|
||||
{{ wtf.form_errors(form, hiddens="only") }}
|
||||
|
||||
|
||||
<div class="col-lg-4 col-sm-4">
|
||||
|
||||
{{ wtf.form_field(form.email) }}
|
||||
{{ wtf.form_field(form.password) }}
|
||||
{{ wtf.form_field(form.confirm) }}
|
||||
|
||||
<button class="btn btn-success" type="submit">Register!</button>
|
||||
<br><br>
|
||||
<p>Already have an account? <a href="{{ url_for('user.login') }}">Sign in</a>.</p>
|
||||
|
||||
</div>
|
||||
|
||||
</form>
|
||||
|
||||
|
||||
{% endblock content %}
|
||||
|
|
@ -0,0 +1,63 @@
|
|||
# Copyright 2016 Cisco Systems, Inc.
|
||||
# All rights reserved.
|
||||
|
||||
import os
|
||||
|
||||
from flask import Flask, render_template
|
||||
from flask_login import LoginManager
|
||||
from flask_bcrypt import Bcrypt
|
||||
from flask_debugtoolbar import DebugToolbarExtension
|
||||
from flask_bootstrap import Bootstrap
|
||||
from flask_sqlalchemy import SQLAlchemy
|
||||
|
||||
|
||||
app = Flask(
|
||||
__name__,
|
||||
template_folder='../client/templates',
|
||||
static_folder='../client/static'
|
||||
)
|
||||
|
||||
app_settings = os.getenv('APP_SETTINGS', 'skeleton.server.config.DevelopmentConfig')
|
||||
app.config.from_object(app_settings)
|
||||
|
||||
login_manager = LoginManager()
|
||||
login_manager.init_app(app)
|
||||
bcrypt = Bcrypt(app)
|
||||
toolbar = DebugToolbarExtension(app)
|
||||
bootstrap = Bootstrap(app)
|
||||
db = SQLAlchemy(app)
|
||||
|
||||
from skeleton.server.user.views import user_blueprint
|
||||
from skeleton.server.main.views import main_blueprint
|
||||
app.register_blueprint(user_blueprint)
|
||||
app.register_blueprint(main_blueprint)
|
||||
|
||||
from skeleton.server.models import User
|
||||
|
||||
login_manager.login_view = "user.login"
|
||||
login_manager.login_message_category = 'danger'
|
||||
|
||||
|
||||
@login_manager.user_loader
|
||||
def load_user(user_id):
|
||||
return User.query.filter(User.id == int(user_id)).first()
|
||||
|
||||
|
||||
@app.errorhandler(401)
|
||||
def forbidden_page_401(error):
|
||||
return render_template("errors/401.html"), 401
|
||||
|
||||
|
||||
@app.errorhandler(403)
|
||||
def forbidden_page_403(error):
|
||||
return render_template("errors/403.html"), 403
|
||||
|
||||
|
||||
@app.errorhandler(404)
|
||||
def page_not_found(error):
|
||||
return render_template("errors/404.html"), 404
|
||||
|
||||
|
||||
@app.errorhandler(500)
|
||||
def server_error_page(error):
|
||||
return render_template("errors/500.html"), 500
|
||||
|
|
@ -0,0 +1,43 @@
|
|||
# Copyright 2016 Cisco Systems, Inc.
|
||||
# All rights reserved.
|
||||
|
||||
import os
|
||||
basedir = os.path.abspath(os.path.dirname(__file__))
|
||||
|
||||
|
||||
class BaseConfig(object):
|
||||
"""Base configuration."""
|
||||
SECRET_KEY = 'my_precious'
|
||||
DEBUG = False
|
||||
BCRYPT_LOG_ROUNDS = 13
|
||||
WTF_CSRF_ENABLED = True
|
||||
DEBUG_TB_ENABLED = False
|
||||
DEBUG_TB_INTERCEPT_REDIRECTS = False
|
||||
SQLALCHEMY_TRACK_MODIFICATIONS = False
|
||||
SQLALCHEMY_DATABASE_URI = os.environ.get(
|
||||
'DATABASE_URL', 'sqlite:///' + os.path.join(basedir, 'db.sqlite'))
|
||||
|
||||
|
||||
class DevelopmentConfig(BaseConfig):
|
||||
"""Development configuration."""
|
||||
DEBUG = True
|
||||
BCRYPT_LOG_ROUNDS = 4
|
||||
WTF_CSRF_ENABLED = False
|
||||
DEBUG_TB_ENABLED = True
|
||||
|
||||
|
||||
class TestingConfig(BaseConfig):
|
||||
"""Testing configuration."""
|
||||
DEBUG = True
|
||||
TESTING = True
|
||||
BCRYPT_LOG_ROUNDS = 4
|
||||
WTF_CSRF_ENABLED = False
|
||||
DEBUG_TB_ENABLED = False
|
||||
PRESERVE_CONTEXT_ON_EXCEPTION = False
|
||||
|
||||
|
||||
class ProductionConfig(BaseConfig):
|
||||
"""Production configuration."""
|
||||
SECRET_KEY = 'my_precious'
|
||||
DEBUG = False
|
||||
DEBUG_TB_ENABLED = False
|
||||
|
|
@ -0,0 +1,16 @@
|
|||
# Copyright 2016 Cisco Systems, Inc.
|
||||
# All rights reserved.
|
||||
|
||||
from flask import render_template, Blueprint
|
||||
|
||||
main_blueprint = Blueprint('main', __name__,)
|
||||
|
||||
|
||||
@main_blueprint.route('/')
|
||||
def home():
|
||||
return render_template('main/home.html')
|
||||
|
||||
|
||||
@main_blueprint.route("/about/")
|
||||
def about():
|
||||
return render_template("main/about.html")
|
||||
|
|
@ -0,0 +1,40 @@
|
|||
# Copyright 2016 Cisco Systems, Inc.
|
||||
# All rights reserved.
|
||||
|
||||
import datetime
|
||||
|
||||
from skeleton.server import app, db, bcrypt
|
||||
|
||||
|
||||
class User(db.Model):
|
||||
|
||||
__tablename__ = "users"
|
||||
|
||||
id = db.Column(db.Integer, primary_key=True, autoincrement=True)
|
||||
email = db.Column(db.String(255), unique=True, nullable=False)
|
||||
password = db.Column(db.String(255), nullable=False)
|
||||
registered_on = db.Column(db.DateTime, nullable=False)
|
||||
admin = db.Column(db.Boolean, nullable=False, default=False)
|
||||
|
||||
def __init__(self, email, password, admin=False):
|
||||
self.email = email
|
||||
self.password = bcrypt.generate_password_hash(
|
||||
password, app.config.get('BCRYPT_LOG_ROUNDS')
|
||||
)
|
||||
self.registered_on = datetime.datetime.now()
|
||||
self.admin = admin
|
||||
|
||||
def is_authenticated(self):
|
||||
return True
|
||||
|
||||
def is_active(self):
|
||||
return True
|
||||
|
||||
def is_anonymous(self):
|
||||
return False
|
||||
|
||||
def get_id(self):
|
||||
return self.id
|
||||
|
||||
def __repr__(self):
|
||||
return '<User {0}>'.format(self.email)
|
||||
|
|
@ -0,0 +1,28 @@
|
|||
# Copyright 2016 Cisco Systems, Inc.
|
||||
# All rights reserved.
|
||||
|
||||
from flask_wtf import Form
|
||||
from wtforms import StringField, PasswordField
|
||||
from wtforms.validators import DataRequired, Email, Length, EqualTo
|
||||
|
||||
|
||||
class LoginForm(Form):
|
||||
email = StringField('Email Address', [DataRequired(), Email()])
|
||||
password = PasswordField('Password', [DataRequired()])
|
||||
|
||||
|
||||
class RegisterForm(Form):
|
||||
email = StringField(
|
||||
'Email Address',
|
||||
validators=[DataRequired(), Email(message=None), Length(min=6, max=40)])
|
||||
password = PasswordField(
|
||||
'Password',
|
||||
validators=[DataRequired(), Length(min=6, max=25)]
|
||||
)
|
||||
confirm = PasswordField(
|
||||
'Confirm password',
|
||||
validators=[
|
||||
DataRequired(),
|
||||
EqualTo('password', message='Passwords must match.')
|
||||
]
|
||||
)
|
||||
|
|
@ -0,0 +1,62 @@
|
|||
# Copyright 2016 Cisco Systems, Inc.
|
||||
# All rights reserved.
|
||||
|
||||
|
||||
from flask import render_template, Blueprint, url_for, \
|
||||
redirect, flash, request
|
||||
from flask_login import login_user, logout_user, login_required
|
||||
|
||||
from skeleton.server import bcrypt, db
|
||||
from skeleton.server.models import User
|
||||
from skeleton.server.user.forms import LoginForm, RegisterForm
|
||||
|
||||
user_blueprint = Blueprint('user', __name__,)
|
||||
|
||||
|
||||
@user_blueprint.route('/register', methods=['GET', 'POST'])
|
||||
def register():
|
||||
form = RegisterForm(request.form)
|
||||
if form.validate_on_submit():
|
||||
user = User(
|
||||
email=form.email.data,
|
||||
password=form.password.data
|
||||
)
|
||||
db.session.add(user)
|
||||
db.session.commit()
|
||||
|
||||
login_user(user)
|
||||
|
||||
flash('Thank you for registering.', 'success')
|
||||
return redirect(url_for("user.members"))
|
||||
|
||||
return render_template('user/register.html', form=form)
|
||||
|
||||
|
||||
@user_blueprint.route('/login', methods=['GET', 'POST'])
|
||||
def login():
|
||||
form = LoginForm(request.form)
|
||||
if form.validate_on_submit():
|
||||
user = User.query.filter_by(email=form.email.data).first()
|
||||
if user and bcrypt.check_password_hash(
|
||||
user.password, request.form['password']):
|
||||
login_user(user)
|
||||
flash('You are logged in. Welcome!', 'success')
|
||||
return redirect(url_for('user.members'))
|
||||
else:
|
||||
flash('Invalid email and/or password.', 'danger')
|
||||
return render_template('user/login.html', form=form)
|
||||
return render_template('user/login.html', title='Please Login', form=form)
|
||||
|
||||
|
||||
@user_blueprint.route('/logout')
|
||||
@login_required
|
||||
def logout():
|
||||
logout_user()
|
||||
flash('You were logged out. Bye!', 'success')
|
||||
return redirect(url_for('main.home'))
|
||||
|
||||
|
||||
@user_blueprint.route('/members')
|
||||
@login_required
|
||||
def members():
|
||||
return render_template('user/members.html')
|
||||
|
|
@ -0,0 +1,5 @@
|
|||
flake8==2.4.0
|
||||
Flask-Testing==0.4.2
|
||||
discover
|
||||
nose
|
||||
coverage==4.0.3
|
||||
|
|
@ -0,0 +1,24 @@
|
|||
# Copyright 2016 Cisco Systems, Inc.
|
||||
# All rights reserved.
|
||||
|
||||
from flask_testing import TestCase
|
||||
|
||||
from skeleton.server import app, db
|
||||
from skeleton.server.models import User
|
||||
|
||||
|
||||
class BaseTestCase(TestCase):
|
||||
|
||||
def create_app(self):
|
||||
app.config.from_object('skeleton.server.config.TestingConfig')
|
||||
return app
|
||||
|
||||
def setUp(self):
|
||||
db.create_all()
|
||||
user = User(email="ad@min.com", password="admin_user")
|
||||
db.session.add(user)
|
||||
db.session.commit()
|
||||
|
||||
def tearDown(self):
|
||||
db.session.remove()
|
||||
db.drop_all()
|
||||
|
|
@ -0,0 +1,54 @@
|
|||
# Copyright 2016 Cisco Systems, Inc.
|
||||
# All rights reserved.
|
||||
|
||||
import unittest
|
||||
|
||||
from flask import current_app
|
||||
from flask_testing import TestCase
|
||||
|
||||
from skeleton.server import app
|
||||
|
||||
|
||||
class TestDevelopmentConfig(TestCase):
|
||||
|
||||
def create_app(self):
|
||||
app.config.from_object('skeleton.server.config.DevelopmentConfig')
|
||||
return app
|
||||
|
||||
def test_app_is_development(self):
|
||||
# self.assertFalse(current_app.config['TESTING'])
|
||||
self.assertTrue(app.config['DEBUG'] is True)
|
||||
self.assertTrue(app.config['WTF_CSRF_ENABLED'] is False)
|
||||
self.assertTrue(app.config['DEBUG_TB_ENABLED'] is True)
|
||||
self.assertFalse(current_app is None)
|
||||
|
||||
|
||||
class TestTestingConfig(TestCase):
|
||||
|
||||
def create_app(self):
|
||||
app.config.from_object('skeleton.server.config.TestingConfig')
|
||||
return app
|
||||
|
||||
def test_app_is_testing(self):
|
||||
self.assertTrue(current_app.config['TESTING'])
|
||||
self.assertTrue(app.config['DEBUG'] is True)
|
||||
self.assertTrue(app.config['BCRYPT_LOG_ROUNDS'] == 4)
|
||||
self.assertTrue(app.config['WTF_CSRF_ENABLED'] is False)
|
||||
|
||||
|
||||
class TestProductionConfig(TestCase):
|
||||
|
||||
def create_app(self):
|
||||
app.config.from_object('skeleton.server.config.ProductionConfig')
|
||||
return app
|
||||
|
||||
def test_app_is_production(self):
|
||||
# self.assertFalse(current_app.config['TESTING'])
|
||||
self.assertTrue(app.config['DEBUG'] is False)
|
||||
self.assertTrue(app.config['DEBUG_TB_ENABLED'] is False)
|
||||
self.assertTrue(app.config['WTF_CSRF_ENABLED'] is True)
|
||||
self.assertTrue(app.config['BCRYPT_LOG_ROUNDS'] == 13)
|
||||
|
||||
|
||||
if __name__ == '__main__':
|
||||
unittest.main()
|
||||
|
|
@ -0,0 +1,37 @@
|
|||
# Copyright 2016 Cisco Systems, Inc.
|
||||
# All rights reserved.
|
||||
|
||||
import unittest
|
||||
|
||||
from base import BaseTestCase
|
||||
|
||||
|
||||
class TestMainBlueprint(BaseTestCase):
|
||||
|
||||
def test_index(self):
|
||||
# Ensure Flask is setup.
|
||||
response = self.client.get('/', follow_redirects=True)
|
||||
self.assertEqual(response.status_code, 200)
|
||||
self.assertIn(b'Welcome!', response.data)
|
||||
self.assertIn(b'Register/Login', response.data)
|
||||
|
||||
def test_footer(self):
|
||||
response = self.client.get('/', follow_redirects=True)
|
||||
self.assertEqual(response.status_code, 200)
|
||||
self.assertIn(b'GitLab Demo', response.data)
|
||||
|
||||
def test_about(self):
|
||||
# Ensure about route behaves correctly.
|
||||
response = self.client.get('/about', follow_redirects=True)
|
||||
self.assertEqual(response.status_code, 200)
|
||||
self.assertIn(b'About', response.data)
|
||||
|
||||
def test_404(self):
|
||||
# Ensure 404 error is handled.
|
||||
response = self.client.get('/404')
|
||||
self.assert404(response)
|
||||
self.assertTemplateUsed('errors/404.html')
|
||||
|
||||
|
||||
if __name__ == '__main__':
|
||||
unittest.main()
|
||||
|
|
@ -0,0 +1,116 @@
|
|||
# Copyright 2016 Cisco Systems, Inc.
|
||||
# All rights reserved.
|
||||
|
||||
import datetime
|
||||
import unittest
|
||||
|
||||
from flask_login import current_user
|
||||
|
||||
from base import BaseTestCase
|
||||
from skeleton.server import bcrypt
|
||||
from skeleton.server.models import User
|
||||
from skeleton.server.user.forms import LoginForm
|
||||
|
||||
|
||||
class TestUserBlueprint(BaseTestCase):
|
||||
|
||||
def test_correct_login(self):
|
||||
# Ensure login behaves correctly with correct credentials.
|
||||
with self.client:
|
||||
response = self.client.post(
|
||||
'/login',
|
||||
data=dict(email="ad@min.com", password="admin_user"),
|
||||
follow_redirects=True
|
||||
)
|
||||
self.assertIn(b'Welcome', response.data)
|
||||
self.assertIn(b'Logout', response.data)
|
||||
self.assertIn(b'Members', response.data)
|
||||
self.assertTrue(current_user.email == "ad@min.com")
|
||||
self.assertTrue(current_user.is_active())
|
||||
self.assertEqual(response.status_code, 200)
|
||||
|
||||
def test_logout_behaves_correctly(self):
|
||||
# Ensure logout behaves correctly - regarding the session.
|
||||
with self.client:
|
||||
self.client.post(
|
||||
'/login',
|
||||
data=dict(email="ad@min.com", password="admin_user"),
|
||||
follow_redirects=True
|
||||
)
|
||||
response = self.client.get('/logout', follow_redirects=True)
|
||||
self.assertIn(b'You were logged out. Bye!', response.data)
|
||||
self.assertFalse(current_user.is_active)
|
||||
|
||||
def test_logout_route_requires_login(self):
|
||||
# Ensure logout route requres logged in user.
|
||||
response = self.client.get('/logout', follow_redirects=True)
|
||||
self.assertIn(b'Please log in to access this page', response.data)
|
||||
|
||||
def test_member_route_requires_login(self):
|
||||
# Ensure member route requres logged in user.
|
||||
response = self.client.get('/members', follow_redirects=True)
|
||||
self.assertIn(b'Please log in to access this page', response.data)
|
||||
|
||||
def test_validate_success_login_form(self):
|
||||
# Ensure correct data validates.
|
||||
form = LoginForm(email='ad@min.com', password='admin_user')
|
||||
self.assertTrue(form.validate())
|
||||
|
||||
def test_validate_invalid_email_format(self):
|
||||
# Ensure invalid email format throws error.
|
||||
form = LoginForm(email='unknown', password='example')
|
||||
self.assertFalse(form.validate())
|
||||
|
||||
def test_get_by_id(self):
|
||||
# Ensure id is correct for the current/logged in user.
|
||||
with self.client:
|
||||
self.client.post('/login', data=dict(
|
||||
email='ad@min.com', password='admin_user'
|
||||
), follow_redirects=True)
|
||||
self.assertTrue(current_user.id == 1)
|
||||
|
||||
def test_registered_on_defaults_to_datetime(self):
|
||||
# Ensure that registered_on is a datetime.
|
||||
with self.client:
|
||||
self.client.post('/login', data=dict(
|
||||
email='ad@min.com', password='admin_user'
|
||||
), follow_redirects=True)
|
||||
user = User.query.filter_by(email='ad@min.com').first()
|
||||
self.assertIsInstance(user.registered_on, datetime.datetime)
|
||||
|
||||
def test_check_password(self):
|
||||
# Ensure given password is correct after unhashing.
|
||||
user = User.query.filter_by(email='ad@min.com').first()
|
||||
self.assertTrue(bcrypt.check_password_hash(user.password, 'admin_user'))
|
||||
self.assertFalse(bcrypt.check_password_hash(user.password, 'foobar'))
|
||||
|
||||
def test_validate_invalid_password(self):
|
||||
# Ensure user can't login when the pasword is incorrect.
|
||||
with self.client:
|
||||
response = self.client.post('/login', data=dict(
|
||||
email='ad@min.com', password='foo_bar'
|
||||
), follow_redirects=True)
|
||||
self.assertIn(b'Invalid email and/or password.', response.data)
|
||||
|
||||
def test_register_route(self):
|
||||
# Ensure about route behaves correctly.
|
||||
response = self.client.get('/register', follow_redirects=True)
|
||||
self.assertIn(b'<h1>Please Register</h1>\n', response.data)
|
||||
|
||||
def test_user_registration(self):
|
||||
# Ensure registration behaves correctlys.
|
||||
with self.client:
|
||||
response = self.client.post(
|
||||
'/register',
|
||||
data=dict(email="test@tester.com", password="testing",
|
||||
confirm="testing"),
|
||||
follow_redirects=True
|
||||
)
|
||||
self.assertIn(b'Welcome', response.data)
|
||||
self.assertTrue(current_user.email == "test@tester.com")
|
||||
self.assertTrue(current_user.is_active())
|
||||
self.assertEqual(response.status_code, 200)
|
||||
|
||||
|
||||
if __name__ == '__main__':
|
||||
unittest.main()
|
||||
|
|
@ -0,0 +1,58 @@
|
|||
# Tox (http://tox.testrun.org/) is a tool for running tests
|
||||
# in multiple virtualenvs. This configuration file will run the
|
||||
# test suite on all supported python versions. To use it, "pip install tox"
|
||||
# and then run "tox" from this directory.
|
||||
|
||||
[tox]
|
||||
# List the environment that will be run by default
|
||||
minversion = 1.6
|
||||
envlist = py27, py34, pep8, docs
|
||||
skipsdist = True
|
||||
|
||||
[testenv]
|
||||
setenv = VIRTUAL_ENV={envdir}
|
||||
LANG=en_US.UTF-8
|
||||
LANGUAGE=en_US:en
|
||||
LC_ALL=C
|
||||
|
||||
[testenv:py27]
|
||||
deps = -r{toxinidir}/test-requirements.txt
|
||||
-r{toxinidir}/requirements.txt
|
||||
|
||||
|
||||
commands =
|
||||
coverage run manage.py test
|
||||
coverage report -m
|
||||
|
||||
[testenv:py34]
|
||||
deps = -r{toxinidir}/test-requirements.txt
|
||||
-r{toxinidir}/requirements.txt
|
||||
|
||||
commands =
|
||||
coverage run manage.py test
|
||||
coverage report -m
|
||||
|
||||
[testenv:pep8]
|
||||
sitepackages = False
|
||||
deps = -r{toxinidir}/test-requirements.txt
|
||||
commands =
|
||||
flake8 {posargs}
|
||||
|
||||
[flake8]
|
||||
# E712 is ignored on purpose, since it is normal to use 'column == true'
|
||||
# in sqlalchemy.
|
||||
# H803 skipped on purpose per list discussion.
|
||||
# E125 is deliberately excluded. See https://github.com/jcrocholl/pep8/issues/126
|
||||
# The rest of the ignores are TODOs
|
||||
# New from hacking 0.9: E129, E131, E265, E713, H407, H405, H904
|
||||
# Stricter in hacking 0.9: F402
|
||||
# E251 Skipped due to https://github.com/jcrocholl/pep8/issues/301
|
||||
|
||||
max-line-length=120
|
||||
exclude = .venv,.git,.tox,dist,doc,*lib/python*,*egg,build,tools
|
||||
|
||||
[testenv:docs]
|
||||
deps=
|
||||
sphinx
|
||||
sphinx_rtd_theme
|
||||
commands = sphinx-build -W -b html doc/source doc/build
|
||||
|
|
@ -0,0 +1,254 @@
|
|||
# Mutil-host networking with etcd
|
||||
|
||||
## setup etcd cluster
|
||||
|
||||
在docker-node1上
|
||||
|
||||
```
|
||||
vagrant@docker-node1:~$ wget https://github.com/coreos/etcd/releases/download/v3.0.12/etcd-v3.0.12-linux-amd64.tar.gz
|
||||
vagrant@docker-node1:~$ tar zxvf etcd-v3.0.12-linux-amd64.tar.gz
|
||||
vagrant@docker-node1:~$ cd etcd-v3.0.12-linux-amd64
|
||||
vagrant@docker-node1:~$ nohup ./etcd --name docker-node1 --initial-advertise-peer-urls http://192.168.205.10:2380 \
|
||||
--listen-peer-urls http://192.168.205.10:2380 \
|
||||
--listen-client-urls http://192.168.205.10:2379,http://127.0.0.1:2379 \
|
||||
--advertise-client-urls http://192.168.205.10:2379 \
|
||||
--initial-cluster-token etcd-cluster \
|
||||
--initial-cluster docker-node1=http://192.168.205.10:2380,docker-node2=http://192.168.205.11:2380 \
|
||||
--initial-cluster-state new&
|
||||
```
|
||||
|
||||
|
||||
在docker-node2上
|
||||
|
||||
```
|
||||
vagrant@docker-node2:~$ wget https://github.com/coreos/etcd/releases/download/v3.0.12/etcd-v3.0.12-linux-amd64.tar.gz
|
||||
vagrant@docker-node2:~$ tar zxvf etcd-v3.0.12-linux-amd64.tar.gz
|
||||
vagrant@docker-node2:~$ cd etcd-v3.0.12-linux-amd64/
|
||||
vagrant@docker-node2:~$ nohup ./etcd --name docker-node2 --initial-advertise-peer-urls http://192.168.205.11:2380 \
|
||||
--listen-peer-urls http://192.168.205.11:2380 \
|
||||
--listen-client-urls http://192.168.205.11:2379,http://127.0.0.1:2379 \
|
||||
--advertise-client-urls http://192.168.205.11:2379 \
|
||||
--initial-cluster-token etcd-cluster \
|
||||
--initial-cluster docker-node1=http://192.168.205.10:2380,docker-node2=http://192.168.205.11:2380 \
|
||||
--initial-cluster-state new&
|
||||
```
|
||||
|
||||
检查cluster状态
|
||||
|
||||
```
|
||||
vagrant@docker-node2:~/etcd-v3.0.12-linux-amd64$ ./etcdctl cluster-health
|
||||
member 21eca106efe4caee is healthy: got healthy result from http://192.168.205.10:2379
|
||||
member 8614974c83d1cc6d is healthy: got healthy result from http://192.168.205.11:2379
|
||||
cluster is healthy
|
||||
```
|
||||
|
||||
## 重启docker服务
|
||||
|
||||
|
||||
在docker-node1上
|
||||
|
||||
```
|
||||
$ sudo service docker stop
|
||||
$ sudo /usr/bin/dockerd -H tcp://0.0.0.0:2375 -H unix:///var/run/docker.sock --cluster-store=etcd://192.168.205.10:2379 --cluster-advertise=192.168.205.10:2375&
|
||||
```
|
||||
|
||||
在docker-node2上
|
||||
|
||||
```
|
||||
$ sudo service docker stop
|
||||
$ sudo /usr/bin/dockerd -H tcp://0.0.0.0:2375 -H unix:///var/run/docker.sock --cluster-store=etcd://192.168.205.11:2379 --cluster-advertise=192.168.205.11:2375&
|
||||
```
|
||||
|
||||
## 创建overlay network
|
||||
|
||||
在docker-node1上创建一个demo的overlay network
|
||||
|
||||
```
|
||||
vagrant@docker-node1:~$ sudo docker network ls
|
||||
NETWORK ID NAME DRIVER SCOPE
|
||||
0e7bef3f143a bridge bridge local
|
||||
a5c7daf62325 host host local
|
||||
3198cae88ab4 none null local
|
||||
vagrant@docker-node1:~$ sudo docker network create -d overlay demo
|
||||
3d430f3338a2c3496e9edeccc880f0a7affa06522b4249497ef6c4cd6571eaa9
|
||||
vagrant@docker-node1:~$ sudo docker network ls
|
||||
NETWORK ID NAME DRIVER SCOPE
|
||||
0e7bef3f143a bridge bridge local
|
||||
3d430f3338a2 demo overlay global
|
||||
a5c7daf62325 host host local
|
||||
3198cae88ab4 none null local
|
||||
vagrant@docker-node1:~$ sudo docker network inspect demo
|
||||
[
|
||||
{
|
||||
"Name": "demo",
|
||||
"Id": "3d430f3338a2c3496e9edeccc880f0a7affa06522b4249497ef6c4cd6571eaa9",
|
||||
"Scope": "global",
|
||||
"Driver": "overlay",
|
||||
"EnableIPv6": false,
|
||||
"IPAM": {
|
||||
"Driver": "default",
|
||||
"Options": {},
|
||||
"Config": [
|
||||
{
|
||||
"Subnet": "10.0.0.0/24",
|
||||
"Gateway": "10.0.0.1/24"
|
||||
}
|
||||
]
|
||||
},
|
||||
"Internal": false,
|
||||
"Containers": {},
|
||||
"Options": {},
|
||||
"Labels": {}
|
||||
}
|
||||
]
|
||||
```
|
||||
|
||||
我们会看到在node2上，这个demo的overlay network会被同步创建
|
||||
|
||||
```
|
||||
vagrant@docker-node2:~$ sudo docker network ls
|
||||
NETWORK ID NAME DRIVER SCOPE
|
||||
c9947d4c3669 bridge bridge local
|
||||
3d430f3338a2 demo overlay global
|
||||
fa5168034de1 host host local
|
||||
c2ca34abec2a none null local
|
||||
```
|
||||
|
||||
通过查看etcd的key-value, 我们获取到，这个demo的network是通过etcd从node1同步到node2的
|
||||
|
||||
```
|
||||
vagrant@docker-node2:~/etcd-v3.0.12-linux-amd64$ ./etcdctl ls /docker
|
||||
/docker/network
|
||||
/docker/nodes
|
||||
vagrant@docker-node2:~/etcd-v3.0.12-linux-amd64$ ./etcdctl ls /docker/nodes
|
||||
/docker/nodes/192.168.205.11:2375
|
||||
/docker/nodes/192.168.205.10:2375
|
||||
vagrant@docker-node2:~/etcd-v3.0.12-linux-amd64$ ./etcdctl ls /docker/network/v1.0/network
|
||||
/docker/network/v1.0/network/3d430f3338a2c3496e9edeccc880f0a7affa06522b4249497ef6c4cd6571eaa9
|
||||
vagrant@docker-node2:~/etcd-v3.0.12-linux-amd64$ ./etcdctl get /docker/network/v1.0/network/3d430f3338a2c3496e9edeccc880f0a7affa06522b4249497ef6c4cd6571eaa9 | jq .
|
||||
{
|
||||
"addrSpace": "GlobalDefault",
|
||||
"enableIPv6": false,
|
||||
"generic": {
|
||||
"com.docker.network.enable_ipv6": false,
|
||||
"com.docker.network.generic": {}
|
||||
},
|
||||
"id": "3d430f3338a2c3496e9edeccc880f0a7affa06522b4249497ef6c4cd6571eaa9",
|
||||
"inDelete": false,
|
||||
"ingress": false,
|
||||
"internal": false,
|
||||
"ipamOptions": {},
|
||||
"ipamType": "default",
|
||||
"ipamV4Config": "[{\"PreferredPool\":\"\",\"SubPool\":\"\",\"Gateway\":\"\",\"AuxAddresses\":null}]",
|
||||
"ipamV4Info": "[{\"IPAMData\":\"{\\\"AddressSpace\\\":\\\"GlobalDefault\\\",\\\"Gateway\\\":\\\"10.0.0.1/24\\\",\\\"Pool\\\":\\\"10.0.0.0/24\\\"}\",\"PoolID\":\"GlobalDefault/10.0.0.0/24\"}]",
|
||||
"labels": {},
|
||||
"name": "demo",
|
||||
"networkType": "overlay",
|
||||
"persist": true,
|
||||
"postIPv6": false,
|
||||
"scope": "global"
|
||||
}
|
||||
```
|
||||
|
||||
|
||||
## 创建连接demo网络的容器
|
||||
|
||||
在docker-node1上
|
||||
|
||||
```
|
||||
vagrant@docker-node1:~$ sudo docker run -d --name test1 --net demo busybox sh -c "while true; do sleep 3600; done"
|
||||
Unable to find image 'busybox:latest' locally
|
||||
latest: Pulling from library/busybox
|
||||
56bec22e3559: Pull complete
|
||||
Digest: sha256:29f5d56d12684887bdfa50dcd29fc31eea4aaf4ad3bec43daf19026a7ce69912
|
||||
Status: Downloaded newer image for busybox:latest
|
||||
a95a9466331dd9305f9f3c30e7330b5a41aae64afda78f038fc9e04900fcac54
|
||||
vagrant@docker-node1:~$ sudo docker ps
|
||||
CONTAINER ID IMAGE COMMAND CREATED STATUS PORTS NAMES
|
||||
a95a9466331d busybox "sh -c 'while true; d" 4 seconds ago Up 3 seconds test1
|
||||
vagrant@docker-node1:~$ sudo docker exec test1 ifconfig
|
||||
eth0 Link encap:Ethernet HWaddr 02:42:0A:00:00:02
|
||||
inet addr:10.0.0.2 Bcast:0.0.0.0 Mask:255.255.255.0
|
||||
inet6 addr: fe80::42:aff:fe00:2/64 Scope:Link
|
||||
UP BROADCAST RUNNING MULTICAST MTU:1450 Metric:1
|
||||
RX packets:15 errors:0 dropped:0 overruns:0 frame:0
|
||||
TX packets:8 errors:0 dropped:0 overruns:0 carrier:0
|
||||
collisions:0 txqueuelen:0
|
||||
RX bytes:1206 (1.1 KiB) TX bytes:648 (648.0 B)
|
||||
|
||||
eth1 Link encap:Ethernet HWaddr 02:42:AC:12:00:02
|
||||
inet addr:172.18.0.2 Bcast:0.0.0.0 Mask:255.255.0.0
|
||||
inet6 addr: fe80::42:acff:fe12:2/64 Scope:Link
|
||||
UP BROADCAST RUNNING MULTICAST MTU:1500 Metric:1
|
||||
RX packets:8 errors:0 dropped:0 overruns:0 frame:0
|
||||
TX packets:8 errors:0 dropped:0 overruns:0 carrier:0
|
||||
collisions:0 txqueuelen:0
|
||||
RX bytes:648 (648.0 B) TX bytes:648 (648.0 B)
|
||||
|
||||
lo Link encap:Local Loopback
|
||||
inet addr:127.0.0.1 Mask:255.0.0.0
|
||||
inet6 addr: ::1/128 Scope:Host
|
||||
UP LOOPBACK RUNNING MTU:65536 Metric:1
|
||||
RX packets:0 errors:0 dropped:0 overruns:0 frame:0
|
||||
TX packets:0 errors:0 dropped:0 overruns:0 carrier:0
|
||||
collisions:0 txqueuelen:1
|
||||
RX bytes:0 (0.0 B) TX bytes:0 (0.0 B)
|
||||
|
||||
vagrant@docker-node1:~$
|
||||
```
|
||||
|
||||
在docker-node2上
|
||||
|
||||
```
|
||||
vagrant@docker-node2:~$ sudo docker run -d --name test1 --net demo busybox sh -c "while true; do sleep 3600; done"
|
||||
Unable to find image 'busybox:latest' locally
|
||||
latest: Pulling from library/busybox
|
||||
56bec22e3559: Pull complete
|
||||
Digest: sha256:29f5d56d12684887bdfa50dcd29fc31eea4aaf4ad3bec43daf19026a7ce69912
|
||||
Status: Downloaded newer image for busybox:latest
|
||||
fad6dc6538a85d3dcc958e8ed7b1ec3810feee3e454c1d3f4e53ba25429b290b
|
||||
docker: Error response from daemon: service endpoint with name test1 already exists.
|
||||
vagrant@docker-node2:~$ sudo docker run -d --name test2 --net demo busybox sh -c "while true; do sleep 3600; done"
|
||||
9d494a2f66a69e6b861961d0c6af2446265bec9b1d273d7e70d0e46eb2e98d20
|
||||
```
|
||||
|
||||
|
||||
验证连通性。
|
||||
|
||||
```
|
||||
vagrant@docker-node2:~$ sudo docker exec -it test2 ifconfig
|
||||
eth0 Link encap:Ethernet HWaddr 02:42:0A:00:00:03
|
||||
inet addr:10.0.0.3 Bcast:0.0.0.0 Mask:255.255.255.0
|
||||
inet6 addr: fe80::42:aff:fe00:3/64 Scope:Link
|
||||
UP BROADCAST RUNNING MULTICAST MTU:1450 Metric:1
|
||||
RX packets:208 errors:0 dropped:0 overruns:0 frame:0
|
||||
TX packets:201 errors:0 dropped:0 overruns:0 carrier:0
|
||||
collisions:0 txqueuelen:0
|
||||
RX bytes:20008 (19.5 KiB) TX bytes:19450 (18.9 KiB)
|
||||
|
||||
eth1 Link encap:Ethernet HWaddr 02:42:AC:12:00:02
|
||||
inet addr:172.18.0.2 Bcast:0.0.0.0 Mask:255.255.0.0
|
||||
inet6 addr: fe80::42:acff:fe12:2/64 Scope:Link
|
||||
UP BROADCAST RUNNING MULTICAST MTU:1500 Metric:1
|
||||
RX packets:8 errors:0 dropped:0 overruns:0 frame:0
|
||||
TX packets:8 errors:0 dropped:0 overruns:0 carrier:0
|
||||
collisions:0 txqueuelen:0
|
||||
RX bytes:648 (648.0 B) TX bytes:648 (648.0 B)
|
||||
|
||||
lo Link encap:Local Loopback
|
||||
inet addr:127.0.0.1 Mask:255.0.0.0
|
||||
inet6 addr: ::1/128 Scope:Host
|
||||
UP LOOPBACK RUNNING MTU:65536 Metric:1
|
||||
RX packets:0 errors:0 dropped:0 overruns:0 frame:0
|
||||
TX packets:0 errors:0 dropped:0 overruns:0 carrier:0
|
||||
collisions:0 txqueuelen:1
|
||||
RX bytes:0 (0.0 B) TX bytes:0 (0.0 B)
|
||||
|
||||
vagrant@docker-node1:~$ sudo docker exec test1 sh -c "ping 10.0.0.3"
|
||||
PING 10.0.0.3 (10.0.0.3): 56 data bytes
|
||||
64 bytes from 10.0.0.3: seq=0 ttl=64 time=0.579 ms
|
||||
64 bytes from 10.0.0.3: seq=1 ttl=64 time=0.411 ms
|
||||
64 bytes from 10.0.0.3: seq=2 ttl=64 time=0.483 ms
|
||||
^C
|
||||
vagrant@docker-node1:~$
|
||||
```
|
||||
|
|
@ -0,0 +1,15 @@
|
|||
#/bin/sh
|
||||
|
||||
# install some tools
|
||||
sudo yum install -y git vim gcc glibc-static telnet bridge-utils
|
||||
|
||||
# install docker
|
||||
curl -fsSL get.docker.com -o get-docker.sh
|
||||
sh get-docker.sh
|
||||
|
||||
# start docker service
|
||||
sudo groupadd docker
|
||||
sudo usermod -aG docker vagrant
|
||||
sudo systemctl start docker
|
||||
|
||||
rm -rf get-docker.sh
|
||||
|
|
@ -0,0 +1,34 @@
|
|||
# -*- mode: ruby -*-
|
||||
# vi: set ft=ruby :
|
||||
|
||||
Vagrant.require_version ">= 1.6.0"
|
||||
|
||||
boxes = [
|
||||
{
|
||||
:name => "docker-host",
|
||||
:eth1 => "192.168.205.10",
|
||||
:mem => "1024",
|
||||
:cpu => "1"
|
||||
}
|
||||
]
|
||||
|
||||
Vagrant.configure(2) do |config|
|
||||
|
||||
config.vm.box = "centos/7"
|
||||
boxes.each do |opts|
|
||||
config.vm.define opts[:name] do |config|
|
||||
config.vm.hostname = opts[:name]
|
||||
config.vm.provider "vmware_fusion" do |v|
|
||||
v.vmx["memsize"] = opts[:mem]
|
||||
v.vmx["numvcpus"] = opts[:cpu]
|
||||
end
|
||||
config.vm.provider "virtualbox" do |v|
|
||||
v.customize ["modifyvm", :id, "--memory", opts[:mem]]
|
||||
v.customize ["modifyvm", :id, "--cpus", opts[:cpu]]
|
||||
end
|
||||
config.vm.network :private_network, ip: opts[:eth1]
|
||||
end
|
||||
end
|
||||
config.vm.synced_folder "./labs", "/home/vagrant/labs"
|
||||
config.vm.provision "shell", privileged: true, path: "./setup.sh"
|
||||
end
|
||||
|
|
@ -0,0 +1,12 @@
|
|||
# this same shows how we can extend/change an existing official image from Docker Hub
|
||||
|
||||
FROM nginx:latest
|
||||
# highly recommend you always pin versions for anything beyond dev/learn
|
||||
|
||||
WORKDIR /usr/share/nginx/html
|
||||
# change working directory to root of nginx webhost
|
||||
# using WORKDIR is prefered to using 'RUN cd /some/path'
|
||||
|
||||
COPY index.html index.html
|
||||
|
||||
# I don't have to specify EXPOSE or CMD because they're in my FROM
|
||||
|
|
@ -0,0 +1,13 @@
|
|||
<!doctype html>
|
||||
<html lang="en">
|
||||
<head>
|
||||
<meta charset="utf-8">
|
||||
|
||||
<title>hello</title>
|
||||
|
||||
</head>
|
||||
|
||||
<body>
|
||||
<h1>Hello Docker! </h1>
|
||||
</body>
|
||||
</html>
|
||||
|
|
@ -0,0 +1,8 @@
|
|||
FROM python:2.7-alpine
|
||||
LABEL maintainer="Peng Xiao<xiaoquwl@gmail.com>"
|
||||
RUN pip install flask Flask-Script
|
||||
COPY . /app/
|
||||
WORKDIR /app
|
||||
EXPOSE 5000
|
||||
ENTRYPOINT [ "python", "manage.py" ]
|
||||
CMD []
|
||||
|
|
@ -0,0 +1,12 @@
|
|||
from flask import Flask
|
||||
app = Flask(__name__)
|
||||
@app.route('/')
|
||||
def hello():
|
||||
return "hello dockeddr"
|
||||
|
||||
from flask_script import Manager
|
||||
|
||||
manager = Manager(app)
|
||||
|
||||
if __name__ == '__main__':
|
||||
manager.run()
|
||||
|
|
@ -0,0 +1,16 @@
|
|||
[run]
|
||||
source = skeleton
|
||||
omit =
|
||||
skeleton/tests/*
|
||||
*/__init__.py
|
||||
|
||||
[report]
|
||||
exclude_lines =
|
||||
def __repr__
|
||||
def __str__
|
||||
def parse_args
|
||||
pragma: no cover
|
||||
raise NotImplementedError
|
||||
if __name__ == .__main__.:
|
||||
|
||||
ignore_errors = True
|
||||
|
|
@ -0,0 +1,91 @@
|
|||
# Byte-compiled / optimized / DLL files
|
||||
__pycache__/
|
||||
*.py[cod]
|
||||
*$py.class
|
||||
|
||||
# C extensions
|
||||
*.so
|
||||
|
||||
# Distribution / packaging
|
||||
.Python
|
||||
env/
|
||||
build/
|
||||
develop-eggs/
|
||||
dist/
|
||||
downloads/
|
||||
eggs/
|
||||
.eggs/
|
||||
lib/
|
||||
lib64/
|
||||
parts/
|
||||
sdist/
|
||||
var/
|
||||
*.egg-info/
|
||||
.installed.cfg
|
||||
*.egg
|
||||
|
||||
# PyInstaller
|
||||
# Usually these files are written by a python script from a template
|
||||
# before PyInstaller builds the exe, so as to inject date/other infos into it.
|
||||
*.manifest
|
||||
*.spec
|
||||
|
||||
# Installer logs
|
||||
pip-log.txt
|
||||
pip-delete-this-directory.txt
|
||||
|
||||
# Unit test / coverage reports
|
||||
htmlcov/
|
||||
.tox/
|
||||
.coverage
|
||||
.coverage.*
|
||||
.cache
|
||||
nosetests.xml
|
||||
coverage.xml
|
||||
*,cover
|
||||
.hypothesis/
|
||||
|
||||
# Translations
|
||||
*.mo
|
||||
*.pot
|
||||
|
||||
# Django stuff:
|
||||
*.log
|
||||
local_settings.py
|
||||
|
||||
# Flask stuff:
|
||||
instance/
|
||||
.webassets-cache
|
||||
|
||||
# Scrapy stuff:
|
||||
.scrapy
|
||||
|
||||
# Sphinx documentation
|
||||
docs/_build/
|
||||
|
||||
# PyBuilder
|
||||
target/
|
||||
|
||||
# IPython Notebook
|
||||
.ipynb_checkpoints
|
||||
|
||||
# pyenv
|
||||
.python-version
|
||||
|
||||
# celery beat schedule file
|
||||
celerybeat-schedule
|
||||
|
||||
# dotenv
|
||||
.env
|
||||
|
||||
# virtualenv
|
||||
venv/
|
||||
ENV/
|
||||
|
||||
# Spyder project settings
|
||||
.spyderproject
|
||||
|
||||
# Rope project settings
|
||||
.ropeproject
|
||||
|
||||
*.sqlite
|
||||
|
|
@ -0,0 +1,62 @@
|
|||
variables:
|
||||
GIT_SSL_NO_VERIFY: "1"
|
||||
|
||||
stages:
|
||||
- test
|
||||
- build
|
||||
- deploy
|
||||
|
||||
pep8:
|
||||
stage: test
|
||||
image: python:2.7
|
||||
script:
|
||||
- pip install tox
|
||||
- tox -e pep8
|
||||
tags:
|
||||
- python27
|
||||
|
||||
unittest-py27:
|
||||
stage: test
|
||||
image: python:2.7
|
||||
script:
|
||||
- pip install tox
|
||||
- tox -e py27
|
||||
tags:
|
||||
- python27
|
||||
|
||||
unittest-py34:
|
||||
stage: test
|
||||
image: python:3.4
|
||||
script:
|
||||
- pip install tox
|
||||
- tox -e py34
|
||||
tags:
|
||||
- python34
|
||||
|
||||
sphnix:
|
||||
stage: test
|
||||
image: python:2.7
|
||||
script:
|
||||
- pip install tox
|
||||
- tox -e docs
|
||||
tags:
|
||||
- python27
|
||||
|
||||
build:
|
||||
stage: build
|
||||
tags:
|
||||
- shell
|
||||
script:
|
||||
- docker build -t skeleton .
|
||||
only:
|
||||
- master
|
||||
|
||||
deploy:
|
||||
stage: deploy
|
||||
tags:
|
||||
- shell
|
||||
script:
|
||||
- scripts/deploy.sh
|
||||
- export
|
||||
only:
|
||||
- master
|
||||
|
|
@ -0,0 +1,28 @@
|
|||
### Summary
|
||||
|
||||
(Summarize the bug encountered concisely)
|
||||
|
||||
### Steps to reproduce
|
||||
|
||||
(How one can reproduce the issue - this is very important)
|
||||
|
||||
### Expected behavior
|
||||
|
||||
(What you should see instead)
|
||||
|
||||
### Actual behaviour
|
||||
|
||||
(What actually happens)
|
||||
|
||||
### Relevant logs and/or screenshots
|
||||
|
||||
(Paste any relevant logs - please use code blocks (```) to format console output,
|
||||
logs, and code as it's very hard to read otherwise.)
|
||||
|
||||
|
||||
### Possible fixes
|
||||
|
||||
(If you can, link to the line of code that might be responsible for the problem)
|
||||
|
||||
|
||||
/label ~"Bug"
|
||||
|
|
@ -0,0 +1,7 @@
|
|||
### Feature Description
|
||||
|
||||
|
||||
### Implementation
|
||||
|
||||
|
||||
/label ~"Feature"
|
||||
|
|
@ -0,0 +1,15 @@
|
|||
**1. Explain what do you want to merge**
|
||||
|
||||
-
|
||||
-
|
||||
|
||||
**2. Does this MR meet the acceptance criteria?**
|
||||
|
||||
- [ ] I have read [Contribution guidelines](https://as-gitlab.cisco.com/demo/skeleton/blob/master/CONTRIBUTING.md)
|
||||
- [ ] I have run the command `tox` locally and get successful results.
|
||||
- [ ] Branch has no merge conflicts with master (if you do - rebase it please)
|
||||
|
||||
**3. What are the relevant issue numbers?**
|
||||
|
||||
|
||||
Thanks for your MR, you're awesome! :+1:
|
||||
|
|
@ -0,0 +1,18 @@
|
|||
# Hacking Guide
|
||||
|
||||
## Code style
|
||||
|
||||
Step 1: Read http://www.python.org/dev/peps/pep-0008/
|
||||
|
||||
Step 2: Read http://www.python.org/dev/peps/pep-0008/ again
|
||||
|
||||
Step 3: Read on
|
||||
|
||||
## Running Tests
|
||||
|
||||
Run tox
|
||||
|
||||
```
|
||||
$ cd skeleton
|
||||
$ tox
|
||||
```
|
||||
|
|
@ -0,0 +1,8 @@
|
|||
FROM python:2.7
|
||||
LABEL maintainer="Peng Xiao<xiaoquwl@gmail.com>"
|
||||
|
||||
COPY . /skeleton
|
||||
WORKDIR /skeleton
|
||||
RUN pip install -r requirements.txt
|
||||
EXPOSE 5000
|
||||
ENTRYPOINT ["scripts/dev.sh"]
|
||||
|
|
@ -0,0 +1,8 @@
|
|||
The MIT License (MIT)
|
||||
Copyright (c) 2016 Michael Herman
|
||||
|
||||
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
|
||||
|
||||
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
|
||||
|
||||
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
|
||||
|
|
@ -0,0 +1,58 @@
|
|||
[](https://gitlab-demo.com/Demo/flask-skeleton/commits/master)
|
||||
[](https://gitlab-demo.com/Demo/flask-skeleton/commits/master)
|
||||
|
||||
|
||||
# Flask Skeleton
|
||||
|
||||
Flask starter project...
|
||||
|
||||
## Quick Start
|
||||
|
||||
### Basics
|
||||
|
||||
1. Activate a virtualenv
|
||||
1. Install the requirements
|
||||
|
||||
### Set Environment Variables
|
||||
|
||||
Update *skeleton/server/config.py*, and then run:
|
||||
|
||||
```sh
|
||||
$ export APP_SETTINGS="skeleton.server.config.DevelopmentConfig"
|
||||
```
|
||||
|
||||
or
|
||||
|
||||
```sh
|
||||
$ export APP_SETTINGS="skeleton.server.config.ProductionConfig"
|
||||
```
|
||||
|
||||
### Create DB
|
||||
|
||||
```sh
|
||||
$ python manage.py create_db
|
||||
$ python manage.py db init
|
||||
$ python manage.py db migrate
|
||||
$ python manage.py create_admin
|
||||
$ python manage.py create_data
|
||||
```
|
||||
|
||||
### Run the Application
|
||||
|
||||
```sh
|
||||
$ python manage.py runserver
|
||||
```
|
||||
|
||||
So access the application at the address [http://localhost:5000/](http://localhost:5000/)
|
||||
|
||||
> Want to specify a different port?
|
||||
|
||||
> ```sh
|
||||
> $ python manage.py runserver -h 0.0.0.0 -p 8080
|
||||
> ```
|
||||
|
||||
### Testing1
|
||||
|
||||
```
|
||||
$ tox
|
||||
```
|
||||
|
|
@ -0,0 +1,225 @@
|
|||
# Makefile for Sphinx documentation
|
||||
#
|
||||
|
||||
# You can set these variables from the command line.
|
||||
SPHINXOPTS =
|
||||
SPHINXBUILD = sphinx-build
|
||||
PAPER =
|
||||
BUILDDIR = build
|
||||
|
||||
# Internal variables.
|
||||
PAPEROPT_a4 = -D latex_paper_size=a4
|
||||
PAPEROPT_letter = -D latex_paper_size=letter
|
||||
ALLSPHINXOPTS = -d $(BUILDDIR)/doctrees $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) source
|
||||
# the i18n builder cannot share the environment and doctrees with the others
|
||||
I18NSPHINXOPTS = $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) source
|
||||
|
||||
.PHONY: help
|
||||
help:
|
||||
@echo "Please use \`make <target>' where <target> is one of"
|
||||
@echo " html to make standalone HTML files"
|
||||
@echo " dirhtml to make HTML files named index.html in directories"
|
||||
@echo " singlehtml to make a single large HTML file"
|
||||
@echo " pickle to make pickle files"
|
||||
@echo " json to make JSON files"
|
||||
@echo " htmlhelp to make HTML files and a HTML help project"
|
||||
@echo " qthelp to make HTML files and a qthelp project"
|
||||
@echo " applehelp to make an Apple Help Book"
|
||||
@echo " devhelp to make HTML files and a Devhelp project"
|
||||
@echo " epub to make an epub"
|
||||
@echo " epub3 to make an epub3"
|
||||
@echo " latex to make LaTeX files, you can set PAPER=a4 or PAPER=letter"
|
||||
@echo " latexpdf to make LaTeX files and run them through pdflatex"
|
||||
@echo " latexpdfja to make LaTeX files and run them through platex/dvipdfmx"
|
||||
@echo " text to make text files"
|
||||
@echo " man to make manual pages"
|
||||
@echo " texinfo to make Texinfo files"
|
||||
@echo " info to make Texinfo files and run them through makeinfo"
|
||||
@echo " gettext to make PO message catalogs"
|
||||
@echo " changes to make an overview of all changed/added/deprecated items"
|
||||
@echo " xml to make Docutils-native XML files"
|
||||
@echo " pseudoxml to make pseudoxml-XML files for display purposes"
|
||||
@echo " linkcheck to check all external links for integrity"
|
||||
@echo " doctest to run all doctests embedded in the documentation (if enabled)"
|
||||
@echo " coverage to run coverage check of the documentation (if enabled)"
|
||||
@echo " dummy to check syntax errors of document sources"
|
||||
|
||||
.PHONY: clean
|
||||
clean:
|
||||
rm -rf $(BUILDDIR)/*
|
||||
|
||||
.PHONY: html
|
||||
html:
|
||||
$(SPHINXBUILD) -b html $(ALLSPHINXOPTS) $(BUILDDIR)/html
|
||||
@echo
|
||||
@echo "Build finished. The HTML pages are in $(BUILDDIR)/html."
|
||||
|
||||
.PHONY: dirhtml
|
||||
dirhtml:
|
||||
$(SPHINXBUILD) -b dirhtml $(ALLSPHINXOPTS) $(BUILDDIR)/dirhtml
|
||||
@echo
|
||||
@echo "Build finished. The HTML pages are in $(BUILDDIR)/dirhtml."
|
||||
|
||||
.PHONY: singlehtml
|
||||
singlehtml:
|
||||
$(SPHINXBUILD) -b singlehtml $(ALLSPHINXOPTS) $(BUILDDIR)/singlehtml
|
||||
@echo
|
||||
@echo "Build finished. The HTML page is in $(BUILDDIR)/singlehtml."
|
||||
|
||||
.PHONY: pickle
|
||||
pickle:
|
||||
$(SPHINXBUILD) -b pickle $(ALLSPHINXOPTS) $(BUILDDIR)/pickle
|
||||
@echo
|
||||
@echo "Build finished; now you can process the pickle files."
|
||||
|
||||
.PHONY: json
|
||||
json:
|
||||
$(SPHINXBUILD) -b json $(ALLSPHINXOPTS) $(BUILDDIR)/json
|
||||
@echo
|
||||
@echo "Build finished; now you can process the JSON files."
|
||||
|
||||
.PHONY: htmlhelp
|
||||
htmlhelp:
|
||||
$(SPHINXBUILD) -b htmlhelp $(ALLSPHINXOPTS) $(BUILDDIR)/htmlhelp
|
||||
@echo
|
||||
@echo "Build finished; now you can run HTML Help Workshop with the" \
|
||||
".hhp project file in $(BUILDDIR)/htmlhelp."
|
||||
|
||||
.PHONY: qthelp
|
||||
qthelp:
|
||||
$(SPHINXBUILD) -b qthelp $(ALLSPHINXOPTS) $(BUILDDIR)/qthelp
|
||||
@echo
|
||||
@echo "Build finished; now you can run "qcollectiongenerator" with the" \
|
||||
".qhcp project file in $(BUILDDIR)/qthelp, like this:"
|
||||
@echo "# qcollectiongenerator $(BUILDDIR)/qthelp/yacore.qhcp"
|
||||
@echo "To view the help file:"
|
||||
@echo "# assistant -collectionFile $(BUILDDIR)/qthelp/yacore.qhc"
|
||||
|
||||
.PHONY: applehelp
|
||||
applehelp:
|
||||
$(SPHINXBUILD) -b applehelp $(ALLSPHINXOPTS) $(BUILDDIR)/applehelp
|
||||
@echo
|
||||
@echo "Build finished. The help book is in $(BUILDDIR)/applehelp."
|
||||
@echo "N.B. You won't be able to view it unless you put it in" \
|
||||
"~/Library/Documentation/Help or install it in your application" \
|
||||
"bundle."
|
||||
|
||||
.PHONY: devhelp
|
||||
devhelp:
|
||||
$(SPHINXBUILD) -b devhelp $(ALLSPHINXOPTS) $(BUILDDIR)/devhelp
|
||||
@echo
|
||||
@echo "Build finished."
|
||||
@echo "To view the help file:"
|
||||
@echo "# mkdir -p $$HOME/.local/share/devhelp/yacore"
|
||||
@echo "# ln -s $(BUILDDIR)/devhelp $$HOME/.local/share/devhelp/yacore"
|
||||
@echo "# devhelp"
|
||||
|
||||
.PHONY: epub
|
||||
epub:
|
||||
$(SPHINXBUILD) -b epub $(ALLSPHINXOPTS) $(BUILDDIR)/epub
|
||||
@echo
|
||||
@echo "Build finished. The epub file is in $(BUILDDIR)/epub."
|
||||
|
||||
.PHONY: epub3
|
||||
epub3:
|
||||
$(SPHINXBUILD) -b epub3 $(ALLSPHINXOPTS) $(BUILDDIR)/epub3
|
||||
@echo
|
||||
@echo "Build finished. The epub3 file is in $(BUILDDIR)/epub3."
|
||||
|
||||
.PHONY: latex
|
||||
latex:
|
||||
$(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
|
||||
@echo
|
||||
@echo "Build finished; the LaTeX files are in $(BUILDDIR)/latex."
|
||||
@echo "Run \`make' in that directory to run these through (pdf)latex" \
|
||||
"(use \`make latexpdf' here to do that automatically)."
|
||||
|
||||
.PHONY: latexpdf
|
||||
latexpdf:
|
||||
$(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
|
||||
@echo "Running LaTeX files through pdflatex..."
|
||||
$(MAKE) -C $(BUILDDIR)/latex all-pdf
|
||||
@echo "pdflatex finished; the PDF files are in $(BUILDDIR)/latex."
|
||||
|
||||
.PHONY: latexpdfja
|
||||
latexpdfja:
|
||||
$(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
|
||||
@echo "Running LaTeX files through platex and dvipdfmx..."
|
||||
$(MAKE) -C $(BUILDDIR)/latex all-pdf-ja
|
||||
@echo "pdflatex finished; the PDF files are in $(BUILDDIR)/latex."
|
||||
|
||||
.PHONY: text
|
||||
text:
|
||||
$(SPHINXBUILD) -b text $(ALLSPHINXOPTS) $(BUILDDIR)/text
|
||||
@echo
|
||||
@echo "Build finished. The text files are in $(BUILDDIR)/text."
|
||||
|
||||
.PHONY: man
|
||||
man:
|
||||
$(SPHINXBUILD) -b man $(ALLSPHINXOPTS) $(BUILDDIR)/man
|
||||
@echo
|
||||
@echo "Build finished. The manual pages are in $(BUILDDIR)/man."
|
||||
|
||||
.PHONY: texinfo
|
||||
texinfo:
|
||||
$(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo
|
||||
@echo
|
||||
@echo "Build finished. The Texinfo files are in $(BUILDDIR)/texinfo."
|
||||
@echo "Run \`make' in that directory to run these through makeinfo" \
|
||||
"(use \`make info' here to do that automatically)."
|
||||
|
||||
.PHONY: info
|
||||
info:
|
||||
$(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo
|
||||
@echo "Running Texinfo files through makeinfo..."
|
||||
make -C $(BUILDDIR)/texinfo info
|
||||
@echo "makeinfo finished; the Info files are in $(BUILDDIR)/texinfo."
|
||||
|
||||
.PHONY: gettext
|
||||
gettext:
|
||||
$(SPHINXBUILD) -b gettext $(I18NSPHINXOPTS) $(BUILDDIR)/locale
|
||||
@echo
|
||||
@echo "Build finished. The message catalogs are in $(BUILDDIR)/locale."
|
||||
|
||||
.PHONY: changes
|
||||
changes:
|
||||
$(SPHINXBUILD) -b changes $(ALLSPHINXOPTS) $(BUILDDIR)/changes
|
||||
@echo
|
||||
@echo "The overview file is in $(BUILDDIR)/changes."
|
||||
|
||||
.PHONY: linkcheck
|
||||
linkcheck:
|
||||
$(SPHINXBUILD) -b linkcheck $(ALLSPHINXOPTS) $(BUILDDIR)/linkcheck
|
||||
@echo
|
||||
@echo "Link check complete; look for any errors in the above output " \
|
||||
"or in $(BUILDDIR)/linkcheck/output.txt."
|
||||
|
||||
.PHONY: doctest
|
||||
doctest:
|
||||
$(SPHINXBUILD) -b doctest $(ALLSPHINXOPTS) $(BUILDDIR)/doctest
|
||||
@echo "Testing of doctests in the sources finished, look at the " \
|
||||
"results in $(BUILDDIR)/doctest/output.txt."
|
||||
|
||||
.PHONY: coverage
|
||||
coverage:
|
||||
$(SPHINXBUILD) -b coverage $(ALLSPHINXOPTS) $(BUILDDIR)/coverage
|
||||
@echo "Testing of coverage in the sources finished, look at the " \
|
||||
"results in $(BUILDDIR)/coverage/python.txt."
|
||||
|
||||
.PHONY: xml
|
||||
xml:
|
||||
$(SPHINXBUILD) -b xml $(ALLSPHINXOPTS) $(BUILDDIR)/xml
|
||||
@echo
|
||||
@echo "Build finished. The XML files are in $(BUILDDIR)/xml."
|
||||
|
||||
.PHONY: pseudoxml
|
||||
pseudoxml:
|
||||
$(SPHINXBUILD) -b pseudoxml $(ALLSPHINXOPTS) $(BUILDDIR)/pseudoxml
|
||||
@echo
|
||||
@echo "Build finished. The pseudo-XML files are in $(BUILDDIR)/pseudoxml."
|
||||
|
||||
.PHONY: dummy
|
||||
dummy:
|
||||
$(SPHINXBUILD) -b dummy $(ALLSPHINXOPTS) $(BUILDDIR)/dummy
|
||||
@echo
|
||||
@echo "Build finished. Dummy builder generates no files."
|
||||
|
|
@ -0,0 +1,281 @@
|
|||
@ECHO OFF
|
||||
|
||||
REM Command file for Sphinx documentation
|
||||
|
||||
if "%SPHINXBUILD%" == "" (
|
||||
set SPHINXBUILD=sphinx-build
|
||||
)
|
||||
set BUILDDIR=build
|
||||
set ALLSPHINXOPTS=-d %BUILDDIR%/doctrees %SPHINXOPTS% source
|
||||
set I18NSPHINXOPTS=%SPHINXOPTS% source
|
||||
if NOT "%PAPER%" == "" (
|
||||
set ALLSPHINXOPTS=-D latex_paper_size=%PAPER% %ALLSPHINXOPTS%
|
||||
set I18NSPHINXOPTS=-D latex_paper_size=%PAPER% %I18NSPHINXOPTS%
|
||||
)
|
||||
|
||||
if "%1" == "" goto help
|
||||
|
||||
if "%1" == "help" (
|
||||
:help
|
||||
echo.Please use `make ^<target^>` where ^<target^> is one of
|
||||
echo. html to make standalone HTML files
|
||||
echo. dirhtml to make HTML files named index.html in directories
|
||||
echo. singlehtml to make a single large HTML file
|
||||
echo. pickle to make pickle files
|
||||
echo. json to make JSON files
|
||||
echo. htmlhelp to make HTML files and a HTML help project
|
||||
echo. qthelp to make HTML files and a qthelp project
|
||||
echo. devhelp to make HTML files and a Devhelp project
|
||||
echo. epub to make an epub
|
||||
echo. epub3 to make an epub3
|
||||
echo. latex to make LaTeX files, you can set PAPER=a4 or PAPER=letter
|
||||
echo. text to make text files
|
||||
echo. man to make manual pages
|
||||
echo. texinfo to make Texinfo files
|
||||
echo. gettext to make PO message catalogs
|
||||
echo. changes to make an overview over all changed/added/deprecated items
|
||||
echo. xml to make Docutils-native XML files
|
||||
echo. pseudoxml to make pseudoxml-XML files for display purposes
|
||||
echo. linkcheck to check all external links for integrity
|
||||
echo. doctest to run all doctests embedded in the documentation if enabled
|
||||
echo. coverage to run coverage check of the documentation if enabled
|
||||
echo. dummy to check syntax errors of document sources
|
||||
goto end
|
||||
)
|
||||
|
||||
if "%1" == "clean" (
|
||||
for /d %%i in (%BUILDDIR%\*) do rmdir /q /s %%i
|
||||
del /q /s %BUILDDIR%\*
|
||||
goto end
|
||||
)
|
||||
|
||||
|
||||
REM Check if sphinx-build is available and fallback to Python version if any
|
||||
%SPHINXBUILD% 1>NUL 2>NUL
|
||||
if errorlevel 9009 goto sphinx_python
|
||||
goto sphinx_ok
|
||||
|
||||
:sphinx_python
|
||||
|
||||
set SPHINXBUILD=python -m sphinx.__init__
|
||||
%SPHINXBUILD% 2> nul
|
||||
if errorlevel 9009 (
|
||||
echo.
|
||||
echo.The 'sphinx-build' command was not found. Make sure you have Sphinx
|
||||
echo.installed, then set the SPHINXBUILD environment variable to point
|
||||
echo.to the full path of the 'sphinx-build' executable. Alternatively you
|
||||
echo.may add the Sphinx directory to PATH.
|
||||
echo.
|
||||
echo.If you don't have Sphinx installed, grab it from
|
||||
echo.http://sphinx-doc.org/
|
||||
exit /b 1
|
||||
)
|
||||
|
||||
:sphinx_ok
|
||||
|
||||
|
||||
if "%1" == "html" (
|
||||
%SPHINXBUILD% -b html %ALLSPHINXOPTS% %BUILDDIR%/html
|
||||
if errorlevel 1 exit /b 1
|
||||
echo.
|
||||
echo.Build finished. The HTML pages are in %BUILDDIR%/html.
|
||||
goto end
|
||||
)
|
||||
|
||||
if "%1" == "dirhtml" (
|
||||
%SPHINXBUILD% -b dirhtml %ALLSPHINXOPTS% %BUILDDIR%/dirhtml
|
||||
if errorlevel 1 exit /b 1
|
||||
echo.
|
||||
echo.Build finished. The HTML pages are in %BUILDDIR%/dirhtml.
|
||||
goto end
|
||||
)
|
||||
|
||||
if "%1" == "singlehtml" (
|
||||
%SPHINXBUILD% -b singlehtml %ALLSPHINXOPTS% %BUILDDIR%/singlehtml
|
||||
if errorlevel 1 exit /b 1
|
||||
echo.
|
||||
echo.Build finished. The HTML pages are in %BUILDDIR%/singlehtml.
|
||||
goto end
|
||||
)
|
||||
|
||||
if "%1" == "pickle" (
|
||||
%SPHINXBUILD% -b pickle %ALLSPHINXOPTS% %BUILDDIR%/pickle
|
||||
if errorlevel 1 exit /b 1
|
||||
echo.
|
||||
echo.Build finished; now you can process the pickle files.
|
||||
goto end
|
||||
)
|
||||
|
||||
if "%1" == "json" (
|
||||
%SPHINXBUILD% -b json %ALLSPHINXOPTS% %BUILDDIR%/json
|
||||
if errorlevel 1 exit /b 1
|
||||
echo.
|
||||
echo.Build finished; now you can process the JSON files.
|
||||
goto end
|
||||
)
|
||||
|
||||
if "%1" == "htmlhelp" (
|
||||
%SPHINXBUILD% -b htmlhelp %ALLSPHINXOPTS% %BUILDDIR%/htmlhelp
|
||||
if errorlevel 1 exit /b 1
|
||||
echo.
|
||||
echo.Build finished; now you can run HTML Help Workshop with the ^
|
||||
.hhp project file in %BUILDDIR%/htmlhelp.
|
||||
goto end
|
||||
)
|
||||
|
||||
if "%1" == "qthelp" (
|
||||
%SPHINXBUILD% -b qthelp %ALLSPHINXOPTS% %BUILDDIR%/qthelp
|
||||
if errorlevel 1 exit /b 1
|
||||
echo.
|
||||
echo.Build finished; now you can run "qcollectiongenerator" with the ^
|
||||
.qhcp project file in %BUILDDIR%/qthelp, like this:
|
||||
echo.^> qcollectiongenerator %BUILDDIR%\qthelp\yacore.qhcp
|
||||
echo.To view the help file:
|
||||
echo.^> assistant -collectionFile %BUILDDIR%\qthelp\yacore.ghc
|
||||
goto end
|
||||
)
|
||||
|
||||
if "%1" == "devhelp" (
|
||||
%SPHINXBUILD% -b devhelp %ALLSPHINXOPTS% %BUILDDIR%/devhelp
|
||||
if errorlevel 1 exit /b 1
|
||||
echo.
|
||||
echo.Build finished.
|
||||
goto end
|
||||
)
|
||||
|
||||
if "%1" == "epub" (
|
||||
%SPHINXBUILD% -b epub %ALLSPHINXOPTS% %BUILDDIR%/epub
|
||||
if errorlevel 1 exit /b 1
|
||||
echo.
|
||||
echo.Build finished. The epub file is in %BUILDDIR%/epub.
|
||||
goto end
|
||||
)
|
||||
|
||||
if "%1" == "epub3" (
|
||||
%SPHINXBUILD% -b epub3 %ALLSPHINXOPTS% %BUILDDIR%/epub3
|
||||
if errorlevel 1 exit /b 1
|
||||
echo.
|
||||
echo.Build finished. The epub3 file is in %BUILDDIR%/epub3.
|
||||
goto end
|
||||
)
|
||||
|
||||
if "%1" == "latex" (
|
||||
%SPHINXBUILD% -b latex %ALLSPHINXOPTS% %BUILDDIR%/latex
|
||||
if errorlevel 1 exit /b 1
|
||||
echo.
|
||||
echo.Build finished; the LaTeX files are in %BUILDDIR%/latex.
|
||||
goto end
|
||||
)
|
||||
|
||||
if "%1" == "latexpdf" (
|
||||
%SPHINXBUILD% -b latex %ALLSPHINXOPTS% %BUILDDIR%/latex
|
||||
cd %BUILDDIR%/latex
|
||||
make all-pdf
|
||||
cd %~dp0
|
||||
echo.
|
||||
echo.Build finished; the PDF files are in %BUILDDIR%/latex.
|
||||
goto end
|
||||
)
|
||||
|
||||
if "%1" == "latexpdfja" (
|
||||
%SPHINXBUILD% -b latex %ALLSPHINXOPTS% %BUILDDIR%/latex
|
||||
cd %BUILDDIR%/latex
|
||||
make all-pdf-ja
|
||||
cd %~dp0
|
||||
echo.
|
||||
echo.Build finished; the PDF files are in %BUILDDIR%/latex.
|
||||
goto end
|
||||
)
|
||||
|
||||
if "%1" == "text" (
|
||||
%SPHINXBUILD% -b text %ALLSPHINXOPTS% %BUILDDIR%/text
|
||||
if errorlevel 1 exit /b 1
|
||||
echo.
|
||||
echo.Build finished. The text files are in %BUILDDIR%/text.
|
||||
goto end
|
||||
)
|
||||
|
||||
if "%1" == "man" (
|
||||
%SPHINXBUILD% -b man %ALLSPHINXOPTS% %BUILDDIR%/man
|
||||
if errorlevel 1 exit /b 1
|
||||
echo.
|
||||
echo.Build finished. The manual pages are in %BUILDDIR%/man.
|
||||
goto end
|
||||
)
|
||||
|
||||
if "%1" == "texinfo" (
|
||||
%SPHINXBUILD% -b texinfo %ALLSPHINXOPTS% %BUILDDIR%/texinfo
|
||||
if errorlevel 1 exit /b 1
|
||||
echo.
|
||||
echo.Build finished. The Texinfo files are in %BUILDDIR%/texinfo.
|
||||
goto end
|
||||
)
|
||||
|
||||
if "%1" == "gettext" (
|
||||
%SPHINXBUILD% -b gettext %I18NSPHINXOPTS% %BUILDDIR%/locale
|
||||
if errorlevel 1 exit /b 1
|
||||
echo.
|
||||
echo.Build finished. The message catalogs are in %BUILDDIR%/locale.
|
||||
goto end
|
||||
)
|
||||
|
||||
if "%1" == "changes" (
|
||||
%SPHINXBUILD% -b changes %ALLSPHINXOPTS% %BUILDDIR%/changes
|
||||
if errorlevel 1 exit /b 1
|
||||
echo.
|
||||
echo.The overview file is in %BUILDDIR%/changes.
|
||||
goto end
|
||||
)
|
||||
|
||||
if "%1" == "linkcheck" (
|
||||
%SPHINXBUILD% -b linkcheck %ALLSPHINXOPTS% %BUILDDIR%/linkcheck
|
||||
if errorlevel 1 exit /b 1
|
||||
echo.
|
||||
echo.Link check complete; look for any errors in the above output ^
|
||||
or in %BUILDDIR%/linkcheck/output.txt.
|
||||
goto end
|
||||
)
|
||||
|
||||
if "%1" == "doctest" (
|
||||
%SPHINXBUILD% -b doctest %ALLSPHINXOPTS% %BUILDDIR%/doctest
|
||||
if errorlevel 1 exit /b 1
|
||||
echo.
|
||||
echo.Testing of doctests in the sources finished, look at the ^
|
||||
results in %BUILDDIR%/doctest/output.txt.
|
||||
goto end
|
||||
)
|
||||
|
||||
if "%1" == "coverage" (
|
||||
%SPHINXBUILD% -b coverage %ALLSPHINXOPTS% %BUILDDIR%/coverage
|
||||
if errorlevel 1 exit /b 1
|
||||
echo.
|
||||
echo.Testing of coverage in the sources finished, look at the ^
|
||||
results in %BUILDDIR%/coverage/python.txt.
|
||||
goto end
|
||||
)
|
||||
|
||||
if "%1" == "xml" (
|
||||
%SPHINXBUILD% -b xml %ALLSPHINXOPTS% %BUILDDIR%/xml
|
||||
if errorlevel 1 exit /b 1
|
||||
echo.
|
||||
echo.Build finished. The XML files are in %BUILDDIR%/xml.
|
||||
goto end
|
||||
)
|
||||
|
||||
if "%1" == "pseudoxml" (
|
||||
%SPHINXBUILD% -b pseudoxml %ALLSPHINXOPTS% %BUILDDIR%/pseudoxml
|
||||
if errorlevel 1 exit /b 1
|
||||
echo.
|
||||
echo.Build finished. The pseudo-XML files are in %BUILDDIR%/pseudoxml.
|
||||
goto end
|
||||
)
|
||||
|
||||
if "%1" == "dummy" (
|
||||
%SPHINXBUILD% -b dummy %ALLSPHINXOPTS% %BUILDDIR%/dummy
|
||||
if errorlevel 1 exit /b 1
|
||||
echo.
|
||||
echo.Build finished. Dummy builder generates no files.
|
||||
goto end
|
||||
)
|
||||
|
||||
:end
|
||||
|
|
@ -0,0 +1,342 @@
|
|||
# -*- coding: utf-8 -*-
|
||||
#
|
||||
# skeleton documentation build configuration file, created by
|
||||
# sphinx-quickstart on Mon Aug 1 21:41:36 2016.
|
||||
#
|
||||
# This file is execfile()d with the current directory set to its
|
||||
# containing dir.
|
||||
#
|
||||
# Note that not all possible configuration values are present in this
|
||||
# autogenerated file.
|
||||
#
|
||||
# All configuration values have a default; values that are commented out
|
||||
# serve to show the default.
|
||||
|
||||
# If extensions (or modules to document with autodoc) are in another directory,
|
||||
# add these directories to sys.path here. If the directory is relative to the
|
||||
# documentation root, use os.path.abspath to make it absolute, like shown here.
|
||||
#
|
||||
# import os
|
||||
# import sys
|
||||
# sys.path.insert(0, os.path.abspath('.'))
|
||||
|
||||
# -- General configuration ------------------------------------------------
|
||||
|
||||
# If your documentation needs a minimal Sphinx version, state it here.
|
||||
#
|
||||
# needs_sphinx = '1.0'
|
||||
|
||||
# Add any Sphinx extension module names here, as strings. They can be
|
||||
# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
|
||||
# ones.
|
||||
extensions = [
|
||||
'sphinx.ext.autodoc',
|
||||
'sphinx.ext.viewcode',
|
||||
]
|
||||
|
||||
# Add any paths that contain templates here, relative to this directory.
|
||||
templates_path = ['_templates']
|
||||
|
||||
# The suffix(es) of source filenames.
|
||||
# You can specify multiple suffix as a list of string:
|
||||
#
|
||||
# source_suffix = ['.rst', '.md']
|
||||
source_suffix = '.rst'
|
||||
|
||||
# The encoding of source files.
|
||||
#
|
||||
# source_encoding = 'utf-8-sig'
|
||||
|
||||
# The master toctree document.
|
||||
master_doc = 'index'
|
||||
|
||||
# General information about the project.
|
||||
project = u'skeleton'
|
||||
copyright = u'2016, Peng Xiao'
|
||||
author = u'Peng Xiao'
|
||||
|
||||
# The version info for the project you're documenting, acts as replacement for
|
||||
# |version| and |release|, also used in various other places throughout the
|
||||
# built documents.
|
||||
#
|
||||
# The short X.Y version.
|
||||
version = u'1.0'
|
||||
# The full version, including alpha/beta/rc tags.
|
||||
release = u'1.0'
|
||||
|
||||
# The language for content autogenerated by Sphinx. Refer to documentation
|
||||
# for a list of supported languages.
|
||||
#
|
||||
# This is also used if you do content translation via gettext catalogs.
|
||||
# Usually you set "language" from the command line for these cases.
|
||||
language = None
|
||||
|
||||
# There are two options for replacing |today|: either, you set today to some
|
||||
# non-false value, then it is used:
|
||||
#
|
||||
# today = ''
|
||||
#
|
||||
# Else, today_fmt is used as the format for a strftime call.
|
||||
#
|
||||
# today_fmt = '%B %d, %Y'
|
||||
|
||||
# List of patterns, relative to source directory, that match files and
|
||||
# directories to ignore when looking for source files.
|
||||
# This patterns also effect to html_static_path and html_extra_path
|
||||
exclude_patterns = []
|
||||
|
||||
# The reST default role (used for this markup: `text`) to use for all
|
||||
# documents.
|
||||
#
|
||||
# default_role = None
|
||||
|
||||
# If true, '()' will be appended to :func: etc. cross-reference text.
|
||||
#
|
||||
# add_function_parentheses = True
|
||||
|
||||
# If true, the current module name will be prepended to all description
|
||||
# unit titles (such as .. function::).
|
||||
#
|
||||
# add_module_names = True
|
||||
|
||||
# If true, sectionauthor and moduleauthor directives will be shown in the
|
||||
# output. They are ignored by default.
|
||||
#
|
||||
# show_authors = False
|
||||
|
||||
# The name of the Pygments (syntax highlighting) style to use.
|
||||
pygments_style = 'sphinx'
|
||||
|
||||
# A list of ignored prefixes for module index sorting.
|
||||
# modindex_common_prefix = []
|
||||
|
||||
# If true, keep warnings as "system message" paragraphs in the built documents.
|
||||
# keep_warnings = False
|
||||
|
||||
# If true, `todo` and `todoList` produce output, else they produce nothing.
|
||||
todo_include_todos = False
|
||||
|
||||
|
||||
# -- Options for HTML output ----------------------------------------------
|
||||
|
||||
# The theme to use for HTML and HTML Help pages. See the documentation for
|
||||
# a list of builtin themes.
|
||||
#
|
||||
# html_theme = 'alabaster'
|
||||
html_theme = 'sphinx_rtd_theme'
|
||||
|
||||
# Theme options are theme-specific and customize the look and feel of a theme
|
||||
# further. For a list of options available for each theme, see the
|
||||
# documentation.
|
||||
#
|
||||
# html_theme_options = {}
|
||||
|
||||
# Add any paths that contain custom themes here, relative to this directory.
|
||||
# html_theme_path = []
|
||||
|
||||
# The name for this set of Sphinx documents.
|
||||
# "<project> v<release> documentation" by default.
|
||||
#
|
||||
# html_title = u'skeleton v1.0'
|
||||
|
||||
# A shorter title for the navigation bar. Default is the same as html_title.
|
||||
#
|
||||
# html_short_title = None
|
||||
|
||||
# The name of an image file (relative to this directory) to place at the top
|
||||
# of the sidebar.
|
||||
#
|
||||
# html_logo = None
|
||||
|
||||
# The name of an image file (relative to this directory) to use as a favicon of
|
||||
# the docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32
|
||||
# pixels large.
|
||||
#
|
||||
# html_favicon = None
|
||||
|
||||
# Add any paths that contain custom static files (such as style sheets) here,
|
||||
# relative to this directory. They are copied after the builtin static files,
|
||||
# so a file named "default.css" will overwrite the builtin "default.css".
|
||||
html_static_path = ['_static']
|
||||
|
||||
# Add any extra paths that contain custom files (such as robots.txt or
|
||||
# .htaccess) here, relative to this directory. These files are copied
|
||||
# directly to the root of the documentation.
|
||||
#
|
||||
# html_extra_path = []
|
||||
|
||||
# If not None, a 'Last updated on:' timestamp is inserted at every page
|
||||
# bottom, using the given strftime format.
|
||||
# The empty string is equivalent to '%b %d, %Y'.
|
||||
#
|
||||
# html_last_updated_fmt = None
|
||||
|
||||
# If true, SmartyPants will be used to convert quotes and dashes to
|
||||
# typographically correct entities.
|
||||
#
|
||||
# html_use_smartypants = True
|
||||
|
||||
# Custom sidebar templates, maps document names to template names.
|
||||
#
|
||||
# html_sidebars = {}
|
||||
|
||||
# Additional templates that should be rendered to pages, maps page names to
|
||||
# template names.
|
||||
#
|
||||
# html_additional_pages = {}
|
||||
|
||||
# If false, no module index is generated.
|
||||
#
|
||||
# html_domain_indices = True
|
||||
|
||||
# If false, no index is generated.
|
||||
#
|
||||
# html_use_index = True
|
||||
|
||||
# If true, the index is split into individual pages for each letter.
|
||||
#
|
||||
# html_split_index = False
|
||||
|
||||
# If true, links to the reST sources are added to the pages.
|
||||
#
|
||||
# html_show_sourcelink = True
|
||||
|
||||
# If true, "Created using Sphinx" is shown in the HTML footer. Default is True.
|
||||
#
|
||||
# html_show_sphinx = True
|
||||
|
||||
# If true, "(C) Copyright ..." is shown in the HTML footer. Default is True.
|
||||
#
|
||||
# html_show_copyright = True
|
||||
|
||||
# If true, an OpenSearch description file will be output, and all pages will
|
||||
# contain a <link> tag referring to it. The value of this option must be the
|
||||
# base URL from which the finished HTML is served.
|
||||
#
|
||||
# html_use_opensearch = ''
|
||||
|
||||
# This is the file name suffix for HTML files (e.g. ".xhtml").
|
||||
# html_file_suffix = None
|
||||
|
||||
# Language to be used for generating the HTML full-text search index.
|
||||
# Sphinx supports the following languages:
|
||||
# 'da', 'de', 'en', 'es', 'fi', 'fr', 'hu', 'it', 'ja'
|
||||
# 'nl', 'no', 'pt', 'ro', 'ru', 'sv', 'tr', 'zh'
|
||||
#
|
||||
# html_search_language = 'en'
|
||||
|
||||
# A dictionary with options for the search language support, empty by default.
|
||||
# 'ja' uses this config value.
|
||||
# 'zh' user can custom change `jieba` dictionary path.
|
||||
#
|
||||
# html_search_options = {'type': 'default'}
|
||||
|
||||
# The name of a javascript file (relative to the configuration directory) that
|
||||
# implements a search results scorer. If empty, the default will be used.
|
||||
#
|
||||
# html_search_scorer = 'scorer.js'
|
||||
|
||||
# Output file base name for HTML help builder.
|
||||
htmlhelp_basename = 'skeletondoc'
|
||||
|
||||
# -- Options for LaTeX output ---------------------------------------------
|
||||
|
||||
latex_elements = {
|
||||
# The paper size ('letterpaper' or 'a4paper').
|
||||
#
|
||||
# 'papersize': 'letterpaper',
|
||||
|
||||
# The font size ('10pt', '11pt' or '12pt').
|
||||
#
|
||||
# 'pointsize': '10pt',
|
||||
|
||||
# Additional stuff for the LaTeX preamble.
|
||||
#
|
||||
# 'preamble': '',
|
||||
|
||||
# Latex figure (float) alignment
|
||||
#
|
||||
# 'figure_align': 'htbp',
|
||||
}
|
||||
|
||||
# Grouping the document tree into LaTeX files. List of tuples
|
||||
# (source start file, target name, title,
|
||||
# author, documentclass [howto, manual, or own class]).
|
||||
latex_documents = [
|
||||
(master_doc, 'skeleton.tex', u'skeleton Documentation',
|
||||
u'Peng Xiao', 'manual'),
|
||||
]
|
||||
|
||||
# The name of an image file (relative to this directory) to place at the top of
|
||||
# the title page.
|
||||
#
|
||||
# latex_logo = None
|
||||
|
||||
# For "manual" documents, if this is true, then toplevel headings are parts,
|
||||
# not chapters.
|
||||
#
|
||||
# latex_use_parts = False
|
||||
|
||||
# If true, show page references after internal links.
|
||||
#
|
||||
# latex_show_pagerefs = False
|
||||
|
||||
# If true, show URL addresses after external links.
|
||||
#
|
||||
# latex_show_urls = False
|
||||
|
||||
# Documents to append as an appendix to all manuals.
|
||||
#
|
||||
# latex_appendices = []
|
||||
|
||||
# It false, will not define \strong, \code, itleref, \crossref ... but only
|
||||
# \sphinxstrong, ..., \sphinxtitleref, ... To help avoid clash with user added
|
||||
# packages.
|
||||
#
|
||||
# latex_keep_old_macro_names = True
|
||||
|
||||
# If false, no module index is generated.
|
||||
#
|
||||
# latex_domain_indices = True
|
||||
|
||||
|
||||
# -- Options for manual page output ---------------------------------------
|
||||
|
||||
# One entry per manual page. List of tuples
|
||||
# (source start file, name, description, authors, manual section).
|
||||
man_pages = [
|
||||
(master_doc, 'skeleton', u'skeleton Documentation',
|
||||
[author], 1)
|
||||
]
|
||||
|
||||
# If true, show URL addresses after external links.
|
||||
#
|
||||
# man_show_urls = False
|
||||
|
||||
|
||||
# -- Options for Texinfo output -------------------------------------------
|
||||
|
||||
# Grouping the document tree into Texinfo files. List of tuples
|
||||
# (source start file, target name, title, author,
|
||||
# dir menu entry, description, category)
|
||||
texinfo_documents = [
|
||||
(master_doc, 'skeleton', u'skeleton Documentation',
|
||||
author, 'skeleton', 'One line description of project.',
|
||||
'Miscellaneous'),
|
||||
]
|
||||
|
||||
# Documents to append as an appendix to all manuals.
|
||||
#
|
||||
# texinfo_appendices = []
|
||||
|
||||
# If false, no module index is generated.
|
||||
#
|
||||
# texinfo_domain_indices = True
|
||||
|
||||
# How to display URL addresses: 'footnote', 'no', or 'inline'.
|
||||
#
|
||||
# texinfo_show_urls = 'footnote'
|
||||
|
||||
# If true, do not generate a @detailmenu in the "Top" node's menu.
|
||||
#
|
||||
# texinfo_no_detailmenu = False
|
||||
|
|
@ -0,0 +1,25 @@
|
|||
.. yacore documentation master file, created by
|
||||
sphinx-quickstart on Mon Aug 1 21:41:36 2016.
|
||||
You can adapt this file completely to your liking, but it should at least
|
||||
contain the root `toctree` directive.
|
||||
|
||||
Welcome to yacore's documentation!
|
||||
==================================
|
||||
|
||||
This is a test line
|
||||
test again
|
||||
test
|
||||
Contents:
|
||||
|
||||
.. toctree::
|
||||
:maxdepth: 2
|
||||
|
||||
|
||||
|
||||
Indices and tables
|
||||
==================
|
||||
|
||||
* :ref:`genindex`
|
||||
* :ref:`modindex`
|
||||
* :ref:`search`
|
||||
|
||||
|
|
@ -0,0 +1,56 @@
|
|||
# manage.py
|
||||
|
||||
import unittest
|
||||
|
||||
from flask_script import Manager
|
||||
from flask_migrate import Migrate, MigrateCommand
|
||||
|
||||
from skeleton.server import app, db
|
||||
from skeleton.server.models import User
|
||||
|
||||
|
||||
migrate = Migrate(app, db)
|
||||
manager = Manager(app)
|
||||
|
||||
# migrations
|
||||
manager.add_command('db', MigrateCommand)
|
||||
|
||||
|
||||
@manager.command
|
||||
def test():
|
||||
"""Runs the unit tests without coverage."""
|
||||
tests = unittest.TestLoader().discover('tests', pattern='test*.py')
|
||||
result = unittest.TextTestRunner(verbosity=2).run(tests)
|
||||
if result.wasSuccessful():
|
||||
return 0
|
||||
else:
|
||||
return 1
|
||||
|
||||
|
||||
@manager.command
|
||||
def create_db():
|
||||
"""Creates the db tables."""
|
||||
db.create_all()
|
||||
|
||||
|
||||
@manager.command
|
||||
def drop_db():
|
||||
"""Drops the db tables."""
|
||||
db.drop_all()
|
||||
|
||||
|
||||
@manager.command
|
||||
def create_admin():
|
||||
"""Creates the admin user."""
|
||||
db.session.add(User(email='admin@cisco.com', password='admin', admin=True))
|
||||
db.session.commit()
|
||||
|
||||
|
||||
@manager.command
|
||||
def create_data():
|
||||
"""Creates sample data."""
|
||||
pass
|
||||
|
||||
|
||||
if __name__ == '__main__':
|
||||
manager.run()
|
||||
Some files were not shown because too many files have changed in this diff Show More
Loading…
Reference in New Issue