| Name | copydocs JSON |
| Version |
0.0.0
JSON |
| download |
| home_page | |
| Summary | DRY: Reuse your docstrings. |
| upload_time | 2023-11-25 17:14:52 |
| 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.
|
# copydocs [](https://pypi.org/project/copydocs) [](https://pypi.org/project/copydocs)
[](https://github.com/bswck/copydocs/actions/workflows/test.yml)
[](https://coverage-badge.samuelcolvin.workers.dev/redirect/bswck/copydocs)
[](https://github.com/astral-sh/ruff)
[](https://github.com/psf/black)
[](https://github.com/bswck/copydocs/blob/HEAD/LICENSE)
[](https://github.com/pre-commit/pre-commit)
DRY: Reuse your docstrings.
# Installation
If you want to…
## …use this tool in your project 💻
You might simply install it with pip:
pip install copydocs
If you use [Poetry](https://python-poetry.org/), then run:
poetry add copydocs
## …contribute to [copydocs](https://github.com/bswck/copydocs) 🚀
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/copydocs path/to/copydocs
cd path/to/copydocs
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/copydocs/blob/main/LICENSE).
Raw data
{
"_id": null,
"home_page": "",
"name": "copydocs",
"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/a5/3a/7610c1e04a535d86ca78c19141faa6e0a562f27363078297b671313ce964/copydocs-0.0.0.tar.gz",
"platform": null,
"description": "# copydocs [](https://pypi.org/project/copydocs) [](https://pypi.org/project/copydocs)\n[](https://github.com/bswck/copydocs/actions/workflows/test.yml)\n[](https://coverage-badge.samuelcolvin.workers.dev/redirect/bswck/copydocs)\n[](https://github.com/astral-sh/ruff)\n[](https://github.com/psf/black)\n[](https://github.com/bswck/copydocs/blob/HEAD/LICENSE)\n[](https://github.com/pre-commit/pre-commit)\n\nDRY: Reuse your docstrings.\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 copydocs\n\nIf you use [Poetry](https://python-poetry.org/), then run:\n\n poetry add copydocs\n\n## \u2026contribute to [copydocs](https://github.com/bswck/copydocs) \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/copydocs path/to/copydocs\n cd path/to/copydocs\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/copydocs/blob/main/LICENSE).\n\n\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "DRY: Reuse your docstrings.",
"version": "0.0.0",
"project_urls": null,
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "d982d7476e7ffbe0ed5226a8a77df01ba12ee643f31bf36d3113207fbcfea3d8",
"md5": "e9f9b650fe76611225c4e61deec19322",
"sha256": "e74d95e976e137bcb1357b79799e447425ab09c0c9f907fc5dff1444c9f08772"
},
"downloads": -1,
"filename": "copydocs-0.0.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "e9f9b650fe76611225c4e61deec19322",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.8,<4.0",
"size": 3223,
"upload_time": "2023-11-25T17:14:51",
"upload_time_iso_8601": "2023-11-25T17:14:51.394332Z",
"url": "https://files.pythonhosted.org/packages/d9/82/d7476e7ffbe0ed5226a8a77df01ba12ee643f31bf36d3113207fbcfea3d8/copydocs-0.0.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "a53a7610c1e04a535d86ca78c19141faa6e0a562f27363078297b671313ce964",
"md5": "e2c460390ba2a42984c9db723f6414f0",
"sha256": "5bf1c07c51cad593cc49dceb75630b2a2ba3cb460be13ec0847315f1b0a41f1a"
},
"downloads": -1,
"filename": "copydocs-0.0.0.tar.gz",
"has_sig": false,
"md5_digest": "e2c460390ba2a42984c9db723f6414f0",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8,<4.0",
"size": 3384,
"upload_time": "2023-11-25T17:14:52",
"upload_time_iso_8601": "2023-11-25T17:14:52.250159Z",
"url": "https://files.pythonhosted.org/packages/a5/3a/7610c1e04a535d86ca78c19141faa6e0a562f27363078297b671313ce964/copydocs-0.0.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-11-25 17:14:52",
"github": false,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"lcname": "copydocs"
}
