开发设置说明

以下是设置Coala工作环境的一些有用注意事项。

虚拟现实

我们强烈建议在Virtualenv中安装Coala进行开发。这将允许您有一个包含的环境,在其中修改Coala,与您可能不想中断的任何其他Coala安装分开。在这里,我们将展示如何使用 venvvirtualenv 。我们建议您使用 venv 因为它是标准库的一部分,不需要额外安装。不过,您可以使用您认为适合自己的任何一种。

使用venv

  • 确保在本地计算机上安装了Python3。

  • 使用venv设置viralenv:
    $ cd working_dir # move into the dir where you want to create coala-venv
    $ python3 -m venv coala-venv
    # This creates an isolated Python 3 environment called coala-venv
    # in your current directory.
    # To activate the environment type:
    $ source coala-venv/bin/activate
    # To exit the environment simply type:
    (coala-venv)$ deactivate
    
  • 现在您可以激活环境并启动 the next part .

使用virtualenv

  • 使用PIP3安装viralenv:
    $ pip3 install virtualenv
    
  • 创建Virtualenv:
    $ cd working_dir # move into the dir where you want to create coala-venv
    $ virtualenv coala-venv
    

注意:如果同时安装了Python3和Python2,请尝试此命令,它会在当前目录中创建一个名为coala-venv的隔离Python3环境,因为Coala仅适用于Python>=3.5::

$ virtualenv coala-venv -p $(which python3)
  • 激活 coala-venv 隔离环境:

    • 如果您是Linux或Mac用户:

    $ source coala-venv/bin/activate
    (coala-venv)$ deactivate # to exit the environment
    
    • 如果您是Windows用户,请执行以下操作:

    > coala-venv\Scripts\activate
    (coala-venv)> deactivate # to exit the environment
    
  • 如果您遇到任何打嗝,请参阅 Virtualenv User Guide

  • 在此之后,您可以开始 installing from git .

存储库

如果您有兴趣为Coala做贡献,我们建议您阅读我们的 newcomers' guide 来熟悉我们的工作流程,或许还可以熟悉GitHub本身。

您很可能只需要在 coalacoala-bears 存储库。前者是Coala的核心,后者包含一套标准熊。您可以从以下位置派生和克隆存储库:

https://github.com/coala/coala

https://github.com/coala/coala-bears

除了上面的那些储存库, package_managercoala-utils 是托管在GitLab上的Coala的基本组成部分。

https://gitlab.com/coala/package_manager/

https://gitlab.com/coala/coala-utils/

从Git安装

我们建议使用下面给出的命令从主分支安装Coala和Coala-Bear,以获取最新更新及其与PIP3的依赖关系。这个 -e 标签从给定路径以可编辑模式安装项目。

(coala-venv)$ git clone https://github.com/coala/coala
(coala-venv)$ cd coala
(coala-venv)$ pip3 install -e .
(coala-venv)$ cd ..
(coala-venv)$ git clone https://github.com/coala/coala-bears
(coala-venv)$ cd coala-bears
(coala-venv)$ pip3 install -e .

然后,您将能够编辑存储库,并使更改立即在您的viralenv中生效。如果将来需要从其他来源安装,您还可以使用PIP3来管理软件包的安装。

建筑文件

您应该在尝试构建文档之前运行此命令:

(coala-venv)$ pip3 install -r docs-requirements.txt

完成此操作后,您可以通过进入docs目录并运行以下命令来构建文档 python3 setup.py docs 。Coala网站上的文档位于 coala (不是) coala-bears )存储库。