Add a remark for the file in the OS.
Project description
file-remark
Add a remark for the file in the OS.
用途
这是一个可以给系统中的文件或路径添加备注的小工具。
特点有:
- 使用绝对路径来匹配文件。
- 独立数据存储,不依赖于文件的meta信息。
缺点有:
- 文件如果移动后,就无法关联到备注信息(后续可以考虑添加md5匹配的机制)。
目的
之所以我会开发这么个小工具,是因为有时候会遇到需要给安装程序备注一个激活码,或者给压缩包备注一个解压密码的情况,此时多数情况是不得不添加一个额外的txt文件来说明,不仅麻烦,还显得很多余。
当然我也有在网上搜索类似的工具,但没有找到,只找到一个可以在文件的meta信息中写入备注的工具,但这个工具有个缺点,如果文件被修改了,meta信息就会被重写,导致添加的备注丢失。
使用说明
安装
pip install file-remark-icexmoon
更新
pip install file-remark-icexmoon --upgrade
显示当前目录下的文件和目录
pyfr
该命令可以同时显示已添加的文件备注和未添加备注的目录和文件。
比如:
❯ pyfr
LICENSE [this is a license for open source]
pyproject.toml [this is a test comment]
src [this is a source directory]
.git
.vscode
dist
README.md
setup.cfg
setup.py
tests
其中[xxx]
是添加的备注信息。默认先显示有备注的文件,再显示其他的,但也可以使用其它参数修改显示结果。
修改显示结果
可以使用多种参数修改显示结果:
-o
或--only_remark
:仅显示添加了备注的文件或目录。-l
或--remark_last
:将由备注信息的条目显示在最后。
添加备注
pyfr --add --file .\LICENSE --remark 'this is a license for open source'
或
pyfr -af .\LICENSE -r 'this is a license for open source'
-f
参数后是需要添加备注的文件路径,可以使用相对路径或绝对路径。-r
参数后是备注的内容,如果包含空白符需要使用引号包裹。
执行完毕后会自动打印当前目录下的条目以便查看添加结果。
目前只能添加备注,之后会增加修改备注和删除备注的功能。
更新日志
- 0.0.1 基础版本。
Project details
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
file-remark-icexmoon-0.0.1.tar.gz
(12.1 kB
view hashes)
Built Distribution
Close
Hashes for file-remark-icexmoon-0.0.1.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 1c963e236445513b3b19303d1208d33dac9391b93f41da04c473e5f4a450bd02 |
|
MD5 | c8fc94209359759a31163882f008d1d6 |
|
BLAKE2b-256 | 944ecddecefd177471f0c8d0bfddf9849514ffdbc5ba61639a9d6d3b153bdc2b |
Close
Hashes for file_remark_icexmoon-0.0.1-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 07d59871af5c8fbca73232c61cb3239a29cbb8a78ce66c88888b52893db9fc31 |
|
MD5 | 9b9c723064ac7c0c688aa612f002a827 |
|
BLAKE2b-256 | b5b056076dbe9db7a18a686c64117fc8bfcd07e447c3ca6211dbaae9b0950d39 |