开源项目 `api-pycon2015` 使用教程

开源项目 api-pycon2015 使用教程

api-pycon2015Code for my PyCon talk "Is Your REST API RESTful?"项目地址:https://gitcode.com/gh_mirrors/ap/api-pycon2015

1. 项目的目录结构及介绍

api-pycon2015/
├── api/
│   ├── __init__.py
│   ├── models.py
│   ├── views.py
├── tests/
│   ├── __init__.py
│   ├── test_api.py
├── .gitignore
├── .travis.yml
├── LICENSE
├── README.md
├── config.py
├── manage.py
├── requirements.txt
├── test_config.py

• api/: 包含API的核心代码，包括模型(models.py)、视图(views.py)等。
• tests/: 包含项目的单元测试文件。
• .gitignore: Git忽略文件配置。
• .travis.yml: Travis CI配置文件。
• LICENSE: 项目许可证。
• README.md: 项目说明文档。
• config.py: 项目配置文件。
• manage.py: 项目启动文件。
• requirements.txt: 项目依赖文件。
• test_config.py: 测试配置文件。

2. 项目的启动文件介绍

manage.py 是项目的启动文件，主要用于启动应用、管理数据库等操作。以下是 manage.py 的基本使用方法：

# 启动应用
python manage.py runserver

# 添加用户
python manage.py adduser <username>

3. 项目的配置文件介绍

config.py 是项目的配置文件，包含了应用的各种配置选项，如数据库配置、认证配置等。以下是 config.py 的部分配置示例：

import os
basedir = os.path.abspath(os.path.dirname(__file__))

class Config:
    SECRET_KEY = os.environ.get('SECRET_KEY') or 'hard to guess string'
    SQLALCHEMY_COMMIT_ON_TEARDOWN = True
    SQLALCHEMY_TRACK_MODIFICATIONS = False

    @staticmethod
    def init_app(app):
        pass

class DevelopmentConfig(Config):
    DEBUG = True
    SQLALCHEMY_DATABASE_URI = os.environ.get('DEV_DATABASE_URL') or \
        'sqlite:///' + os.path.join(basedir, 'data-dev.sqlite')

class TestingConfig(Config):
    TESTING = True
    SQLALCHEMY_DATABASE_URI = os.environ.get('TEST_DATABASE_URL') or \
        'sqlite:///' + os.path.join(basedir, 'data-test.sqlite')

class ProductionConfig(Config):
    SQLALCHEMY_DATABASE_URI = os.environ.get('DATABASE_URL') or \
        'sqlite:///' + os.path.join(basedir, 'data.sqlite')

config = {
    'development': DevelopmentConfig,
    'testing': TestingConfig,
    'production': ProductionConfig,
    'default': DevelopmentConfig
}

以上配置文件定义了不同环境下的配置，如开发环境(DevelopmentConfig)、测试环境(TestingConfig)和生产环境(ProductionConfig)。可以根据需要选择不同的配置。

api-pycon2015Code for my PyCon talk "Is Your REST API RESTful?"项目地址:https://gitcode.com/gh_mirrors/ap/api-pycon2015