50 lines
1003 B
Markdown
50 lines
1003 B
Markdown
# Scientific Surfing
|
|
|
|
A Python package for surfing internet scientifically.
|
|
|
|
## Features
|
|
|
|
- **Clash RSS Subscription Support**: Download and transform clash rss subscription
|
|
|
|
## Installation
|
|
|
|
### 1. Clone into local
|
|
```bash
|
|
git clone https://github.com/klesh/scientific-surfing.git
|
|
cd scientific-surfing
|
|
poetry install
|
|
```
|
|
|
|
### 2. Add the root directory to system PATH
|
|
|
|
## Quick Start
|
|
|
|
```
|
|
# add a subscription
|
|
python -m scientific_surfing subscription add <name> <clash-rss-subscription-url>
|
|
|
|
# refresh a subscription
|
|
python -m scientific_surfing subscription refresh name
|
|
|
|
# delete a subscription
|
|
python -m scientific_surfing subscription rm <name>
|
|
|
|
# rename a subscription
|
|
python -m scientific_surfing subscription rename <name> <new-name>
|
|
|
|
# activate a subscription
|
|
python -m scientific_surfing subscription activate <name>
|
|
```
|
|
|
|
## Development
|
|
|
|
This project uses Poetry for dependency management:
|
|
|
|
```bash
|
|
poetry install
|
|
poetry run pytest
|
|
```
|
|
|
|
## License
|
|
|
|
MIT License - see LICENSE file for details. |