| Name | uncover JSON |
| Version |
0.0.0
JSON |
| download |
| home_page | |
| Summary | Uncover runtime objects. Enlighten your mind. Sleep soundly. |
| upload_time | 2023-11-25 17:23:08 |
| maintainer | |
| docs_url | None |
| author | bswck |
| requires_python | >=3.8,<4.0 |
| license | MIT |
| keywords |
|
| VCS |
|
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# uncover [](https://pypi.org/project/uncover) [](https://pypi.org/project/uncover)
[](https://github.com/bswck/uncover/actions/workflows/test.yml)
[](https://coverage-badge.samuelcolvin.workers.dev/redirect/bswck/uncover)
[](https://github.com/astral-sh/ruff)
[](https://github.com/psf/black)
[](https://github.com/bswck/uncover/blob/HEAD/LICENSE)
[](https://github.com/pre-commit/pre-commit)
Uncover runtime objects. Enlighten your mind. Sleep soundly.
# Installation
If you want to…
## …use this tool in your project 💻
You might simply install it with pip:
pip install uncover
If you use [Poetry](https://python-poetry.org/), then run:
poetry add uncover
## …contribute to [uncover](https://github.com/bswck/uncover) 🚀
Happy to accept contributions!
> [!Note]
> If you use Windows, it is highly recommended to complete the installation in the way presented below through [WSL2](https://learn.microsoft.com/en-us/windows/wsl/install).
First, [install Poetry](https://python-poetry.org/docs/#installation).<br/>
Poetry is an amazing tool for managing dependencies & virtual environments, building packages and publishing them.
pipx install poetry
<sub>If you encounter any problems, refer to [the official documentation](https://python-poetry.org/docs/#installation) for the most up-to-date installation instructions.</sub>
Be sure to have Python 3.8 installed—if you use [pyenv](https://github.com/pyenv/pyenv#readme), simply run:
pyenv install 3.8
Then, run:
git clone https://github.com/bswck/uncover path/to/uncover
cd path/to/uncover
poetry env use $(cat .python-version)
poetry install
poetry shell
pre-commit install --hook-type pre-commit --hook-type pre-push
# Legal info
© Copyright by Bartosz Sławecki ([@bswck](https://github.com/bswck)).<br />This software is licensed under the [MIT License](https://github.com/bswck/uncover/blob/main/LICENSE).
Raw data
{
"_id": null,
"home_page": "",
"name": "uncover",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.8,<4.0",
"maintainer_email": "",
"keywords": "",
"author": "bswck",
"author_email": "bswck.dev@gmail.com",
"download_url": "https://files.pythonhosted.org/packages/7d/28/692c76e5fe3428fb974b346fd9f53f5e8640a0810af88d408f100969d817/uncover-0.0.0.tar.gz",
"platform": null,
"description": "# uncover [](https://pypi.org/project/uncover) [](https://pypi.org/project/uncover)\n[](https://github.com/bswck/uncover/actions/workflows/test.yml)\n[](https://coverage-badge.samuelcolvin.workers.dev/redirect/bswck/uncover)\n[](https://github.com/astral-sh/ruff)\n[](https://github.com/psf/black)\n[](https://github.com/bswck/uncover/blob/HEAD/LICENSE)\n[](https://github.com/pre-commit/pre-commit)\n\nUncover runtime objects. Enlighten your mind. Sleep soundly.\n\n\n# Installation\nIf you want to\u2026\n\n\n## \u2026use this tool in your project \ud83d\udcbb\nYou might simply install it with pip:\n\n pip install uncover\n\nIf you use [Poetry](https://python-poetry.org/), then run:\n\n poetry add uncover\n\n## \u2026contribute to [uncover](https://github.com/bswck/uncover) \ud83d\ude80\n\nHappy to accept contributions!\n\n> [!Note]\n> If you use Windows, it is highly recommended to complete the installation in the way presented below through [WSL2](https://learn.microsoft.com/en-us/windows/wsl/install).\n\nFirst, [install Poetry](https://python-poetry.org/docs/#installation).<br/>\nPoetry is an amazing tool for managing dependencies & virtual environments, building packages and publishing them.\n\n pipx install poetry\n\n<sub>If you encounter any problems, refer to [the official documentation](https://python-poetry.org/docs/#installation) for the most up-to-date installation instructions.</sub>\n\nBe sure to have Python 3.8 installed\u2014if you use [pyenv](https://github.com/pyenv/pyenv#readme), simply run:\n\n pyenv install 3.8\n\nThen, run:\n\n git clone https://github.com/bswck/uncover path/to/uncover\n cd path/to/uncover\n poetry env use $(cat .python-version)\n poetry install\n poetry shell\n pre-commit install --hook-type pre-commit --hook-type pre-push\n\n\n# Legal info\n\u00a9 Copyright by Bartosz S\u0142awecki ([@bswck](https://github.com/bswck)).<br />This software is licensed under the [MIT License](https://github.com/bswck/uncover/blob/main/LICENSE).\n\n\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "Uncover runtime objects. Enlighten your mind. Sleep soundly.",
"version": "0.0.0",
"project_urls": null,
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "3a81f1356320606890c78021043c5d207af44206c49f4947540f7f6cb1a06f49",
"md5": "fae91664c6287b7da98b9f0f21816a9a",
"sha256": "f1da0000050bbd9a6cee5822259dea7ec645b37de4fe4a185c829e54adfbd208"
},
"downloads": -1,
"filename": "uncover-0.0.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "fae91664c6287b7da98b9f0f21816a9a",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.8,<4.0",
"size": 3259,
"upload_time": "2023-11-25T17:23:07",
"upload_time_iso_8601": "2023-11-25T17:23:07.954992Z",
"url": "https://files.pythonhosted.org/packages/3a/81/f1356320606890c78021043c5d207af44206c49f4947540f7f6cb1a06f49/uncover-0.0.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "7d28692c76e5fe3428fb974b346fd9f53f5e8640a0810af88d408f100969d817",
"md5": "be9540a24db1504eee658718b805e708",
"sha256": "3e8a050bf7b44943c30548ff4cfe713fd05c0af00f390482dcc1f551e4a1934d"
},
"downloads": -1,
"filename": "uncover-0.0.0.tar.gz",
"has_sig": false,
"md5_digest": "be9540a24db1504eee658718b805e708",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8,<4.0",
"size": 3392,
"upload_time": "2023-11-25T17:23:08",
"upload_time_iso_8601": "2023-11-25T17:23:08.889386Z",
"url": "https://files.pythonhosted.org/packages/7d/28/692c76e5fe3428fb974b346fd9f53f5e8640a0810af88d408f100969d817/uncover-0.0.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-11-25 17:23:08",
"github": false,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"lcname": "uncover"
}
