https://github.com/aviksaikat/nipe_py

An engine to make Tor Network your default gateway.
https://github.com/aviksaikat/nipe_py

hatch hatchling nipe python python3 tor

Last synced: about 1 month ago
JSON representation

An engine to make Tor Network your default gateway.

• Host: GitHub
• URL: https://github.com/aviksaikat/nipe_py
• Owner: Aviksaikat
• License: mit
• Created: 2024-05-06T08:58:16.000Z (8 months ago)
• Default Branch: main
• Last Pushed: 2024-11-07T06:21:24.000Z (about 2 months ago)
• Last Synced: 2024-11-07T06:43:23.661Z (about 2 months ago)
• Topics: hatch, hatchling, nipe, python, python3, tor
• Language: Python
• Homepage: https://aviksaikat.github.io/nipe_py/
• Size: 151 KB
• Stars: 1
• Watchers: 1
• Forks: 0
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • Funding: .github/funding.yml
  • License: LICENSE

Awesome Lists containing this project

README

        
# nipe_py



    





[![Python](https://img.shields.io/badge/Python-3776AB.svg?style=flat&logo=Python&logoColor=white)](https://www.python.org/) [![Hatch project](https://img.shields.io/badge/%F0%9F%A5%9A-Hatch-4051b5.svg)](https://github.com/pypa/hatch) [![GitHub Actions](https://img.shields.io/badge/GitHub%20Actions-2088FF.svg?style=flat&logo=GitHub-Actions&logoColor=white)](https://github.com/features/actions)

[![PyPI version](https://img.shields.io/pypi/v/nipe_py.svg)](https://pypi.org/project/nipe_py)

[![PyPI - Python Version](https://img.shields.io/pypi/pyversions/nipe_py)](https://pypi.org/project/nipe_py/)

[![GitHub license](https://img.shields.io/github/license/aviksaikat/nipe_py?style=flat&color=1573D5)](https://github.com/aviksaikat/nipe_py/blob/main/LICENSE)



---

**Documentation**: https://aviksaikat.github.io/nipe_py/

**Source Code**: https://github.com/aviksaikat/nipe_py

---

Python version of [nipe](https://github.com/htrgouvea/nipe): An engine to make Tor Network your default gateway.

## Installation

```sh

pip install nipe_py

```

- You need to have tor installed & tor should be running. Confirm it by running

```sh

# this will start the tor service if not already running. If running then it'll restart it.

sudo systemctl restart tor

```

## Usage

```sh

$ nipe --help

Usage: nipe [OPTIONS] COMMAND [ARGS]...

Options:

  --help  Show this message and exit.

Commands:

  install  Install dependencies

  restart  Restart the Nipe circuit

  start    Start routing

  status   See status

  stop     Stop routing

  version  Show Version

```

## Demo

![](./assets/demo.gif)

## License

This project is licensed under the terms of the [MIT](./LICENSE) license.