baha/skyline-apiserver
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity
11 Commits 3 Branches 0 Tags 8.4 MiB
Python 98.1%
Shell 0.8%
Makefile 0.5%
Jinja 0.4%
Dockerfile 0.2%
4935be6f47
Go to file
Gao Hanxiang 4935be6f47 refactor: Move skyline-apiserver to libs 
1. Move skyline-apiserver to libs
2. Modify Makefile
3. Rename the skyline-apiserver.yaml.sample file to skyline.yaml.sample

At the top level, we use "skyline" as the namespace, using the idea of
monorepo to manage the project. At the top level, only some common
configuration files (mypy.ini, black.conf, isort.conf, etc.) and
common tools are included.

In the `libs` directory, there are three core libraries,
skyline-console, skyline-apiserver, skyline-nginx, and some dependent
libraries.
There are cross-imports between these libraries,
for example: skyline-nginx requires skyline-apiserver;
Both skyline-nginx and skyline-apiserver require skyline-config.

Therefore, skyline-apiserver should not be placed
at the top level, it is also suitable for management as a library.


Change-Id: Ie2f1f4bdfbc2e985ec4327705eecaae3181f5b50
2021-07-26 03:48:54 +00:00
docs/api feat: Add initial code of skyline-apiserver 2021-06-01 23:39:57 +08:00
etc fix: Add sample yaml config file 2021-06-16 06:22:14 +00:00
libs refactor: Move skyline-apiserver to libs 2021-07-26 03:48:54 +00:00
skyline refactor: Move skyline-apiserver to libs 2021-07-26 03:48:54 +00:00
tools/git_config feat: Add initial code of skyline-apiserver 2021-06-01 23:39:57 +08:00
.dockerignore feat: Add initial code of skyline-apiserver 2021-06-01 23:39:57 +08:00
.flake8 feat: Add initial code of skyline-apiserver 2021-06-01 23:39:57 +08:00
.gitignore feat: Add initial code of skyline-apiserver 2021-06-01 23:39:57 +08:00
.gitmodules feat: Add skyline-console to submodule 2021-07-19 02:46:39 +00:00
.gitreview Added .gitreview 2021-05-08 17:14:30 +00:00
.zuul.yaml Add Zuul support for new repository 2021-05-10 12:47:51 +02:00
alembic.ini feat: Add initial code of skyline-apiserver 2021-06-01 23:39:57 +08:00
LICENSE feat: Add initial code of skyline-apiserver 2021-06-01 23:39:57 +08:00
Makefile feat: Add skyline-config under libs 2021-07-07 16:14:11 +08:00
mypy.ini feat: Add initial code of skyline-apiserver 2021-06-01 23:39:57 +08:00
poetry.lock refactor: Move skyline-apiserver to libs 2021-07-26 03:48:54 +00:00
poetry.toml feat: Add initial code of skyline-apiserver 2021-06-01 23:39:57 +08:00
pyproject.toml refactor: Move skyline-apiserver to libs 2021-07-26 03:48:54 +00:00
README-zh_CN.md refactor: Move skyline-apiserver to libs 2021-07-26 03:48:54 +00:00
README.md refactor: Move skyline-apiserver to libs 2021-07-26 03:48:54 +00:00

README.md

Skyline API

English | 简体中文

Quick Start

Dependent tools

Development mode

Support Linux & Mac OS (Recommend Linux OS) (Because uvloop & cython)

  • Installing dependency packages

    make install

  • Set skyline.yaml config file

    Maybe you should change the params with your real environment as followed:

    - database_url  (you can set sqlite:////tmp/skyline.db to use sqlite)
- default_region
- keystone_url
- system_project
- system_project_domain
- system_user_domain
- system_user_name
- system_user_password

    cp etc/skyline.yaml.sample etc/skyline.yaml
export OS_CONFIG_DIR=$(pwd)/etc

  • Init skyline database

    make db_sync

  • Run server

    $ poetry run uvicorn --reload --reload-dir libs/skyline-apiserver/skyline_apiserver --port 28000 --log-level debug skyline_apiserver.main:app

INFO:     Uvicorn running on http://127.0.0.1:28000 (Press CTRL+C to quit)
INFO:     Started reloader process [154033] using statreload
INFO:     Started server process [154037]
INFO:     Waiting for application startup.
INFO:     Application startup complete.

You can now access the online API documentation: http://127.0.0.1:28000/docs