Metadata-Version: 2.1
Name: sspymgr
Version: 0.0.20
Summary: Web Manager for Shadowsocks Service, Python Version
Home-page: http://github.com/brifuture/minor-sspymgr
Author: BriFuture
Author-email: jw.brifuture@gmail.com
License: GPLv3
Keywords: webserver,shadowsocks-manager
Platform: UNKNOWN
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3
Classifier: License :: OSI Approved :: GNU General Public License v3 (GPLv3)
Classifier: Operating System :: OS Independent
Description-Content-Type: text/markdown
Requires-Dist: amqp (==2.3.2)
Requires-Dist: argh (==0.26.2)
Requires-Dist: billiard (==3.5.0.4)
Requires-Dist: celery (==4.2.1)
Requires-Dist: cffi (==1.11.5)
Requires-Dist: Click (==7.0)
Requires-Dist: Flask (==1.0.2)
Requires-Dist: Flask-Cors (==3.0.7)
Requires-Dist: Flask-SQLAlchemy (==2.3.2)
Requires-Dist: gevent (==1.3.7)
Requires-Dist: greenlet (==0.4.15)
Requires-Dist: itsdangerous (==0.24)
Requires-Dist: Jinja2 (==2.10)
Requires-Dist: kombu (==4.2.1)
Requires-Dist: MarkupSafe (==1.0)
Requires-Dist: pathtools (==0.1.2)
Requires-Dist: pycparser (==2.19)
Requires-Dist: pytz (==2018.6)
Requires-Dist: PyYAML (==3.13)
Requires-Dist: redis (==2.10.6)
Requires-Dist: schedule (==0.6.0)
Requires-Dist: shadowsocks-py (==2.9.1)
Requires-Dist: six (==1.11.0)
Requires-Dist: SQLAlchemy (==1.2.12)
Requires-Dist: vine (==1.1.4)
Requires-Dist: watchdog (==0.9.0)
Requires-Dist: Werkzeug (==0.14.1)

# Minor-sspymgr (sspymgr): Manager Written in Python

This Project is another version that is written with Python of [shadowsocks-manager](https://github.com/shadowsocks/shadowsocks-manager) which is based on Nodejs.  

The original purpose of this project is to enable the manager to run in a machine whose memory is not so sufficient. It is based on myself needs, because I found that it takes almost 100M of memories to run [Shadowsocks](https://github.com/shadowsocks/shadowsocks-manager) on my server whose memory is only 512M. It's a little expensive when running the server. Alternatively, you can keep only the ssmgr program running in background. 

It is a python-learning project for me. I learned a lot from [shadowsocks-manager](https://github.com/shadowsocks/shadowsocks-manager) which is written in JavaScript, then i make a more suitable program named minor-sspymgr for personal usage. The advantage of this application is that it may consume 50M memory while running, much less compared with shadowsocks-manager.

## How to use

It's simple to use sspymgr to deploy a website with shadowsocks service running backend, you can install it by pip / pip3:

```bash
pip install sspymgr
```

Note: sspymgr only supports python3.x.

Or you can download the source code from github if you got git:

1. git clone https://github.com/brifuture/minor-sspymgr.git
2. cd minor-sspymgr
3. python3 ./setup.py install

After installation, simply type `sspymgr` in console will start sspymgr which would launch a website at 80 port (or 5050 port when debug is enabled). You can see more command line arguments by typing `sspymgr -h`.

You may find some useful instructions in [addition.doc](./docs/addition.md). Or if you want to know more about how I make this website application, you may have a look on [about_sspymgr.md](./docs/about_sspymgr.md) although some parts may be out of date because it changed a lot as I developed the application.

## TODO List

- database
    * database lazy loading and creation, command line arguments option add `-c` or `--config` to set config file
- admin
    * setting subsystem optimizing
    * order subsystem details for confirm
- other
    * optional: data migration and database upgrade
    * plugin system optimize, all helper instances should be attached to app instance

## Thanks To Following Projects

-  Backend: flask and some extensions for flask such as flask_sqlalchemy, shedule
-  UI(frontend): vue, bootstrap, ant-design, ext.
-  Reference: shadowsocks-manager

## License

License is under [GPLv3](./license)


