跳转到主要内容

用于将表格数据文件作为静态网站部署的包

项目描述

csvdeploy

Python包,用于部署基于表格数据(csvw)的静态网站,支持持续集成

简介

csvdeploy是一个Python库,用于根据W3C的[csvw](the https://www.w3.org/TR/tabular-data-primer/)标准生成和部署基于表格数据的静态网站。它旨在为需要几乎无需配置且可在廉价或免费托管服务上运行的最简单的网站提供一个解决方案:我们的目标是拥有一个尽可能“即插即用”的工具,并支持持续集成。简单的事情应该简单,复杂的事情应该可能——只要它们不会使学习曲线过于陡峭。

安装和使用

该库可以用pip像任何标准Python库一样安装,如下面的代码片段所示。如果在本地计算机上安装,强烈建议使用虚拟环境解决方案。在所有情况下,如果可能,还建议更新用于安装库的包(即,pip install --upgrade pip setuptools wheel)。

$ pip install deploycsv

然而,在大多数情况下,您可能希望在一个集成系统中自动使用该库。预期的用法是拥有一个存储数据的 git 仓库,该仓库将自动调用 csvdeploy,生成新的网页,并在原始数据每次更改时上传它们。安装和使用库的说明将取决于您将要使用的具体系统,我们文档中给出了最常见的情况。

基本操作是调用 csvdeploy 命令行工具,将其指向一个 JSON 配置文件,如下面的命令所示,使用包中提供的演示数据集之一

$ csvdeploy demo_data/langgenera/langgenera.config.json

工具的精确操作将取决于配置。默认情况下,新网站将生成在调用它的路径下的 _site 目录。

变更日志

版本 0.1

  • 第一个发布版本。

社区指南

虽然作者可以直接联系以获得支持,但建议第三方使用 GitHub 标准功能,如问题和拉取请求,以贡献、报告问题或寻求支持。

贡献指南,包括行为准则,可以在 CONTRIBUTING.md 文件中找到。

作者和引用

该库由 Tiago Tresoldi 开发 (tiago.tresoldi@lingfil.uu.se).

在开发初期,作者获得了欧洲研究委员会 (ERC) 的资金,该资金来自欧盟的“地平线2020”研究和创新计划(资助协议号 ERC Grant #715618,“计算机辅助语言比较”)。

如果您使用 csvdeploy,请引用它如下

Tresoldi, Tiago (2021). CSVDeploy,将表格数据文件作为静态网站部署的包。版本 0.1。乌普萨拉。

在 BibTeX 中

@misc{Tresoldi2021csvdeploy,
  author = {Tresoldi, Tiago},
  title = {CSVDeploy, a package for deploying tabular data files as static websites. Version 0.1},
  howpublished = {\url{https://github.com/tresoldi/csvdeploy}},
  address = {Uppsala},
  publisher = {Institutionen för lingvistik och filologi, Uppsala universitet}
  year = {2021},
}

项目详情


下载文件

下载适合您平台的文件。如果您不确定要选择哪个,请了解更多关于 安装包 的信息。

源代码分发

csvdeploy-0.1.tar.gz (404.9 kB 查看哈希值)

上传时间 源代码

构建分发

csvdeploy-0.1-py3-none-any.whl (412.8 kB 查看哈希值)

上传时间 Python 3

支持者

AWS AWS 云计算和安全赞助商 Datadog Datadog 监控 Fastly Fastly CDN Google Google 下载分析 Microsoft Microsoft PSF 赞助商 Pingdom Pingdom 监控 Sentry Sentry 错误记录 StatusPage StatusPage 状态页面