# Simple CSS Selector Transforms
<div align="center">
[](https://github.com/StreamHPC/simple-css-selector-transform/actions?query=workflow%3Abuild)
[](https://pypi.org/project/simple-css-selector-transform/)
[](https://github.com/StreamHPC/simple-css-selector-transform/pulls?utf8=%E2%9C%93&q=is%3Apr%20author%3Aapp%2Fdependabot)
[](https://github.com/psf/black)
[](https://github.com/PyCQA/bandit)
[](https://github.com/StreamHPC/simple-css-selector-transform/blob/main/.pre-commit-config.yaml)
[](https://github.com/StreamHPC/simple-css-selector-transform/releases)
[](https://github.com/StreamHPC/simple-css-selector-transform/blob/main/LICENSE)
Simple transformations for CSS Selectors
</div>
## Description
A library for simple transformations on CSS selectors, developed to be used in [doxysphinx](https://github.com/boschglobal/doxysphinx).
## Installation
```bash
pip install -U simple-css-selector-transform
```
or install with `Poetry`
```bash
poetry add simple-css-selector-transform
```
### Makefile usage
[`Makefile`](https://github.com/StreamHPC/simple-css-selector-transform/blob/main/Makefile) contains a lot of functions for faster development.
<details>
<summary>1. Download and remove Poetry</summary>
<p>
To download and install Poetry run:
```bash
make poetry-download
```
To uninstall
```bash
make poetry-remove
```
</p>
</details>
<details>
<summary>2. Install all dependencies and pre-commit hooks</summary>
<p>
Install requirements:
```bash
make install
```
Pre-commit hooks coulb be installed after `git init` via
```bash
make pre-commit-install
```
</p>
</details>
<details>
<summary>3. Codestyle</summary>
<p>
Automatic formatting uses `pyupgrade`, `isort` and `black`.
```bash
make codestyle
# or use synonym
make formatting
```
Codestyle checks only, without rewriting files:
```bash
make check-codestyle
```
> Note: `check-codestyle` uses `isort`, `black` and `darglint` library
Update all dev libraries to the latest version using one comand
```bash
make update-dev-deps
```
<details>
<summary>4. Code security</summary>
<p>
```bash
make check-safety
```
This command launches `Poetry` integrity checks as well as identifies security issues with `Safety` and `Bandit`.
```bash
make check-safety
```
</p>
</details>
</p>
</details>
<details>
<summary>5. Type checks</summary>
<p>
Run `mypy` static type checker
```bash
make mypy
```
</p>
</details>
<details>
<summary>6. Tests with coverage badges</summary>
<p>
Run `pytest`
```bash
make test
```
</p>
</details>
<details>
<summary>7. All linters</summary>
<p>
Of course there is a command to ~~rule~~ run all linters in one:
```bash
make lint
```
the same as:
```bash
make test && make check-codestyle && make mypy && make check-safety
```
</p>
</details>
<details>
<summary>8. Docker</summary>
<p>
```bash
make docker-build
```
which is equivalent to:
```bash
make docker-build VERSION=latest
```
Remove docker image with
```bash
make docker-remove
```
More information [about docker](https://github.com/StreamHPC/simple-css-selector-transform/tree/main/docker).
</p>
</details>
<details>
<summary>9. Cleanup</summary>
<p>
Delete pycache files
```bash
make pycache-remove
```
Remove package build
```bash
make build-remove
```
Delete .DS_STORE files
```bash
make dsstore-remove
```
Remove .mypycache
```bash
make mypycache-remove
```
Or to remove all above run:
```bash
make cleanup
```
</p>
</details>
## 📈 Releases
You can see the list of available releases on the [GitHub Releases](https://github.com/StreamHPC/simple-css-selector-transform/releases) page.
We follow [Semantic Versions](https://semver.org/) specification.
We use [`Release Drafter`](https://github.com/marketplace/actions/release-drafter). As pull requests are merged, a draft release is kept up-to-date listing the changes, ready to publish when you’re ready. With the categories option, you can categorize pull requests in release notes using labels.
### List of labels and corresponding titles
| **Label** | **Title in Releases** |
| :-----------------------------------: | :---------------------: |
| `enhancement`, `feature` | 🚀 Features |
| `bug`, `refactoring`, `bugfix`, `fix` | 🔧 Fixes & Refactoring |
| `build`, `ci`, `testing` | 📦 Build System & CI/CD |
| `breaking` | 💥 Breaking Changes |
| `documentation` | 📝 Documentation |
| `dependencies` | ⬆️ Dependencies updates |
## 🛡 License
[](https://github.com/StreamHPC/simple-css-selector-transform/blob/main/LICENSE)
This project is licensed under the terms of the `MIT` license. See [LICENSE](https://github.com/StreamHPC/simple-css-selector-transform/blob/main/LICENSE) for more details.
## 📃 Citation
```bibtex
@misc{simple-css-selector-transform,
author = {Stream HPC B.V.},
title = {Simple transformations for CSS Selectors},
year = {2023},
publisher = {GitHub},
journal = {GitHub repository},
howpublished = {\url{https://github.com/StreamHPC/simple-css-selector-transform}}
}
```
## Credits [](https://github.com/TezRomacH/python-package-template)
This project was generated with [`python-package-template`](https://github.com/TezRomacH/python-package-template)
Raw data
{
"_id": null,
"home_page": "https://github.com/StreamHPC/simple-css-selector-transform",
"name": "simple-css-selector-transform",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.8,<4.0",
"maintainer_email": "",
"keywords": "python,css,transform,rewrite,doxysphinx,doxygen,sphinx",
"author": "Stream HPC B.V.",
"author_email": "gergely@streamhpc.com",
"download_url": "https://files.pythonhosted.org/packages/ec/a2/67d853ba9bcc3bd9533fdd5481a0e96ea1ad93016270068853fe95b07597/simple_css_selector_transform-0.1.0.tar.gz",
"platform": null,
"description": "# Simple CSS Selector Transforms\n\n<div align=\"center\">\n\n[](https://github.com/StreamHPC/simple-css-selector-transform/actions?query=workflow%3Abuild)\n[](https://pypi.org/project/simple-css-selector-transform/)\n[](https://github.com/StreamHPC/simple-css-selector-transform/pulls?utf8=%E2%9C%93&q=is%3Apr%20author%3Aapp%2Fdependabot)\n\n[](https://github.com/psf/black)\n[](https://github.com/PyCQA/bandit)\n[](https://github.com/StreamHPC/simple-css-selector-transform/blob/main/.pre-commit-config.yaml)\n[](https://github.com/StreamHPC/simple-css-selector-transform/releases)\n[](https://github.com/StreamHPC/simple-css-selector-transform/blob/main/LICENSE)\n\n\nSimple transformations for CSS Selectors\n\n</div>\n\n## Description\n\nA library for simple transformations on CSS selectors, developed to be used in [doxysphinx](https://github.com/boschglobal/doxysphinx).\n\n## Installation\n\n```bash\npip install -U simple-css-selector-transform\n```\n\nor install with `Poetry`\n\n```bash\npoetry add simple-css-selector-transform\n```\n\n\n\n### Makefile usage\n\n[`Makefile`](https://github.com/StreamHPC/simple-css-selector-transform/blob/main/Makefile) contains a lot of functions for faster development.\n\n<details>\n<summary>1. Download and remove Poetry</summary>\n<p>\n\nTo download and install Poetry run:\n\n```bash\nmake poetry-download\n```\n\nTo uninstall\n\n```bash\nmake poetry-remove\n```\n\n</p>\n</details>\n\n<details>\n<summary>2. Install all dependencies and pre-commit hooks</summary>\n<p>\n\nInstall requirements:\n\n```bash\nmake install\n```\n\nPre-commit hooks coulb be installed after `git init` via\n\n```bash\nmake pre-commit-install\n```\n\n</p>\n</details>\n\n<details>\n<summary>3. Codestyle</summary>\n<p>\n\nAutomatic formatting uses `pyupgrade`, `isort` and `black`.\n\n```bash\nmake codestyle\n\n# or use synonym\nmake formatting\n```\n\nCodestyle checks only, without rewriting files:\n\n```bash\nmake check-codestyle\n```\n\n> Note: `check-codestyle` uses `isort`, `black` and `darglint` library\n\nUpdate all dev libraries to the latest version using one comand\n\n```bash\nmake update-dev-deps\n```\n\n<details>\n<summary>4. Code security</summary>\n<p>\n\n```bash\nmake check-safety\n```\n\nThis command launches `Poetry` integrity checks as well as identifies security issues with `Safety` and `Bandit`.\n\n```bash\nmake check-safety\n```\n\n</p>\n</details>\n\n</p>\n</details>\n\n<details>\n<summary>5. Type checks</summary>\n<p>\n\nRun `mypy` static type checker\n\n```bash\nmake mypy\n```\n\n</p>\n</details>\n\n<details>\n<summary>6. Tests with coverage badges</summary>\n<p>\n\nRun `pytest`\n\n```bash\nmake test\n```\n\n</p>\n</details>\n\n<details>\n<summary>7. All linters</summary>\n<p>\n\nOf course there is a command to ~~rule~~ run all linters in one:\n\n```bash\nmake lint\n```\n\nthe same as:\n\n```bash\nmake test && make check-codestyle && make mypy && make check-safety\n```\n\n</p>\n</details>\n\n<details>\n<summary>8. Docker</summary>\n<p>\n\n```bash\nmake docker-build\n```\n\nwhich is equivalent to:\n\n```bash\nmake docker-build VERSION=latest\n```\n\nRemove docker image with\n\n```bash\nmake docker-remove\n```\n\nMore information [about docker](https://github.com/StreamHPC/simple-css-selector-transform/tree/main/docker).\n\n</p>\n</details>\n\n<details>\n<summary>9. Cleanup</summary>\n<p>\nDelete pycache files\n\n```bash\nmake pycache-remove\n```\n\nRemove package build\n\n```bash\nmake build-remove\n```\n\nDelete .DS_STORE files\n\n```bash\nmake dsstore-remove\n```\n\nRemove .mypycache\n\n```bash\nmake mypycache-remove\n```\n\nOr to remove all above run:\n\n```bash\nmake cleanup\n```\n\n</p>\n</details>\n\n## \ud83d\udcc8 Releases\n\nYou can see the list of available releases on the [GitHub Releases](https://github.com/StreamHPC/simple-css-selector-transform/releases) page.\n\nWe follow [Semantic Versions](https://semver.org/) specification.\n\nWe use [`Release Drafter`](https://github.com/marketplace/actions/release-drafter). As pull requests are merged, a draft release is kept up-to-date listing the changes, ready to publish when you\u2019re ready. With the categories option, you can categorize pull requests in release notes using labels.\n\n### List of labels and corresponding titles\n\n| **Label** | **Title in Releases** |\n| :-----------------------------------: | :---------------------: |\n| `enhancement`, `feature` | \ud83d\ude80 Features |\n| `bug`, `refactoring`, `bugfix`, `fix` | \ud83d\udd27 Fixes & Refactoring |\n| `build`, `ci`, `testing` | \ud83d\udce6 Build System & CI/CD |\n| `breaking` | \ud83d\udca5 Breaking Changes |\n| `documentation` | \ud83d\udcdd Documentation |\n| `dependencies` | \u2b06\ufe0f Dependencies updates |\n\n\n## \ud83d\udee1 License\n\n[](https://github.com/StreamHPC/simple-css-selector-transform/blob/main/LICENSE)\n\nThis project is licensed under the terms of the `MIT` license. See [LICENSE](https://github.com/StreamHPC/simple-css-selector-transform/blob/main/LICENSE) for more details.\n\n## \ud83d\udcc3 Citation\n\n```bibtex\n@misc{simple-css-selector-transform,\n author = {Stream HPC B.V.},\n title = {Simple transformations for CSS Selectors},\n year = {2023},\n publisher = {GitHub},\n journal = {GitHub repository},\n howpublished = {\\url{https://github.com/StreamHPC/simple-css-selector-transform}}\n}\n```\n\n## Credits [](https://github.com/TezRomacH/python-package-template)\n\nThis project was generated with [`python-package-template`](https://github.com/TezRomacH/python-package-template)\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "Simple transformations for CSS Selectors",
"version": "0.1.0",
"split_keywords": [
"python",
"css",
"transform",
"rewrite",
"doxysphinx",
"doxygen",
"sphinx"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "df70e39a382634392752a435220e1629de074b8fd871cc1c99afdf6354ea1bba",
"md5": "d3c70860041718c8105604e45289b7d3",
"sha256": "958d0374aaafeddb863aa0e9981acfd1466e4826c24001aaa248b56e5d3f8a16"
},
"downloads": -1,
"filename": "simple_css_selector_transform-0.1.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "d3c70860041718c8105604e45289b7d3",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.8,<4.0",
"size": 8168,
"upload_time": "2023-03-22T17:18:00",
"upload_time_iso_8601": "2023-03-22T17:18:00.000425Z",
"url": "https://files.pythonhosted.org/packages/df/70/e39a382634392752a435220e1629de074b8fd871cc1c99afdf6354ea1bba/simple_css_selector_transform-0.1.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "eca267d853ba9bcc3bd9533fdd5481a0e96ea1ad93016270068853fe95b07597",
"md5": "28551fc017e4924d9e22a9ed78afedd5",
"sha256": "a6f36096db8cdf6067df5729dce3ef2d5de1e28f4e71031e5e8806dafc814629"
},
"downloads": -1,
"filename": "simple_css_selector_transform-0.1.0.tar.gz",
"has_sig": false,
"md5_digest": "28551fc017e4924d9e22a9ed78afedd5",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8,<4.0",
"size": 7520,
"upload_time": "2023-03-22T17:18:01",
"upload_time_iso_8601": "2023-03-22T17:18:01.478066Z",
"url": "https://files.pythonhosted.org/packages/ec/a2/67d853ba9bcc3bd9533fdd5481a0e96ea1ad93016270068853fe95b07597/simple_css_selector_transform-0.1.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-03-22 17:18:01",
"github": true,
"gitlab": false,
"bitbucket": false,
"github_user": "StreamHPC",
"github_project": "simple-css-selector-transform",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"requirements": [],
"lcname": "simple-css-selector-transform"
}
JSON
