deecubes(DSSS - 该死的简单静态网址缩短器)
项目描述
# deecubes (Damn Simple Static url Shortener)
这个名字来自 Damn Simple Static url Shortener 的缩写 DSSS(所以,一个 D 和一个 S 的立方体。白痴,我知道 :P)。该程序允许维护一个短网址网站,类似于 bit.ly/tinyurl 等,可以重定向到较长的网址,因此必须记住/给出较短的网址。该项目的主要目的是允许通过静态网站而不是基于数据库的解决方案来完成。
静态网站有几个好处,比如它们更便宜(在 github/gitlab 上免费托管等),易于在几分钟内(如果不是几秒钟)迁移到任何主机等。除此之外,该项目努力使这个过程尽可能简单易用。
## 输入
要缩短的长网址
您要分配给它的助记符/短网址(可选。如果未给出,则自动生成)
##输出
短网址的静态网站重定向到您的长网址
也可以去shorturl/preview.html查看长网址指向而不被重定向。
# 演示网站:
https://shgl.in/ 使用这个项目。存储库供参考:https: //shgl.in/deecubesdemo
# 安装
建议使用 pip
```
pip install deecubes
```从 pypi 安装 deecubes
# 部署方法
您可以通过各种方式使用/部署自己的短网址网站下面给出更多:
- 在 github/gitlab 等上托管网站。在本地运行 deecubes cli 命令(在下一节中给出)以在 git 存储库中生成短网址。提交并上传。
- 在 github/gitlab 等上托管网站。在网站存储库中创建一个“源”分支。从 PC 或直接通过 Web 界面添加到输入目录的链接,并使用 CI 作业(如 Travis/CircleCI/Pipeline 等)使用“同步”命令自动生成短网址。https://shgl.in/ 使用这种方法。
- 创建您自己的自动化以在任何主机上托管输出目录(通过 API 或 挂载
目录
等
)
-g 网址 | -d 短网址 | -s] -r RAW_DATA_PATH
-o OUTPUT_PATH
可选参数:
-h,--help 显示此帮助消息并退出
-v,--version 显示程序的版本号并退出
-l LOGLEVEL,--log LOGLEVEL
设置日志级别。0=> 警告,1=>信息,2=>调试
-a SHORTURL URL,--add SHORTURL URL
为给定 URL 添加给定的
短 URL -g URL,--generate URL
为给定的 URL 生成短 URL
-d SHORTURL,--delete SHORTURL
删除给定的shorturl
-s, --sync 同步原始数据存储和html输出
所需参数:
-r RAW_DATA_PATH, --raw-data-path RAW_DATA_PATH
原始数据存储路径
-o OUTPUT_PATH, --output-path OUTPUT_PATH
HTML 输出路径
```
注意:
- 原始路径:deecubes 存储有关 url 的原始信息的目录。如果您对 url 使用添加/生成命令,这可以是空目录。否则,您可以在此处添加一个 .txt 文件,其内容为长 url。然后,当使用同步命令时,deecubes 会在输出目录中添加相应的 shorturl html 文件,使用文件名作为 shorturl。
- 输出路径:生成静态网站的路径。该目录应该用于部署。
- 必须为所有命令指定原始路径和输出路径
## 示例
为长 url 添加特定的 shorturl
```
deecubes -r ./raw -o ./public -a github https://github.com/shantanugoel/
```
添加一个长url,deecubes会自己生成一个短url
```
deecubes -r ./raw - o ./public -g https://github.com/shantanugoel/
```
为手动添加到原始目录的任何 .txt 文件在输出目录中自动生成短网址 `
``
deecubes -r ./raw -o ./ public --sync
```
# TODO
- 添加冲突处理
- 添加谷歌分析
- 添加可配置模板
- 建议?
这个名字来自 Damn Simple Static url Shortener 的缩写 DSSS(所以,一个 D 和一个 S 的立方体。白痴,我知道 :P)。该程序允许维护一个短网址网站,类似于 bit.ly/tinyurl 等,可以重定向到较长的网址,因此必须记住/给出较短的网址。该项目的主要目的是允许通过静态网站而不是基于数据库的解决方案来完成。
静态网站有几个好处,比如它们更便宜(在 github/gitlab 上免费托管等),易于在几分钟内(如果不是几秒钟)迁移到任何主机等。除此之外,该项目努力使这个过程尽可能简单易用。
## 输入
要缩短的长网址
您要分配给它的助记符/短网址(可选。如果未给出,则自动生成)
##输出
短网址的静态网站重定向到您的长网址
也可以去shorturl/preview.html查看长网址指向而不被重定向。
# 演示网站:
https://shgl.in/ 使用这个项目。存储库供参考:https: //shgl.in/deecubesdemo
# 安装
建议使用 pip
```
pip install deecubes
```从 pypi 安装 deecubes
# 部署方法
您可以通过各种方式使用/部署自己的短网址网站下面给出更多:
- 在 github/gitlab 等上托管网站。在本地运行 deecubes cli 命令(在下一节中给出)以在 git 存储库中生成短网址。提交并上传。
- 在 github/gitlab 等上托管网站。在网站存储库中创建一个“源”分支。从 PC 或直接通过 Web 界面添加到输入目录的链接,并使用 CI 作业(如 Travis/CircleCI/Pipeline 等)使用“同步”命令自动生成短网址。https://shgl.in/ 使用这种方法。
- 创建您自己的自动化以在任何主机上托管输出目录(通过 API 或 挂载
目录
等
)
-g 网址 | -d 短网址 | -s] -r RAW_DATA_PATH
-o OUTPUT_PATH
可选参数:
-h,--help 显示此帮助消息并退出
-v,--version 显示程序的版本号并退出
-l LOGLEVEL,--log LOGLEVEL
设置日志级别。0=> 警告,1=>信息,2=>调试
-a SHORTURL URL,--add SHORTURL URL
为给定 URL 添加给定的
短 URL -g URL,--generate URL
为给定的 URL 生成短 URL
-d SHORTURL,--delete SHORTURL
删除给定的shorturl
-s, --sync 同步原始数据存储和html输出
所需参数:
-r RAW_DATA_PATH, --raw-data-path RAW_DATA_PATH
原始数据存储路径
-o OUTPUT_PATH, --output-path OUTPUT_PATH
HTML 输出路径
```
注意:
- 原始路径:deecubes 存储有关 url 的原始信息的目录。如果您对 url 使用添加/生成命令,这可以是空目录。否则,您可以在此处添加一个 .txt 文件,其内容为长 url。然后,当使用同步命令时,deecubes 会在输出目录中添加相应的 shorturl html 文件,使用文件名作为 shorturl。
- 输出路径:生成静态网站的路径。该目录应该用于部署。
- 必须为所有命令指定原始路径和输出路径
## 示例
为长 url 添加特定的 shorturl
```
deecubes -r ./raw -o ./public -a github https://github.com/shantanugoel/
```
添加一个长url,deecubes会自己生成一个短url
```
deecubes -r ./raw - o ./public -g https://github.com/shantanugoel/
```
为手动添加到原始目录的任何 .txt 文件在输出目录中自动生成短网址 `
``
deecubes -r ./raw -o ./ public --sync
```
# TODO
- 添加冲突处理
- 添加谷歌分析
- 添加可配置模板
- 建议?