#11.4 以Conda包的形式發布一個簡單的項目
**NOTE**:*此示例代碼可以在 https://github.com/dev-cafe/cmake-cookbook/tree/v1.0/chapter-11/recipe-04 中找到。該示例在CMake 3.5版(或更高版本)中是有效的,并且已經在GNU/Linux、macOS和Windows上進行過測試。*
雖然PyPI是發布Python包的標準平臺,但Anaconda (https://anaconda.org )更為可能更為流行,因為它不僅允許使用Python接口發布Python或混合項目,還允許對非Python項目進行打包和依賴關系管理。這個示例中,我們將為一個非常簡單的C++示例項目準備一個Conda包,該項目使用CMake配置和構建,除了C++之外沒有依賴關系。下一個示例中,我們將會來看看一個更復雜的Conda包。
## 準備工作
我們的目標是打包以下示例代碼(`example.cpp`):
```c++
#include <iostream>
int main() {
std::cout << "hello from your conda package!" << std::endl;
return 0;
}
```
## 具體實施
1. `CMakeLists.txt`文件給出了最低版本要求、項目名稱和支持的語言:
```cmake
cmake_minimum_required(VERSION 3.5 FATAL_ERROR)
project(recipe-04 LANGUAGES CXX)
set(CMAKE_CXX_STANDARD 11)
set(CMAKE_CXX_EXTENSIONS OFF)
set(CMAKE_CXX_STANDARD_REQUIRED ON)
```
2. 使用`example.cpp`構建`hello-conda`可執行目標:
```cmake
add_executable(hello-conda "")
target_sources(hello-conda
PRIVATE
example.cpp
)
```
3. 使用`CMakeLists.txt`定義安裝目標:
```cmake
nstall(
TARGETS
hello-conda
DESTINATION
bin
)
```
4. 將在一個名為` meta.yaml `的文件中,對Conda包進行描述。我們將把它放在`conda-recipe`目錄下,文件結構如下:
```shell
.
├── CMakeLists.txt
├── conda-recipe
│ └── meta.yaml
└── example.cpp
```
5. `meta.yaml`包含如下內容:
```yaml
package:
name: conda-example-simple
version: "0.0.0"
source:
path: .. / # this can be changed to git-url
build:
number: 0
binary_relocation: true
script:
- cmake -H. -Bbuild_conda -G "${CMAKE_GENERATOR}" -DCMAKE_INSTALL_PREFIX=${PREFIX} # [not win]
- cmake -H. -Bbuild_conda -G "%CMAKE_GENERATOR%" -DCMAKE_INSTALL_PREFIX="%LIBRARY_PREFIX%" # [win]
- cmake - -build build_conda - -target install
requirements:
build:
- cmake >=3.5
- { { compiler('cxx') } }
about:
home: http://www.example.com
license: MIT
summary: "Summary in here ..."
```
6. 現在來構建包:
```shell
$ conda build conda-recipe
```
7. 過程中屏幕上看到大量輸出,但是一旦構建完成,就可以對包進行安裝。首先,在本地進行測試:
```shell
$ conda install --use-local conda-example-simple
```
8. 現在準備測試安裝包,打開一個新的終端(假設Anaconda處于激活狀態),并輸入以下內容:
```shell
$ hello-conda
hello from your conda package!
```
9. 測試成功后,再移除包裝:
```shell
$ conda remove conda-example-simple
```
## 工作原理
`CMakeLists.txt`中,安裝目標是這個示例的一個基本組件:
```cmake
install(
TARGETS
hello-conda
DESTINATION
bin
)
```
目標的二進制文件會安裝到`${CMAKE_INSTALL_PREFIX}/bin`中。變量由Conda定義,并且構建步驟中定義在` meta.yaml `:
```yaml
build:
number: 0
binary_relocation: true
script:
- cmake -H. -Bbuild_conda -G "${CMAKE_GENERATOR}" -DCMAKE_INSTALL_PREFIX=${PREFIX} # [not win]
- cmake -H. -Bbuild_conda -G "%CMAKE_GENERATOR%" -DCMAKE_INSTALL_PREFIX="%LIBRARY_PREFIX%" # [win]
- cmake - -build build_conda - -target install
```
將安裝目錄設置為`${prefix}` (Conda的內部變量),然后構建并安裝項目。調用構建目錄命名為`build_conda`的動機與前面的示例類似:特定的構建目錄名可能已經命名為`build`。
## 更多信息
配置文件` meta.yaml `可為任何項目指定構建、測試和安裝步驟。詳情請參考官方文檔:https://conda.io/docs/user-guide/tasks/build-packages/define-metadata.html
要將Conda包上傳到Anaconda云,請遵循官方的Anaconda文檔: https://docs.anaconda.com/anaconda-cloud/user-guide/
此外,也可以考慮將Miniconda,作為Anaconda的輕量級替代品:https://conda.io/miniconda.html
- Introduction
- 前言
- 第0章 配置環境
- 0.1 獲取代碼
- 0.2 Docker鏡像
- 0.3 安裝必要的軟件
- 0.4 測試環境
- 0.5 上報問題并提出改進建議
- 第1章 從可執行文件到庫
- 1.1 將單個源文件編譯為可執行文件
- 1.2 切換生成器
- 1.3 構建和鏈接靜態庫和動態庫
- 1.4 用條件句控制編譯
- 1.5 向用戶顯示選項
- 1.6 指定編譯器
- 1.7 切換構建類型
- 1.8 設置編譯器選項
- 1.9 為語言設定標準
- 1.10 使用控制流
- 第2章 檢測環境
- 2.1 檢測操作系統
- 2.2 處理與平臺相關的源代碼
- 2.3 處理與編譯器相關的源代碼
- 2.4 檢測處理器體系結構
- 2.5 檢測處理器指令集
- 2.6 為Eigen庫使能向量化
- 第3章 檢測外部庫和程序
- 3.1 檢測Python解釋器
- 3.2 檢測Python庫
- 3.3 檢測Python模塊和包
- 3.4 檢測BLAS和LAPACK數學庫
- 3.5 檢測OpenMP的并行環境
- 3.6 檢測MPI的并行環境
- 3.7 檢測Eigen庫
- 3.8 檢測Boost庫
- 3.9 檢測外部庫:Ⅰ. 使用pkg-config
- 3.10 檢測外部庫:Ⅱ. 自定義find模塊
- 第4章 創建和運行測試
- 4.1 創建一個簡單的單元測試
- 4.2 使用Catch2庫進行單元測試
- 4.3 使用Google Test庫進行單元測試
- 4.4 使用Boost Test進行單元測試
- 4.5 使用動態分析來檢測內存缺陷
- 4.6 預期測試失敗
- 4.7 使用超時測試運行時間過長的測試
- 4.8 并行測試
- 4.9 運行測試子集
- 4.10 使用測試固件
- 第5章 配置時和構建時的操作
- 5.1 使用平臺無關的文件操作
- 5.2 配置時運行自定義命令
- 5.3 構建時運行自定義命令:Ⅰ. 使用add_custom_command
- 5.4 構建時運行自定義命令:Ⅱ. 使用add_custom_target
- 5.5 構建時為特定目標運行自定義命令
- 5.6 探究編譯和鏈接命令
- 5.7 探究編譯器標志命令
- 5.8 探究可執行命令
- 5.9 使用生成器表達式微調配置和編譯
- 第6章 生成源碼
- 6.1 配置時生成源碼
- 6.2 使用Python在配置時生成源碼
- 6.3 構建時使用Python生成源碼
- 6.4 記錄項目版本信息以便報告
- 6.5 從文件中記錄項目版本
- 6.6 配置時記錄Git Hash值
- 6.7 構建時記錄Git Hash值
- 第7章 構建項目
- 7.1 使用函數和宏重用代碼
- 7.2 將CMake源代碼分成模塊
- 7.3 編寫函數來測試和設置編譯器標志
- 7.4 用指定參數定義函數或宏
- 7.5 重新定義函數和宏
- 7.6 使用廢棄函數、宏和變量
- 7.7 add_subdirectory的限定范圍
- 7.8 使用target_sources避免全局變量
- 7.9 組織Fortran項目
- 第8章 超級構建模式
- 8.1 使用超級構建模式
- 8.2 使用超級構建管理依賴項:Ⅰ.Boost庫
- 8.3 使用超級構建管理依賴項:Ⅱ.FFTW庫
- 8.4 使用超級構建管理依賴項:Ⅲ.Google Test框架
- 8.5 使用超級構建支持項目
- 第9章 語言混合項目
- 9.1 使用C/C++庫構建Fortran項目
- 9.2 使用Fortran庫構建C/C++項目
- 9.3 使用Cython構建C++和Python項目
- 9.4 使用Boost.Python構建C++和Python項目
- 9.5 使用pybind11構建C++和Python項目
- 9.6 使用Python CFFI混合C,C++,Fortran和Python
- 第10章 編寫安裝程序
- 10.1 安裝項目
- 10.2 生成輸出頭文件
- 10.3 輸出目標
- 10.4 安裝超級構建
- 第11章 打包項目
- 11.1 生成源代碼和二進制包
- 11.2 通過PyPI發布使用CMake/pybind11構建的C++/Python項目
- 11.3 通過PyPI發布使用CMake/CFFI構建C/Fortran/Python項目
- 11.4 以Conda包的形式發布一個簡單的項目
- 11.5 將Conda包作為依賴項發布給項目
- 第12章 構建文檔
- 12.1 使用Doxygen構建文檔
- 12.2 使用Sphinx構建文檔
- 12.3 結合Doxygen和Sphinx
- 第13章 選擇生成器和交叉編譯
- 13.1 使用CMake構建Visual Studio 2017項目
- 13.2 交叉編譯hello world示例
- 13.3 使用OpenMP并行化交叉編譯Windows二進制文件
- 第14章 測試面板
- 14.1 將測試部署到CDash
- 14.2 CDash顯示測試覆蓋率
- 14.3 使用AddressSanifier向CDash報告內存缺陷
- 14.4 使用ThreadSaniiser向CDash報告數據爭用
- 第15章 使用CMake構建已有項目
- 15.1 如何開始遷移項目
- 15.2 生成文件并編寫平臺檢查
- 15.3 檢測所需的鏈接和依賴關系
- 15.4 復制編譯標志
- 15.5 移植測試
- 15.6 移植安裝目標
- 15.7 進一步遷移的措施
- 15.8 項目轉換為CMake的常見問題
- 第16章 可能感興趣的書
- 16.1 留下評論——讓其他讀者知道你的想法