mintc

Name	mintc JSON
Version	0.0.4 JSON
	download
home_page	https://github.com/amateur80lvl/mintc
Summary	Minimalistic asyncio-based Tor Controller
upload_time	2023-07-26 08:05:14
maintainer
docs_url	None
author	amateur80lvl
requires_python
license
keywords	tor onion controller asyncio
VCS
bugtrack_url
requirements	No requirements were recorded.
Travis-CI	No Travis.
coveralls test coverage	No coveralls.

            # Minimalistic Tor Controller

Minimalistic asyncio-based Tor controller.

How to use:

```python

    from mintc import TorController

    tc = TorController('127.0.0.1:9051')
    try:
        await tc.start()
        await tc.authenticate('password')
        async for circuit in tc.get_circuits():
            print(circuit)
    finally:
        await tc.stop()
```

Or:

```python
    async with TorController('127.0.0.1:9051') as tc:
        await tc.authenticate('password')
        async for circuit in tc.get_circuits():
            print(circuit)
```

The format of control port argument passed to the constructor
is identical to `ControlPort` from `torrc`.

Only small subset of commands is implemented so far.

This controller neither does nor will implement auto reconnect.
It's the user's responsibility to catch any exceptions
and re-run the entire `async with TorController...` code block
or restart the controller with `tc.restart()` and start over again
from `tc.authenticate()`.

All response parsing is very minimalistic. E.g. date/time strings are not parsed.

            

Raw data

            {
    "_id": null,
    "home_page": "https://github.com/amateur80lvl/mintc",
    "name": "mintc",
    "maintainer": "",
    "docs_url": null,
    "requires_python": "",
    "maintainer_email": "",
    "keywords": "tor,onion,controller,asyncio",
    "author": "amateur80lvl",
    "author_email": "amateur80lvl@gmail.com",
    "download_url": "https://files.pythonhosted.org/packages/1c/71/da3ff3326a495304abae3f1bedf8c9ec31b61143da3c8ab7df2f76997b78/mintc-0.0.4.tar.gz",
    "platform": null,
    "description": "# Minimalistic Tor Controller\n\nMinimalistic asyncio-based Tor controller.\n\nHow to use:\n\n```python\n\n    from mintc import TorController\n\n    tc = TorController('127.0.0.1:9051')\n    try:\n        await tc.start()\n        await tc.authenticate('password')\n        async for circuit in tc.get_circuits():\n            print(circuit)\n    finally:\n        await tc.stop()\n```\n\nOr:\n\n```python\n    async with TorController('127.0.0.1:9051') as tc:\n        await tc.authenticate('password')\n        async for circuit in tc.get_circuits():\n            print(circuit)\n```\n\nThe format of control port argument passed to the constructor\nis identical to `ControlPort` from `torrc`.\n\nOnly small subset of commands is implemented so far.\n\nThis controller neither does nor will implement auto reconnect.\nIt's the user's responsibility to catch any exceptions\nand re-run the entire `async with TorController...` code block\nor restart the controller with `tc.restart()` and start over again\nfrom `tc.authenticate()`.\n\nAll response parsing is very minimalistic. E.g. date/time strings are not parsed.\n",
    "bugtrack_url": null,
    "license": "",
    "summary": "Minimalistic asyncio-based Tor Controller",
    "version": "0.0.4",
    "project_urls": {
        "Homepage": "https://github.com/amateur80lvl/mintc"
    },
    "split_keywords": [
        "tor",
        "onion",
        "controller",
        "asyncio"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "f3c22886dad954be7f70051ff6376c8c0ebc2299c80756cdf23666a017e212c6",
                "md5": "ba4bf19f3f12d4192852851ee6217566",
                "sha256": "7f3aa22cbd0cc123e8856f1efaac7ac222419660b443ce91e6f45ef7e5653072"
            },
            "downloads": -1,
            "filename": "mintc-0.0.4-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "ba4bf19f3f12d4192852851ee6217566",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": null,
            "size": 12817,
            "upload_time": "2023-07-26T08:05:12",
            "upload_time_iso_8601": "2023-07-26T08:05:12.435059Z",
            "url": "https://files.pythonhosted.org/packages/f3/c2/2886dad954be7f70051ff6376c8c0ebc2299c80756cdf23666a017e212c6/mintc-0.0.4-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "1c71da3ff3326a495304abae3f1bedf8c9ec31b61143da3c8ab7df2f76997b78",
                "md5": "674210e25f8d8dbe6dcd958b414b7388",
                "sha256": "c19266903a1b55133fc166588faac1272aa74623bb95b2c88f1e93fc1df1715e"
            },
            "downloads": -1,
            "filename": "mintc-0.0.4.tar.gz",
            "has_sig": false,
            "md5_digest": "674210e25f8d8dbe6dcd958b414b7388",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": null,
            "size": 11835,
            "upload_time": "2023-07-26T08:05:14",
            "upload_time_iso_8601": "2023-07-26T08:05:14.213202Z",
            "url": "https://files.pythonhosted.org/packages/1c/71/da3ff3326a495304abae3f1bedf8c9ec31b61143da3c8ab7df2f76997b78/mintc-0.0.4.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2023-07-26 08:05:14",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "amateur80lvl",
    "github_project": "mintc",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": false,
    "lcname": "mintc"
}