aicsdaemon

Python类，用于定义守护进程。从该类继承的类应该可以作为守护进程运行。

特性

• 存储值并在内存中保留先前值
• ... 其他一些功能

快速入门

from aicsdaemon import Example

a = Example()
a.get_value()  # 10

安装

稳定版本： pip install aicsdaemon
开发头部： pip install git+https://github.com/AllenCellModeling/aicsdaemon.git

文档

请访问AllenCellModeling.github.io/aicsdaemon以获取完整包文档。

开发

有关开发代码的信息，请参阅CONTRIBUTING.md。

你需要知道的四个命令

1. pip install -e .[dev]

   这将以可编辑模式安装您的软件包，并包含所有必需的开发依赖项（即tox）。

2. make build

   这将运行tox，它将在Python 3.6和Python 3.7上运行所有测试，并对您的代码进行linting。

3. make clean

   这将清理各种Python和构建生成的文件，以确保您在一个干净的环境中工作。

4. make docs

   这将生成并启动一个网页浏览器来查看您Python包的最新文档。

其他可选设置步骤

• 将您的项目变成GitHub仓库
  • 请确保您已安装git，如果没有，请按照这些说明
  • 在github.com上创建账户
  • 前往 创建一个新的仓库
  • 建议
    • 强烈建议将仓库名称与 Python 包名称相同
    • 以下很多可选步骤，如果仓库是公开的，都是免费的，开源很酷
  • 一旦你进入了新创建的 cookiecutter Python 项目的目录，运行 git init
  • git 本地初始化后，运行以下命令
    • git remote add origin git@github.com:AllenCellModeling/aicsdaemon.git
    • git push -u origin master
• 在 Codecov 上注册 aicsdaemon
  • 在 codecov.io 上创建一个账户（建议使用 GitHub 登录）
  • 选择 AllenCellModeling 并点击：添加新仓库
  • 复制提供的令牌，前往你的 GitHub 仓库设置，在 Secrets 选项卡下添加一个名为 CODECOV_TOKEN 的秘密，使用你刚刚复制的令牌。不要担心，没有人会看到这个令牌，因为它会被加密。
• 生成并添加一个访问令牌作为秘密到仓库，以便自动文档生成功能能够工作
  • 前往你的 GitHub 账户的 Personal Access Tokens 页面
  • 点击：生成新令牌
  • 建议
    • 命名令牌：“自动文档生成”或类似名称，以便稍后知道它的用途
    • 仅选择：repo:status、repo_deployment 和 public_repo 以限制此令牌的访问权限
  • 复制新生成的令牌
  • 前往你的 GitHub 仓库设置，在 Secrets 选项卡下添加一个名为 ACCESS_TOKEN 的秘密，使用你刚刚创建的个人访问令牌。不要担心，没有人会看到这个密码，因为它会被加密。
• 在 PyPI 上注册你的项目
  • 在 pypi.org 上创建一个账户
  • 前往你的 GitHub 仓库设置，在 Secrets 选项卡下添加一个名为 PYPI_TOKEN 的秘密，使用你的 PyPI 账户密码。不要担心，没有人会看到这个密码，因为它会被加密。
  • 下次将代码推送到 stable 分支时，GitHub Actions 将构建并将你的 Python 包部署到 PyPI
  • 建议：在推送 stable 分支之前，建议安装并运行 bumpversion，这将为 git 提交打上标签，并更新 setup.py 的版本号。
• 为 master 和 stable 分支添加分支保护
  • 为了防止任何人推送 master 或 stable 分支（这些分支有更多的测试和部署配置）
  • 前往你的 GitHub 仓库设置，在 Branches 选项卡下点击 添加规则 并选择你认为最佳的设置。
  • 建议
    • 在合并前要求进行拉取请求审查
    • 在合并前要求状态检查通过（建议：代码风格检查和测试）

建议的 Git 分支策略

1. master 分支用于最新的开发，你应该很少直接向这个分支提交代码。GitHub Actions 将在每次推送和 CRON 定时任务推送此分支时运行，但仍建议将代码提交到你的开发分支，并向 master 发起拉取请求。
2. stable 分支仅用于发布。当你想在 PyPI 上发布你的项目时，只需从 master 向 stable 发起一个 PR，只要你已经按照上述 可选步骤 部分添加了你的 PyPI 信息，这个模板就会处理剩下的工作。
3. 你的日常工作应该存在于与 master 分支分开的分支上。即使你只是自己在这个仓库上工作，也应该从你的工作分支向 master 发起 PR，以确保你的提交不会破坏开发头。GitHub Actions 将在向任何分支或从任何分支向任何其他分支的任何拉取请求的每次推送时运行。
4. 建议在提交PR时使用“Squash and Merge”合并提交。这使每批对master的更改具有原子性，并且作为副作用自然鼓励提交小型定义良好的PR。
5. GitHub的用户界面在将master分支变基到stable分支时很糟糕，因为它只是简单地将提交添加到其他分支，而不是从我所能看到的角度进行正确的变基。你应该在修复之前始终在本地使用CLI进行变基。

自由软件：BSD许可证