Metadata-Version: 2.4
Name: openssh-synchronization
Version: 1.1.2
Summary: OpenSSH resource synchronization tool for Aliyun mirrors
Project-URL: Homepage, https://gitee.com/liumou_site/openssh-synchronization
Project-URL: Repository, https://gitee.com/liumou_site/openssh-synchronization
Project-URL: Documentation, https://gitee.com/liumou_site/openssh-synchronization#readme
Author-email: 坐公交也用券 <liumou.site@qq.com>
License:                                  Apache License
                                   Version 2.0, January 2004
                                http://www.apache.org/licenses/
        
           TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
        
           1. Definitions.
        
              "License" shall mean the terms and conditions for use, reproduction,
              and distribution as defined by Sections 1 through 9 of this document.
        
              "Licensor" shall mean the copyright owner or entity authorized by
              the copyright owner that is granting the License.
        
              "Legal Entity" shall mean the union of the acting entity and all
              other entities that control, are controlled by, or are under common
              control with that entity. For the purposes of this definition,
              "control" means (i) the power, direct or indirect, to cause the
              direction or management of such entity, whether by contract or
              otherwise, or (ii) ownership of fifty percent (50%) or more of the
              outstanding shares, or (iii) beneficial ownership of such entity.
        
              "You" (or "Your") shall mean an individual or Legal Entity
              exercising permissions granted by this License.
        
              "Source" form shall mean the preferred form for making modifications,
              including but not limited to software source code, documentation
              source, and configuration files.
        
              "Object" form shall mean any form resulting from mechanical
              transformation or translation of a Source form, including but
              not limited to compiled object code, generated documentation,
              and conversions to other media types.
        
              "Work" shall mean the work of authorship, whether in Source or
              Object form, made available under the License, as indicated by a
              copyright notice that is included in or attached to the work
              (an example is provided in the Appendix below).
        
              "Derivative Works" shall mean any work, whether in Source or Object
              form, that is based on (or derived from) the Work and for which the
              editorial revisions, annotations, elaborations, or other modifications
              represent, as a whole, an original work of authorship. For the purposes
              of this License, Derivative Works shall not include works that remain
              separable from, or merely link (or bind by name) to the interfaces of,
              the Work and Derivative Works thereof.
        
              "Contribution" shall mean any work of authorship, including
              the original version of the Work and any modifications or additions
              to that Work or Derivative Works thereof, that is intentionally
              submitted to Licensor for inclusion in the Work by the copyright owner
              or by an individual or Legal Entity authorized to submit on behalf of
              the copyright owner. For the purposes of this definition, "submitted"
              means any form of electronic, verbal, or written communication sent
              to the Licensor or its representatives, including but not limited to
              communication on electronic mailing lists, source code control systems,
              and issue tracking systems that are managed by, or on behalf of, the
              Licensor for the purpose of discussing and improving the Work, but
              excluding communication that is conspicuously marked or otherwise
              designated in writing by the copyright owner as "Not a Contribution."
        
              "Contributor" shall mean Licensor and any individual or Legal Entity
              on behalf of whom a Contribution has been received by Licensor and
              subsequently incorporated within the Work.
        
           2. Grant of Copyright License. Subject to the terms and conditions of
              this License, each Contributor hereby grants to You a perpetual,
              worldwide, non-exclusive, no-charge, royalty-free, irrevocable
              copyright license to reproduce, prepare Derivative Works of,
              publicly display, publicly perform, sublicense, and distribute the
              Work and such Derivative Works in Source or Object form.
        
           3. Grant of Patent License. Subject to the terms and conditions of
              this License, each Contributor hereby grants to You a perpetual,
              worldwide, non-exclusive, no-charge, royalty-free, irrevocable
              (except as stated in this section) patent license to make, have made,
              use, offer to sell, sell, import, and otherwise transfer the Work,
              where such license applies only to those patent claims licensable
              by such Contributor that are necessarily infringed by their
              Contribution(s) alone or by combination of their Contribution(s)
              with the Work to which such Contribution(s) was submitted. If You
              institute patent litigation against any entity (including a
              cross-claim or counterclaim in a lawsuit) alleging that the Work
              or a Contribution incorporated within the Work constitutes direct
              or contributory patent infringement, then any patent licenses
              granted to You under this License for that Work shall terminate
              as of the date such litigation is filed.
        
           4. Redistribution. You may reproduce and distribute copies of the
              Work or Derivative Works thereof in any medium, with or without
              modifications, and in Source or Object form, provided that You
              meet the following conditions:
        
              (a) You must give any other recipients of the Work or
                  Derivative Works a copy of this License; and
        
              (b) You must cause any modified files to carry prominent notices
                  stating that You changed the files; and
        
              (c) You must retain, in the Source form of any Derivative Works
                  that You distribute, all copyright, patent, trademark, and
                  attribution notices from the Source form of the Work,
                  excluding those notices that do not pertain to any part of
                  the Derivative Works; and
        
              (d) If the Work includes a "NOTICE" text file as part of its
                  distribution, then any Derivative Works that You distribute must
                  include a readable copy of the attribution notices contained
                  within such NOTICE file, excluding those notices that do not
                  pertain to any part of the Derivative Works, in at least one
                  of the following places: within a NOTICE text file distributed
                  as part of the Derivative Works; within the Source form or
                  documentation, if provided along with the Derivative Works; or,
                  within a display generated by the Derivative Works, if and
                  wherever such third-party notices normally appear. The contents
                  of the NOTICE file are for informational purposes only and
                  do not modify the License. You may add Your own attribution
                  notices within Derivative Works that You distribute, alongside
                  or as an addendum to the NOTICE text from the Work, provided
                  that such additional attribution notices cannot be construed
                  as modifying the License.
        
              You may add Your own copyright statement to Your modifications and
              may provide additional or different license terms and conditions
              for use, reproduction, or distribution of Your modifications, or
              for any such Derivative Works as a whole, provided Your use,
              reproduction, and distribution of the Work otherwise complies with
              the conditions stated in this License.
        
           5. Submission of Contributions. Unless You explicitly state otherwise,
              any Contribution intentionally submitted for inclusion in the Work
              by You to the Licensor shall be under the terms and conditions of
              this License, without any additional terms or conditions.
              Notwithstanding the above, nothing herein shall supersede or modify
              the terms of any separate license agreement you may have executed
              with Licensor regarding such Contributions.
        
           6. Trademarks. This License does not grant permission to use the trade
              names, trademarks, service marks, or product names of the Licensor,
              except as required for reasonable and customary use in describing the
              origin of the Work and reproducing the content of the NOTICE file.
        
           7. Disclaimer of Warranty. Unless required by applicable law or
              agreed to in writing, Licensor provides the Work (and each
              Contributor provides its Contributions) on an "AS IS" BASIS,
              WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
              implied, including, without limitation, any warranties or conditions
              of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
              PARTICULAR PURPOSE. You are solely responsible for determining the
              appropriateness of using or redistributing the Work and assume any
              risks associated with Your exercise of permissions under this License.
        
           8. Limitation of Liability. In no event and under no legal theory,
              whether in tort (including negligence), contract, or otherwise,
              unless required by applicable law (such as deliberate and grossly
              negligent acts) or agreed to in writing, shall any Contributor be
              liable to You for damages, including any direct, indirect, special,
              incidental, or consequential damages of any character arising as a
              result of this License or out of the use or inability to use the
              Work (including but not limited to damages for loss of goodwill,
              work stoppage, computer failure or malfunction, or any and all
              other commercial damages or losses), even if such Contributor
              has been advised of the possibility of such damages.
        
           9. Accepting Warranty or Additional Liability. While redistributing
              the Work or Derivative Works thereof, You may choose to offer,
              and charge a fee for, acceptance of support, warranty, indemnity,
              or other liability obligations and/or rights consistent with this
              License. However, in accepting such obligations, You may act only
              on Your own behalf and on Your sole responsibility, not on behalf
              of any other Contributor, and only if You agree to indemnify,
              defend, and hold each Contributor harmless for any liability
              incurred by, or claims asserted against, such Contributor by reason
              of your accepting any such warranty or additional liability.
        
           END OF TERMS AND CONDITIONS
        
           APPENDIX: How to apply the Apache License to your work.
        
              To apply the Apache License to your work, attach the following
              boilerplate notice, with the fields enclosed by brackets "[]"
              replaced with your own identifying information. (Don't include
              the brackets!)  The text should be enclosed in the appropriate
              comment syntax for the file format. We also recommend that a
              file or class name and description of purpose be included on the
              same "printed page" as the copyright notice for easier
              identification within third-party archives.
        
           Copyright [yyyy] [name of copyright owner]
        
           Licensed under the Apache License, Version 2.0 (the "License");
           you may not use this file except in compliance with the License.
           You may obtain a copy of the License at
        
               http://www.apache.org/licenses/LICENSE-2.0
        
           Unless required by applicable law or agreed to in writing, software
           distributed under the License is distributed on an "AS IS" BASIS,
           WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
           See the License for the specific language governing permissions and
           limitations under the License.
License-File: LICENSE
Keywords: aliyun,mirror,openssh,synchronization
Classifier: Development Status :: 4 - Beta
Classifier: Intended Audience :: System Administrators
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Requires-Python: >=3.7
Requires-Dist: beautifulsoup4>=4.9.0
Requires-Dist: click>=8.0.0
Requires-Dist: plsm>=0.1.0
Requires-Dist: requests>=2.25.0
Provides-Extra: dev
Requires-Dist: black>=21.0.0; extra == 'dev'
Requires-Dist: flake8>=3.9.0; extra == 'dev'
Requires-Dist: isort>=5.0.0; extra == 'dev'
Requires-Dist: pytest-cov>=2.0.0; extra == 'dev'
Requires-Dist: pytest>=6.0.0; extra == 'dev'
Description-Content-Type: text/markdown

# OpenSSH 资源同步工具

一个用于从阿里云镜像同步 OpenSSH 资源的 Python 工具，支持定时检测和版本过滤。

## 功能特性

- ✅ 从阿里云镜像同步 OpenSSH 资源
- ✅ 支持设置检测间隔时间（最小12小时）
- ✅ 版本过滤（只同步大于等于 openssh-10.2p1 的版本）
- ✅ 只同步 tar.gz 文件
- ✅ 无限循环后台守护进程
- ✅ Docker 容器化支持
- ✅ 命令行接口，易于使用
- ✅ 基于 pyproject.toml 最新标准
- ✅ systemd 服务管理（注册、状态查看、删除）
- ✅ 自动服务注册功能
- ✅ 服务健康状态监控

## 安装

### 从源码安装

```bash
# 克隆项目
git clone https://gitee.com/liumou_site/openssh-synchronization.git
cd openssh-synchronization

# 安装依赖
pip install .

# 或者安装开发版本
pip install -e .
```

### 从 PyPI 安装（未来发布）

```bash
pip install openssh-synchronization
```

#### 使用清华大学 PyPI 镜像源加速安装

```bash
# 临时使用清华镜像源
pip install -i https://pypi.tuna.tsinghua.edu.cn/simple openssh-synchronization

# 或者设置清华镜像源为默认源
pip config set global.index-url https://pypi.tuna.tsinghua.edu.cn/simple
pip install openssh-synchronization
```

### Docker 安装

#### 构建镜像

```bash
# 构建Docker镜像
docker build -t openssh-sync .

# 或者使用docker-compose
docker-compose build
```

#### 运行容器

```bash
# 直接运行（推荐使用环境变量配置）
docker run -d \
  --name openssh-sync \
  -v /path/to/downloads:/data/openssh \
  -e CHECK_INTERVAL=24 \
  -e DOWNLOAD_DIR=/data/openssh \
  -e MIN_VERSION=10.3.0 \
  -e DEBUG=false \
  openssh-sync

# 使用docker-compose
docker-compose up -d
```

#### 查看日志

```bash
# 查看容器日志
docker logs openssh-sync

# 实时查看日志
docker logs -f openssh-sync
```

## 快速开始

### 查看帮助

```bash
openssh-sync --help
```

### 列出可用版本

```bash
openssh-sync list
```

输出示例：
```
🔍 正在获取OpenSSH版本列表...
📋 找到 3 个符合条件的版本:
------------------------------------------------------------
🔸 openssh-10.2p1
   文件: openssh-10.2p1.tar.gz
   大小: 1.9 MB

🔸 openssh-10.1p1
   文件: openssh-10.1p1.tar.gz
   大小: 1.9 MB

💡 提示: 使用 'openssh-sync sync' 命令下载这些版本
```

### 执行一次性同步

```bash
# 使用默认配置
openssh-sync sync

# 自定义参数
openssh-sync sync --interval 48 --dir /opt/openssh --min-version 10.3.0
```

### 启动定时同步服务

```bash
# 启动守护进程
openssh-sync daemon --interval 24 --dir /tmp/openssh

# 使用配置文件
openssh-sync daemon --config-file config.json

# 启动守护进程并自动注册为systemd服务
openssh-sync daemon --auto-register
```

### systemd 服务管理

```bash
# 注册为systemd服务
openssh-sync register

# 强制重新注册服务
openssh-sync register --force

# 查看服务状态
openssh-sync status

# 删除服务
openssh-sync unregister
```

### 生成配置文件

```bash
# 生成默认配置文件
openssh-sync config

# 生成自定义配置文件
openssh-sync config --interval 48 --dir /opt/openssh --extract --output my-config.json
```

## 配置说明

### 环境变量配置

OpenSSH同步工具支持通过环境变量配置参数，优先级：命令行参数 > 环境变量 > 默认值

| 环境变量 | 说明 | 示例值 | 默认值 |
|----------|------|--------|--------|
| `CHECK_INTERVAL` | 检查间隔时间（小时） | `24` | `24` |
| `DOWNLOAD_DIR` | 下载目录路径 | `/tmp/openssh` | `./downloads` |
| `MIN_VERSION` | 最小版本要求 | `10.2.1` | `10.2.1` |
| `DEBUG` | 启用调试模式 | `true` | `false` |

**使用示例：**
```bash
# 通过环境变量配置
CHECK_INTERVAL=36 DOWNLOAD_DIR=/tmp/openssh MIN_VERSION=10.3.1 DEBUG=true openssh-sync sync

# 容器环境推荐用法
docker run -d \
  -e CHECK_INTERVAL=24 \
  -e DOWNLOAD_DIR=/data/openssh \
  -e MIN_VERSION=10.3.0 \
  -e DEBUG=false \
  openssh-sync
```

### 命令行参数

| 参数 | 说明 | 示例值 | 默认值 |
|------|------|--------|--------|
| `--interval`, `-i` | 检查间隔时间（小时） | `24` | `24` |
| `--dir`, `-d` | 下载目录路径 | `/tmp/openssh` | `./downloads` |
| `--min-version` | 最小版本要求 | `10.2.1` | `10.2.1` |
| `--debug` | 启用调试模式 | `--debug` | `False` |
| `--config-file` | 配置文件路径 | `/etc/openssh-sync.json` | `None` |

### 配置文件格式

生成的 JSON 配置文件示例：

```json
{
  "check_interval": 24,
  "download_dir": "./downloads",
  "min_version": [10, 2, 1],
  "mirror_url": "https://mirrors.aliyun.com/openssh/portable",
  "timeout": 30,
  "debug": false
}
```

### systemd 服务配置

OpenSSH同步工具注册为systemd服务后，会创建以下配置：

**服务文件位置：** `/etc/systemd/system/openssh-sync.service`

**服务配置内容：**
```ini
[Unit]
Description=OpenSSH Synchronization Service
After=network.target

[Service]
Type=simple
User=root
WorkingDirectory=/vdb/git/gitee/python/pypi/openssh-synchronization
ExecStart=/usr/bin/python3 /vdb/git/gitee/python/pypi/openssh-synchronization/openssh_sync/cli.py daemon
Restart=on-failure
RestartSec=5

[Install]
WantedBy=multi-user.target
```

**服务管理命令：**
```bash
# 启动服务
sudo systemctl start openssh-sync

# 停止服务
sudo systemctl stop openssh-sync

# 重启服务
sudo systemctl restart openssh-sync

# 查看服务状态
sudo systemctl status openssh-sync

# 启用开机自启
sudo systemctl enable openssh-sync

# 禁用开机自启
sudo systemctl disable openssh-sync

# 查看服务日志
sudo journalctl -u openssh-sync -f
```

## API 使用

### 基本用法

```python
from openssh_sync import Config, OpenSSHSync

# 创建配置
config = Config(
    check_interval=24,           # 检查间隔：24小时
    download_dir="/tmp/openssh"  # 下载目录
)

# 创建同步实例
sync_tool = OpenSSHSync(config)

# 执行同步
success = sync_tool.sync_files()

if success:
    print("同步成功")
else:
    print("同步失败")
```

### 高级用法

```python
from openssh_sync import create_sync, create_config_from_dict

# 从字典创建配置
config_dict = {
    'check_interval': 48,
    'download_dir': '/opt/openssh',
    'min_version': [10, 3, 0],
    'debug': True
}

config = create_config_from_dict(config_dict)
sync_tool = create_sync(config)

# 获取文件列表
files = sync_tool.get_file_list()
for file_info in files:
    print(f"版本: {file_info['version']}, 文件: {file_info['filename']}")

# 启动定时同步
sync_tool.start_scheduled_sync()
```

## 项目结构

```
openssh-synchronization/
├── pyproject.toml          # 项目配置
├── README.md               # 项目说明
├── LICENSE                 # 许可证
├── .gitignore             # Git忽略文件
└── openssh_sync/          # 主程序包
    ├── __init__.py        # 包初始化
    ├── main.py            # 主程序逻辑
    ├── config.py          # 配置管理
    ├── utils.py           # 工具函数
    └── cli.py             # 命令行接口
```

## 开发

### 安装开发依赖

```bash
pip install -e .[dev]
```

### 运行测试

```bash
pytest
```

### 代码格式化

```bash
black openssh_sync/
isort openssh_sync/
```

## 许可证

本项目采用 MIT 许可证 - 详见 [LICENSE](LICENSE) 文件。

## 贡献

欢迎提交 Issue 和 Pull Request！

## 更新日志

### v1.1.0 (2024-01-01)

- 新增 systemd 服务管理功能
  - 添加 `register` 命令：注册为 systemd 服务
  - 添加 `status` 命令：查看服务状态和健康状态
  - 添加 `unregister` 命令：删除 systemd 服务
  - 添加 `daemon --auto-register` 选项：自动检测并注册服务
- 集成 plsm 库实现专业的 systemd 服务管理
- 优化 CLI 命令结构和错误处理
- 更新文档和示例

### v1.0.0 (2024-01-01)

- 初始版本发布
- 支持 OpenSSH 资源同步
- 支持定时检测和版本过滤
- 提供命令行接口和 API

## 技术支持

如有问题，请提交 [Issue](https://gitee.com/yourusername/openssh-synchronization/issues) 或联系开发者。
