# Vermils Magic Pocket 4 Python
## Installation
### Basic
```Bash
pip install vermils
```
### With HTTP support
Required by `vermils.io.puller`
```Bash
pip install vermils[http]
```
### With full support
```Bash
pip install vermils[all]
```
## Importing
```Python
import vermils
```
## Table of Contents
**Most of the codes are easy to understand or well documented, the documentation is only for the more complex ones.**
### `vermils.asynctools`
Tools for asynchronous programming.
- `sync_await`: Run async functions in a sync environment.
- `ensure_async`: Wraps a function/generator into an async function if it's a sync one.
- `to_async`: Wraps a function into an async function blindly.
- `to_async_gen`: Wraps a generator into an async generator blindly.
- `get_create_loop`: Get the current event loop or create a new one if there isn't one. Works in another thread, unlike `asyncio.`get_event_loop`.
- `async_run`: Run sync functions asynchronously in another thread without wrapping first.
- `AsinkRunner`: A class that runs sync functions asynchronously and sequentially in another thread.
- `select`: Similar to `select` in Go, supports both awaitables and async generators.
Documentation: [vermils.asynctools](./docs_old/asynctools.md)
### `vermils.collections`
Collections of useful classes.
- `fridge`: Make things immutable and hashable.
- `FrozenDict`: A dict that is immutable and hashable.
- `FrozenList`: A list that is immutable and hashable. Basically, a tuple but can be compared with lists.
- `freeze`: Recursively freeze an object.
- `StrChain`: A simple way to create strings. Extremely useful.
- `ObjDict`: A dict that can be accessed like an object.
Documentation: [vermils.asynctools](./docs_old/collections.md)
### `vermils.gadgets`
Snippets of code that I am too lazy to categorize.
- `sidelogging.SideLogger`: Move any `LoggerLike` into another thread.
- `MonoLogger`: Log different levels of messages to different files.
- `stringify_keys`: Recursively convert all keys in a dict to strings.
- `supports_in`: Check if an object supports `in`.
- `mimics`: A decorator that makes a function mimic another function.
- `sort_class`: Sort class by inheritance, child classes first.
- `str_to_object`: Convert a string to an object.
- `real_dir`: Get the real directory of a file. Auto expands `~` and env vars.
- `real_path`: Get the real path of a file. Auto expands `~` and env vars.
- `version_cmp`: Compare two SemVer strings.
- `to_ordinal`: Convert an integer to its ordinal form.
- `selenium_cookies_to_jar`: Convert Selenium cookies to a `http.cookiejar.CookieJar` object.
Documentation: [vermils.gadgets](./docs_old/gadgets.md)
### `vermils.io`
Tools for I/O.
- `aio`: Async IO
- `os`: Async version of some `os` functions.
- `fsync`
- `link`
- `symlink`
- `mkdir`
- `makedirs`
- `remove`
- ... and more
- `path`: Async version of some `os.path` functions
- `exists`
- `isdir`
- `isfile`
- `islink`
- ... and more
- `puller`: A multithread async downloader module
- `AsyncPuller`: A class that downloads files asynchronously.
- `Modifier`: A class that modifies the behaviour of the puller, e.g show a progress bar.
- `DummyFileStream`: A dummy file stream that does nothing.
- `DummyAioFileStream`: A dummy async file stream that does nothing.
Documentation: [vermils.io](./docs_old/io.md)
### `vermils.react`
A simple event system.
- `ActionChain`: A chain of functions that can be executed in order or in parallel.
- `ActionCentipede`: The output of a function becomes the input of the next function.
- `EventHook`: A simple event hook, that binds events to chains of functions.
Documentation: [vermils.react](./docs_old/react.md)
### `vermils.tensorflow`
TensorFlow related tools.
- `inspect`
- `callbacks`
- `layers`
- `metrics`
- `models`
Documentation: [vermils.tensorflow](./docs_old/tensorflow.md)
Raw data
{
"_id": null,
"home_page": "https://github.com/VermiIIi0n/VermilsMagicPocket",
"name": "vermils",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.10,<4.0",
"maintainer_email": "",
"keywords": "utilities",
"author": "VermiIIi0n",
"author_email": "dungeon.behind0t@icloud.com",
"download_url": "https://files.pythonhosted.org/packages/f2/fc/27490ef4e9709537fe9852015a7218242564b9258f1942e3b2af345a2fde/vermils-0.3.5.tar.gz",
"platform": null,
"description": "# Vermils Magic Pocket 4 Python\n\n## Installation\n\n### Basic\n\n```Bash\npip install vermils\n```\n\n### With HTTP support\n\nRequired by `vermils.io.puller`\n\n```Bash\npip install vermils[http]\n```\n\n### With full support\n\n```Bash\npip install vermils[all]\n```\n\n## Importing\n\n```Python\nimport vermils\n```\n\n## Table of Contents\n\n**Most of the codes are easy to understand or well documented, the documentation is only for the more complex ones.**\n\n### `vermils.asynctools`\n\nTools for asynchronous programming.\n\n- `sync_await`: Run async functions in a sync environment.\n- `ensure_async`: Wraps a function/generator into an async function if it's a sync one.\n- `to_async`: Wraps a function into an async function blindly.\n- `to_async_gen`: Wraps a generator into an async generator blindly.\n- `get_create_loop`: Get the current event loop or create a new one if there isn't one. Works in another thread, unlike `asyncio.`get_event_loop`.\n- `async_run`: Run sync functions asynchronously in another thread without wrapping first.\n- `AsinkRunner`: A class that runs sync functions asynchronously and sequentially in another thread.\n- `select`: Similar to `select` in Go, supports both awaitables and async generators.\n\nDocumentation: [vermils.asynctools](./docs_old/asynctools.md)\n\n### `vermils.collections`\n\nCollections of useful classes.\n\n- `fridge`: Make things immutable and hashable.\n - `FrozenDict`: A dict that is immutable and hashable.\n - `FrozenList`: A list that is immutable and hashable. Basically, a tuple but can be compared with lists.\n - `freeze`: Recursively freeze an object.\n- `StrChain`: A simple way to create strings. Extremely useful.\n- `ObjDict`: A dict that can be accessed like an object.\n\nDocumentation: [vermils.asynctools](./docs_old/collections.md)\n\n### `vermils.gadgets`\n\nSnippets of code that I am too lazy to categorize.\n\n- `sidelogging.SideLogger`: Move any `LoggerLike` into another thread.\n- `MonoLogger`: Log different levels of messages to different files.\n- `stringify_keys`: Recursively convert all keys in a dict to strings.\n- `supports_in`: Check if an object supports `in`.\n- `mimics`: A decorator that makes a function mimic another function.\n- `sort_class`: Sort class by inheritance, child classes first.\n- `str_to_object`: Convert a string to an object.\n- `real_dir`: Get the real directory of a file. Auto expands `~` and env vars.\n- `real_path`: Get the real path of a file. Auto expands `~` and env vars.\n- `version_cmp`: Compare two SemVer strings.\n- `to_ordinal`: Convert an integer to its ordinal form.\n- `selenium_cookies_to_jar`: Convert Selenium cookies to a `http.cookiejar.CookieJar` object.\n\nDocumentation: [vermils.gadgets](./docs_old/gadgets.md)\n\n### `vermils.io`\n\nTools for I/O.\n\n- `aio`: Async IO\n - `os`: Async version of some `os` functions.\n - `fsync`\n - `link`\n - `symlink`\n - `mkdir`\n - `makedirs`\n - `remove`\n - ... and more\n - `path`: Async version of some `os.path` functions\n - `exists`\n - `isdir`\n - `isfile`\n - `islink`\n - ... and more\n- `puller`: A multithread async downloader module\n - `AsyncPuller`: A class that downloads files asynchronously.\n - `Modifier`: A class that modifies the behaviour of the puller, e.g show a progress bar.\n- `DummyFileStream`: A dummy file stream that does nothing.\n- `DummyAioFileStream`: A dummy async file stream that does nothing.\n\nDocumentation: [vermils.io](./docs_old/io.md)\n\n### `vermils.react`\n\nA simple event system.\n\n- `ActionChain`: A chain of functions that can be executed in order or in parallel.\n- `ActionCentipede`: The output of a function becomes the input of the next function.\n- `EventHook`: A simple event hook, that binds events to chains of functions.\n\nDocumentation: [vermils.react](./docs_old/react.md)\n\n### `vermils.tensorflow`\n\nTensorFlow related tools.\n\n- `inspect`\n- `callbacks`\n- `layers`\n- `metrics`\n- `models`\n\nDocumentation: [vermils.tensorflow](./docs_old/tensorflow.md)\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "",
"version": "0.3.5",
"project_urls": {
"Homepage": "https://github.com/VermiIIi0n/VermilsMagicPocket",
"Issues": "https://github.com/VermiIIi0n/VermilsMagicPocket/issues"
},
"split_keywords": [
"utilities"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "b482d1e0efaeda1a830d8f97f449fbe0caad95ce80ab8d5dd951a5589aadb75a",
"md5": "e187e4ae376d1c5ed0561b0006f31112",
"sha256": "fe1cecb4df1f0038112e773516bb96c8dbe5c0c8677358c0eb52bfcd2d1ed58f"
},
"downloads": -1,
"filename": "vermils-0.3.5-py3-none-any.whl",
"has_sig": false,
"md5_digest": "e187e4ae376d1c5ed0561b0006f31112",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.10,<4.0",
"size": 36146,
"upload_time": "2024-02-17T05:45:57",
"upload_time_iso_8601": "2024-02-17T05:45:57.869540Z",
"url": "https://files.pythonhosted.org/packages/b4/82/d1e0efaeda1a830d8f97f449fbe0caad95ce80ab8d5dd951a5589aadb75a/vermils-0.3.5-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "f2fc27490ef4e9709537fe9852015a7218242564b9258f1942e3b2af345a2fde",
"md5": "c4e6eabaad8d1a3fe7eb64411f3578d3",
"sha256": "380f9df6559efafae7704fad4cb95e4426d16aa0124c53ec034500789998d037"
},
"downloads": -1,
"filename": "vermils-0.3.5.tar.gz",
"has_sig": false,
"md5_digest": "c4e6eabaad8d1a3fe7eb64411f3578d3",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.10,<4.0",
"size": 29512,
"upload_time": "2024-02-17T05:46:00",
"upload_time_iso_8601": "2024-02-17T05:46:00.113707Z",
"url": "https://files.pythonhosted.org/packages/f2/fc/27490ef4e9709537fe9852015a7218242564b9258f1942e3b2af345a2fde/vermils-0.3.5.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-02-17 05:46:00",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "VermiIIi0n",
"github_project": "VermilsMagicPocket",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "vermils"
}
JSON
