| Name | cr-pre-commit-hooks JSON |
| Version |
0.1.1
JSON |
| download |
| home_page | |
| Summary | pre-commit hooks for ensuring consistency across our code base. Included are hooks which are not available elsewhere and also not super useful outside of a CR context. |
| upload_time | 2023-06-12 09:51:57 |
| maintainer | |
| docs_url | None |
| author | Mika Pflüger |
| requires_python | >=3.9,<4.0 |
| license | |
| keywords |
|
| VCS |
|
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# Climate Resource pre-commit hooks
<!--- sec-begin-description -->
[pre-commit](https://pre-commit.com/) hooks for ensuring consistency across our code
base. Included are hooks which are not available elsewhere and also not super useful
outside of a CR context.
<!--- sec-end-description -->
## Usage
<!--- sec-begin-usage -->
To use the hooks in a project, add to your `.pre-commit-config.yaml`:
```yaml
- repo: https://gitlab.com/climate-resource/cr-pre-commit-hooks
rev: v0.1.0
hooks:
- id: check-docstrings
```
<!--- sec-end-usage -->
## For developers
<!--- sec-begin-installation-dev -->
For development, we rely on [poetry](https://python-poetry.org) for all our
dependency management. To get started, you will need to make sure that poetry
is installed
([instructions here](https://python-poetry.org/docs/#installing-with-the-official-installer),
we found that pipx and pip worked better to install on a Mac).
For all of work, we use our `Makefile`.
You can read the instructions out and run the commands by hand if you wish,
but we generally discourage this because it can be error prone.
In order to create your environment, run `make virtual-environment`.
If there are any issues, the messages from the `Makefile` should guide you
through. If not, please raise an issue in the [issue tracker][issue_tracker].
For the rest of our developer docs, please see [](development-reference).
[issue_tracker]: https://gitlab.com/climate-resource/cr-pre-commit-hooks/issues
<!--- sec-end-installation-dev -->
Raw data
{
"_id": null,
"home_page": "",
"name": "cr-pre-commit-hooks",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.9,<4.0",
"maintainer_email": "",
"keywords": "",
"author": "Mika Pfl\u00fcger",
"author_email": "mika.pflueger@climate-resource.com",
"download_url": "https://files.pythonhosted.org/packages/24/e3/f047074af300d220a16a2449b325adf32aa431a52c5a2c16e6841ea2811d/cr_pre_commit_hooks-0.1.1.tar.gz",
"platform": null,
"description": "# Climate Resource pre-commit hooks\n\n<!--- sec-begin-description -->\n\n[pre-commit](https://pre-commit.com/) hooks for ensuring consistency across our code\nbase. Included are hooks which are not available elsewhere and also not super useful\noutside of a CR context.\n\n<!--- sec-end-description -->\n\n## Usage\n\n<!--- sec-begin-usage -->\n\nTo use the hooks in a project, add to your `.pre-commit-config.yaml`:\n```yaml\n - repo: https://gitlab.com/climate-resource/cr-pre-commit-hooks\n rev: v0.1.0\n hooks:\n - id: check-docstrings\n```\n\n<!--- sec-end-usage -->\n\n## For developers\n\n<!--- sec-begin-installation-dev -->\n\nFor development, we rely on [poetry](https://python-poetry.org) for all our\ndependency management. To get started, you will need to make sure that poetry\nis installed\n([instructions here](https://python-poetry.org/docs/#installing-with-the-official-installer),\nwe found that pipx and pip worked better to install on a Mac).\n\nFor all of work, we use our `Makefile`.\nYou can read the instructions out and run the commands by hand if you wish,\nbut we generally discourage this because it can be error prone.\nIn order to create your environment, run `make virtual-environment`.\n\nIf there are any issues, the messages from the `Makefile` should guide you\nthrough. If not, please raise an issue in the [issue tracker][issue_tracker].\n\nFor the rest of our developer docs, please see [](development-reference).\n\n[issue_tracker]: https://gitlab.com/climate-resource/cr-pre-commit-hooks/issues\n\n<!--- sec-end-installation-dev -->\n",
"bugtrack_url": null,
"license": "",
"summary": "pre-commit hooks for ensuring consistency across our code base. Included are hooks which are not available elsewhere and also not super useful outside of a CR context.",
"version": "0.1.1",
"project_urls": null,
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "8ffe9337802aa9a99fed699df97461c4263c6c1012ed05dfe64aa868fec6eb38",
"md5": "a344c763c760460c0590cf239e415155",
"sha256": "b39434dacf0d11551ef804b8587f32b4fe3398e53a482aa498dfcd09c2ce1e3d"
},
"downloads": -1,
"filename": "cr_pre_commit_hooks-0.1.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "a344c763c760460c0590cf239e415155",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.9,<4.0",
"size": 3983,
"upload_time": "2023-06-12T09:51:56",
"upload_time_iso_8601": "2023-06-12T09:51:56.557490Z",
"url": "https://files.pythonhosted.org/packages/8f/fe/9337802aa9a99fed699df97461c4263c6c1012ed05dfe64aa868fec6eb38/cr_pre_commit_hooks-0.1.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "24e3f047074af300d220a16a2449b325adf32aa431a52c5a2c16e6841ea2811d",
"md5": "ea6cb487923196b3640788b8a27e1ad2",
"sha256": "bef57ed7146d7b085e6b4f2fde88eab744e143a6d048ff29067821926bf821be"
},
"downloads": -1,
"filename": "cr_pre_commit_hooks-0.1.1.tar.gz",
"has_sig": false,
"md5_digest": "ea6cb487923196b3640788b8a27e1ad2",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.9,<4.0",
"size": 4059,
"upload_time": "2023-06-12T09:51:57",
"upload_time_iso_8601": "2023-06-12T09:51:57.758491Z",
"url": "https://files.pythonhosted.org/packages/24/e3/f047074af300d220a16a2449b325adf32aa431a52c5a2c16e6841ea2811d/cr_pre_commit_hooks-0.1.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-06-12 09:51:57",
"github": false,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"lcname": "cr-pre-commit-hooks"
}
