https://github.com/kost/micropython-socks

MicroPython library implementing SOCKS server.
https://github.com/kost/micropython-socks

Last synced: 24 days ago
JSON representation

MicroPython library implementing SOCKS server.

• Host: GitHub
• URL: https://github.com/kost/micropython-socks
• Owner: kost
• License: mit
• Created: 2020-10-10T19:29:24.000Z (about 4 years ago)
• Default Branch: master
• Last Pushed: 2020-10-11T15:36:57.000Z (about 4 years ago)
• Last Synced: 2024-10-03T06:58:23.664Z (about 1 month ago)
• Language: Python
• Size: 9.77 KB
• Stars: 5
• Watchers: 3
• Forks: 0
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • License: LICENSE.txt

Awesome Lists containing this project

• awesome-micropython - micropython-socks - MicroPython library implementing SOCKS server. (Libraries / Communications)

README

        
# MicroPython SOCKS server

A MicroPython library for SOCKS server.

## Installation

Installation can be done using upip or by manually uploading it to the device.

## Easy Installation

Just install it using upip - standard micropython packaging.

```

import upip

upip.install('micropython-socks')

```

## Manual Installation

Copy the file to your device, using ampy, webrepl or compiling and deploying. eg.

```

$ ampy put socks.py

```

# Usage

```python

import socks

socks.start()

```

```python

import socks

socks.stop()

```

```python

import socks

socks.help()

```

# Development

Building for distribution:

```

python setup.py sdist

```

Distribution of release:

```

python setup.py sdist

pip install twine

twine upload dist/*

```

## Links

* [micropython.org](http://micropython.org)

* [Adafruit Ampy](https://learn.adafruit.com/micropython-basics-load-files-and-run-code/install-ampy)

* [ESP32 PPP by Emard](https://github.com/emard/esp32ppp)

# License

Licensed under the [MIT License](http://opensource.org/licenses/MIT).