| Name | casefy JSON |
| Version |
0.1.7
JSON |
| download |
| home_page | |
| Summary | Utilities for string case conversion. |
| upload_time | 2022-12-27 15:40:17 |
| maintainer | |
| docs_url | None |
| author | |
| requires_python | >=3.6 |
| license | MIT License Copyright (c) 2022 Diego Miguel Lozano Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. |
| keywords |
case
case-converter
casefy
casing
|
| VCS |
|
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
<p align="center"><img width="400" src="https://github.com/dmlls/python-casefy/blob/main/docs/source/_static/images/cover.png" alt=""></p>
<p align="center" display="inline-block">
<a href="https://docs.jizt.it">
<a href="https://pypi.org/project/casefy/">
<img src="https://img.shields.io/pypi/v/casefy">
</a>
<a href="https://deepsource.io/gh/dmlls/python-casefy/?ref=repository-badge}" target="_blank">
<img alt="Active Issues" title="DeepSource" src="https://deepsource.io/gh/dmlls/python-casefy.svg/?label=active+issues&token=dbO3UyrUPWvJp6K_PVZpTcnU"/>
</a>
</a>
</p>
## Introduction
Casefy (/keɪsfaɪ/) is a lightweight Python package to convert the casing of strings. It has no third-party dependencies and supports Unicode.
<br>
## Installation
The latest release can be installed using [pip](https://pypi.org/project/casefy/):
```shell
pip install -U casefy
```
Casefy is also [available](https://aur.archlinux.org/packages/python-casefy) as an Arch Linux AUR package.
<br>
## Examples
Note: for more details, you can check the [API Reference](https://dmlls.github.io/python-casefy/api.html).
```python
import casefy
# camelCase
string = casefy.camelcase("foo_bar")
print(string) # fooBar
string = casefy.camelcase("FooBar")
print(string) # fooBar
string = casefy.camelcase("FOO BAR")
print(string) # fooBar
# PascalCase
string = casefy.pascalcase("foo_bar")
print(string) # FooBar
string = casefy.pascalcase("fooBar")
print(string) # FooBar
# snake_case
string = casefy.snakecase("fooBar")
print(string) # foo_bar
string = casefy.snakecase("fooBARbaz", keep_together=["bar"])
print(string) # foo_bar_baz
string = casefy.snakecase("FOO BAR")
print(string) # foo_bar
# CONST_CASE
string = casefy.constcase("fooBar")
print(string) # FOO_BAR
# kebab-case
string = casefy.kebabcase("fooBar")
print(string) # foo-bar
# UPPER-KEBAB-CASE
string = casefy.upperkebabcase("fooBar")
print(string) # FOO-BAR
# separator case
string = casefy.separatorcase("fooBar", separator="/")
print(string) # foo/bar
string = casefy.separatorcase("fooBARbaz", separator="%", keep_together=["bar"])
print(string) # foo%bar%baz
# Sentence case
string = casefy.sentencecase("fooBar")
print(string) # Foo bar
# Title Case
string = casefy.titlecase("fooBar")
print(string) # Foo Bar
# Alphanum3ric case (removes non-alphanumeric chars)
string = casefy.alphanumcase("foo - 123 ; bar!")
print(string) # foo123bar
```
<br>
## Contribute
If you find a bug, please open an issue. Pull Requests are also welcome!
<br>
## Acknowledgements
This project started when I saw that the package [`python-stringcase`](https://aur.archlinux.org/pkgbase/python-stringcase) was flagged-out-of-date in the Arch AUR Repository. The project [stringcase](https://github.com/okunishinishi/python-stringcase) seems not to be actively maintained anymore, so I decided to address its issues and pull requests and solve them in this new package. I kept the API as similar as possible, in order to facilitate any possible migration. I thank [Taka Okunishi](https://github.com/okunishinishi) (author of stringcase) and its contributors for their work.
<br>
## Related projects
- [`case-conversion`](https://github.com/AlejandroFrias/case-conversion) offers a very similar functionality as this project. I probably wouldn't have written this package if I had known of it before. However, the code of Casefy is more lightweight and just enough for most cases. If you need more functionality, e.g., detecting the case of a string, go with `case-conversion`.
- [Inflection](https://github.com/jpvanhal/inflection) presents some overlap with this project as well, allowing the transformation of strings from CamelCase to underscored_string, but also singularizing and pluralizing English words.
<br>
## License
Casefy is distributed under the [MIT](https://github.com/dmlls/python-casefy/blob/main/LICENSE) license.
Raw data
{
"_id": null,
"home_page": "",
"name": "casefy",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.6",
"maintainer_email": "Diego Miguel Lozano <hello@diegomiguel.me>",
"keywords": "case,case-converter,casefy,casing",
"author": "",
"author_email": "Diego Miguel Lozano <hello@diegomiguel.me>",
"download_url": "https://files.pythonhosted.org/packages/64/bd/198e4bc5dbfa8d363106fac2ca0bbd8639e1c66d7fbd2c4e3383a9cc0cb4/casefy-0.1.7.tar.gz",
"platform": null,
"description": "<p align=\"center\"><img width=\"400\" src=\"https://github.com/dmlls/python-casefy/blob/main/docs/source/_static/images/cover.png\" alt=\"\"></p>\n<p align=\"center\" display=\"inline-block\">\n <a href=\"https://docs.jizt.it\">\n <a href=\"https://pypi.org/project/casefy/\">\n <img src=\"https://img.shields.io/pypi/v/casefy\">\n </a>\n <a href=\"https://deepsource.io/gh/dmlls/python-casefy/?ref=repository-badge}\" target=\"_blank\">\n <img alt=\"Active Issues\" title=\"DeepSource\" src=\"https://deepsource.io/gh/dmlls/python-casefy.svg/?label=active+issues&token=dbO3UyrUPWvJp6K_PVZpTcnU\"/>\n </a>\n </a>\n</p>\n\n## Introduction\n\nCasefy (/ke\u026asfa\u026a/) is a lightweight Python package to convert the casing of strings. It has no third-party dependencies and supports Unicode.\n\n<br>\n\n## Installation\n\nThe latest release can be installed using [pip](https://pypi.org/project/casefy/):\n```shell\npip install -U casefy\n```\n\nCasefy is also [available](https://aur.archlinux.org/packages/python-casefy) as an Arch Linux AUR package.\n\n<br>\n\n## Examples\n\nNote: for more details, you can check the [API Reference](https://dmlls.github.io/python-casefy/api.html).\n\n```python\nimport casefy\n\n# camelCase\nstring = casefy.camelcase(\"foo_bar\")\nprint(string) # fooBar\n\nstring = casefy.camelcase(\"FooBar\")\nprint(string) # fooBar\n\nstring = casefy.camelcase(\"FOO BAR\")\nprint(string) # fooBar\n\n\n# PascalCase\nstring = casefy.pascalcase(\"foo_bar\")\nprint(string) # FooBar\n\nstring = casefy.pascalcase(\"fooBar\")\nprint(string) # FooBar\n\n\n# snake_case\nstring = casefy.snakecase(\"fooBar\")\nprint(string) # foo_bar\n\nstring = casefy.snakecase(\"fooBARbaz\", keep_together=[\"bar\"])\nprint(string) # foo_bar_baz\n\nstring = casefy.snakecase(\"FOO BAR\")\nprint(string) # foo_bar\n\n\n# CONST_CASE\nstring = casefy.constcase(\"fooBar\")\nprint(string) # FOO_BAR\n\n\n# kebab-case\nstring = casefy.kebabcase(\"fooBar\")\nprint(string) # foo-bar\n\n\n# UPPER-KEBAB-CASE\nstring = casefy.upperkebabcase(\"fooBar\")\nprint(string) # FOO-BAR\n\n\n# separator case\nstring = casefy.separatorcase(\"fooBar\", separator=\"/\")\nprint(string) # foo/bar\n\nstring = casefy.separatorcase(\"fooBARbaz\", separator=\"%\", keep_together=[\"bar\"])\nprint(string) # foo%bar%baz\n\n\n# Sentence case\nstring = casefy.sentencecase(\"fooBar\")\nprint(string) # Foo bar\n\n\n# Title Case\nstring = casefy.titlecase(\"fooBar\")\nprint(string) # Foo Bar\n\n\n# Alphanum3ric case (removes non-alphanumeric chars)\nstring = casefy.alphanumcase(\"foo - 123 ; bar!\")\nprint(string) # foo123bar\n```\n\n<br>\n\n## Contribute\nIf you find a bug, please open an issue. Pull Requests are also welcome!\n\n<br>\n\n## Acknowledgements\n\nThis project started when I saw that the package [`python-stringcase`](https://aur.archlinux.org/pkgbase/python-stringcase) was flagged-out-of-date in the Arch AUR Repository. The project [stringcase](https://github.com/okunishinishi/python-stringcase) seems not to be actively maintained anymore, so I decided to address its issues and pull requests and solve them in this new package. I kept the API as similar as possible, in order to facilitate any possible migration. I thank [Taka Okunishi](https://github.com/okunishinishi) (author of stringcase) and its contributors for their work.\n\n<br>\n\n## Related projects\n\n- [`case-conversion`](https://github.com/AlejandroFrias/case-conversion) offers a very similar functionality as this project. I probably wouldn't have written this package if I had known of it before. However, the code of Casefy is more lightweight and just enough for most cases. If you need more functionality, e.g., detecting the case of a string, go with `case-conversion`.\n\n- [Inflection](https://github.com/jpvanhal/inflection) presents some overlap with this project as well, allowing the transformation of strings from CamelCase to underscored_string, but also singularizing and pluralizing English words.\n\n<br>\n\n## License\nCasefy is distributed under the [MIT](https://github.com/dmlls/python-casefy/blob/main/LICENSE) license.\n",
"bugtrack_url": null,
"license": "MIT License Copyright (c) 2022 Diego Miguel Lozano Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the \"Software\"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.",
"summary": "Utilities for string case conversion.",
"version": "0.1.7",
"split_keywords": [
"case",
"case-converter",
"casefy",
"casing"
],
"urls": [
{
"comment_text": "",
"digests": {
"md5": "e5b66548cb8bd86030b39f922494216c",
"sha256": "ab05ff1c67f2a8e62d9f8986fa9a849416d61ac5413ec57d1f827b4f36589cf6"
},
"downloads": -1,
"filename": "casefy-0.1.7-py3-none-any.whl",
"has_sig": false,
"md5_digest": "e5b66548cb8bd86030b39f922494216c",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.6",
"size": 6180,
"upload_time": "2022-12-27T15:40:15",
"upload_time_iso_8601": "2022-12-27T15:40:15.158136Z",
"url": "https://files.pythonhosted.org/packages/aa/09/24eff895c2b59e7bd2d6aa1cc2e7955137844ec4f9f06e2770a1399755a3/casefy-0.1.7-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"md5": "47b6bbcf29d0b55b3945c2a2a22a192a",
"sha256": "6accce985a64b9edb2a610a29ac489d78fac80e52ff8f2d137e294f2f92b8027"
},
"downloads": -1,
"filename": "casefy-0.1.7.tar.gz",
"has_sig": false,
"md5_digest": "47b6bbcf29d0b55b3945c2a2a22a192a",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.6",
"size": 123300,
"upload_time": "2022-12-27T15:40:17",
"upload_time_iso_8601": "2022-12-27T15:40:17.387465Z",
"url": "https://files.pythonhosted.org/packages/64/bd/198e4bc5dbfa8d363106fac2ca0bbd8639e1c66d7fbd2c4e3383a9cc0cb4/casefy-0.1.7.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2022-12-27 15:40:17",
"github": false,
"gitlab": false,
"bitbucket": false,
"lcname": "casefy"
}
