klesh/ss
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

fix: poetry

Browse Source
This commit is contained in:
Klesh Wong
2025-12-26 20:50:32 +08:00
parent eba15efd46
commit c1e965af22
3 changed files with 218 additions and 35 deletions
Download Patch File Download Diff File Expand all files Collapse all files

49
README.md
View File

@ -13,9 +13,10 @@ A Python package for surfing internet scientifically.
### 1. Clone into local
```bash
git clone https://github.com/klesh/scientific-surfing.git
cd scientific-surfing
poetry install
git clone ssh://git@gitea.epss.net.cn:2223/klesh/ss.git
cd ss
brew install poetry
poetry config --local virtualenvs.in-project true
```
### 2. Add the root directory to system PATH
@ -25,77 +26,77 @@ poetry install
### Subscription Management
```bash
# add a subscription
python -m scientific_surfing subscription add <name> <clash-rss-subscription-url>
python -m ss subscription add <name> <clash-rss-subscription-url>
# refresh a subscription
python -m scientific_surfing subscription refresh <name>
python -m ss subscription refresh <name>
# delete a subscription
python -m scientific_surfing subscription rm <name>
python -m ss subscription rm <name>
# rename a subscription
python -m scientific_surfing subscription rename <name> <new-name>
python -m ss subscription rename <name> <new-name>
# update subscription URL
python -m scientific_surfing subscription set-url <name> <new-url>
python -m ss subscription set-url <name> <new-url>
# activate a subscription
python -m scientific_surfing subscription activate <name>
python -m ss subscription activate <name>
# list all subscriptions
python -m scientific_surfing subscription list
python -m ss subscription list
# show storage information
python -m scientific_surfing subscription storage
python -m ss subscription storage
```
### Hook Management
```bash
# initialize hooks directory with template scripts
python -m scientific_surfing hook init
python -m ss hook init
# show hooks directory location and list all scripts
python -m scientific_surfing hook list
python -m ss hook list
# edit a hook script with system editor
python -m scientific_surfing hook edit <script-name>
python -m ss hook edit <script-name>
# remove a hook script
python -m scientific_surfing hook rm <script-name>
python -m ss hook rm <script-name>
```
### Core Configuration Management
```bash
# import configuration from file
python -m scientific_surfing core config import <file-path>
python -m ss core config import <file-path>
# export configuration to file
python -m scientific_surfing core config export <file-path>
python -m ss core config export <file-path>
# edit configuration with system editor
python -m scientific_surfing core config edit
python -m ss core config edit
# reset configuration to default values
python -m scientific_surfing core config reset
python -m ss core config reset
# show current configuration
python -m scientific_surfing core config show
python -m ss core config show
# apply active subscription to generate final config
python -m scientific_surfing core config apply
python -m ss core config apply
```
### Core Management
```bash
# update scientific-surfing core components
python -m scientific_surfing core update [--version <version>] [--force]
python -m ss core update [--version <version>] [--force]
```
### Service Management
Linux / macOS
```nushell
sudo env SF_CONFIG_DIR=(readlink -f ~/basicfiles/cli/scientific_surfing) .venv/bin/python -m scientific_surfing core service install
sudo env SF_CONFIG_DIR=$HOME/basicfiles/cli/ss python3 -m ss core service install
```
## Development
@ -109,4 +110,4 @@ poetry run pytest
## License
MIT License - see LICENSE file for details.
MIT License - see LICENSE file for details.