<div align="center">
<h1>pylity</h1>
<br />
<a href="#getting-started"><strong>Getting Started »</strong></a>
<br />
<br />
<a href="https://github.com/Payadel/pylity/issues/new?assignees=&labels=bug&template=BUG_REPORT.md&title=bug%3A+">Report a Bug</a>
·
<a href="https://github.com/Payadel/pylity/issues/new?assignees=&labels=enhancement&template=FEATURE_REQUEST.md&title=feat%3A+">Request a Feature</a>
.
<a href="https://github.com/Payadel/pylity/issues/new?assignees=&labels=question&template=SUPPORT_QUESTION.md&title=support%3A+">Ask a Question</a>
</div>
<div align="center">
<br />
[](https://github.com/Payadel)
[](https://github.com/Payadel/pylity/actions/workflows/build.yaml?query=branch%3Adev)
[](coverage.md)
[](https://pypi.org/project/pylity/)
[](https://github.com/Payadel/pylity/issues?q=is%3Aissue+is%3Aopen+label%3A%22help+wanted%22)
</div>
## About
The `pylity` package is a set of utility and common functions for Python.
**pylity** means `Python Utility`.
When we work on different projects, there are usually functions that are **common** between the projects. Functions that we generally call Utility or helpers or something like that. Functions that are **independent** and can be used in different places.
Well, instead of copying and pasting these functions in a new project every time, it is better to have a package that gathers all these together so that we can install and use them **easily**. This is the goal of this project. :)
## Getting Started
### Installation
Use pip to install package:
```shell
pip install pylity --upgrade
```
## Usage
### Prerequisites
Please note that this package uses [on_rails](https://github.com/payadel/on_rails) package for most functions. `on_rails` is an easy and valuable package for better **error management**. If you are not familiar with this package, you should read its documentation.
### Sample
A set of different functions are grouped into related **classes**.
Import any class you want, then use the functions.
For example:
```python
from pylity import Function
Function.is_func_valid(lambda: None) # returns True
Function.get_num_of_params(lambda a, b, c: None) \
.on_success(lambda num_of_params: print(f"Number of parameters is: {num_of_params}")) \
.on_fail(lambda result: print(f"An error occurred:\n{result}"))
```
## CHANGELOG
Please see the [CHANGELOG](https://github.com/Payadel/pylity/blob/main/CHANGELOG.md) file.
## Roadmap
See the [open issues](https://github.com/Payadel/pylity/issues) for a list of proposed features (and known
issues).
- [Top Feature Requests](https://github.com/Payadel/pylity/issues?q=label%3Aenhancement+is%3Aopen+sort%3Areactions-%2B1-desc) (
Add your votes using the 👍 reaction)
- [Top Bugs](https://github.com/Payadel/pylity/issues?q=is%3Aissue+is%3Aopen+label%3Abug+sort%3Areactions-%2B1-desc) (
Add your votes using the 👍 reaction)
- [Newest Bugs](https://github.com/Payadel/pylity/issues?q=is%3Aopen+is%3Aissue+label%3Abug)
## Support
Reach out to the maintainer at one of the following places:
- [GitHub issues](https://github.com/Payadel/pylity/issues/new?assignees=&labels=question&template=SUPPORT_QUESTION.md&title=support%3A+)
## Project assistance
If you want to say **thank you** or/and support active development of pylity:
- Add a [GitHub Star](https://github.com/Payadel/pylity) to the project.
- Tweet about the pylity.
- Write interesting articles about the project on [Dev.to](https://dev.to/), [Medium](https://medium.com/) or your
personal blog.
Together, we can make pylity **better**!
## Contributing
First off, thanks for taking the time to contribute! Contributions are what make the free/open-source community such an
amazing place to learn, inspire, and create. Any contributions you make will benefit everybody else and are **greatly
appreciated**.
Please read [our contribution guidelines](docs/CONTRIBUTING.md), and thank you for being involved!
## Authors & contributors
The original setup of this repository is by [Payadel](https://github.com/Payadel).
For a full list of all authors and contributors,
see [the contributors page](https://github.com/Payadel/pylity/contributors).
## Security
`pylity` follows good practices of security, but 100% security cannot be assured. `pylity` is provided **"as
is"** without any **warranty**.
_For more information and to report security issues, please refer to our [security documentation](docs/SECURITY.md)._
## License
This project is licensed under the **GPLv3**.
See [LICENSE](LICENSE) for more information.
Raw data
{
"_id": null,
"home_page": "https://github.com/Payadel/pylity",
"name": "pylity",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.8,<4.0",
"maintainer_email": "",
"keywords": "utility,helpers",
"author": "Payadel",
"author_email": "payadelteam@gmail.com",
"download_url": "https://files.pythonhosted.org/packages/19/22/ec2c390618fa705d4912d78b44e3476019ad6178ba97eaf94988d6bd17c5/pylity-0.0.10.tar.gz",
"platform": null,
"description": "<div align=\"center\">\n <h1>pylity</h1>\n <br />\n <a href=\"#getting-started\"><strong>Getting Started \u00bb</strong></a>\n <br />\n <br />\n <a href=\"https://github.com/Payadel/pylity/issues/new?assignees=&labels=bug&template=BUG_REPORT.md&title=bug%3A+\">Report a Bug</a>\n \u00b7\n <a href=\"https://github.com/Payadel/pylity/issues/new?assignees=&labels=enhancement&template=FEATURE_REQUEST.md&title=feat%3A+\">Request a Feature</a>\n .\n <a href=\"https://github.com/Payadel/pylity/issues/new?assignees=&labels=question&template=SUPPORT_QUESTION.md&title=support%3A+\">Ask a Question</a>\n</div>\n\n<div align=\"center\">\n<br />\n\n[](https://github.com/Payadel)\n\n[](https://github.com/Payadel/pylity/actions/workflows/build.yaml?query=branch%3Adev)\n[](coverage.md)\n[](https://pypi.org/project/pylity/)\n\n\n[](https://github.com/Payadel/pylity/issues?q=is%3Aissue+is%3Aopen+label%3A%22help+wanted%22)\n\n</div>\n\n\n## About\n\nThe `pylity` package is a set of utility and common functions for Python.\n**pylity** means `Python Utility`.\n\nWhen we work on different projects, there are usually functions that are **common** between the projects. Functions that we generally call Utility or helpers or something like that. Functions that are **independent** and can be used in different places.\n\nWell, instead of copying and pasting these functions in a new project every time, it is better to have a package that gathers all these together so that we can install and use them **easily**. This is the goal of this project. :)\n\n\n## Getting Started\n\n### Installation\n\nUse pip to install package:\n\n```shell\npip install pylity --upgrade\n```\n\n## Usage\n\n### Prerequisites\n\nPlease note that this package uses [on_rails](https://github.com/payadel/on_rails) package for most functions. `on_rails` is an easy and valuable package for better **error management**. If you are not familiar with this package, you should read its documentation.\n\n### Sample\n\nA set of different functions are grouped into related **classes**.\nImport any class you want, then use the functions.\nFor example:\n\n```python\nfrom pylity import Function\n\nFunction.is_func_valid(lambda: None) # returns True\n\nFunction.get_num_of_params(lambda a, b, c: None) \\\n .on_success(lambda num_of_params: print(f\"Number of parameters is: {num_of_params}\")) \\\n .on_fail(lambda result: print(f\"An error occurred:\\n{result}\"))\n```\n\n## CHANGELOG\n\nPlease see the [CHANGELOG](https://github.com/Payadel/pylity/blob/main/CHANGELOG.md) file.\n\n## Roadmap\n\nSee the [open issues](https://github.com/Payadel/pylity/issues) for a list of proposed features (and known\nissues).\n\n- [Top Feature Requests](https://github.com/Payadel/pylity/issues?q=label%3Aenhancement+is%3Aopen+sort%3Areactions-%2B1-desc) (\n Add your votes using the \ud83d\udc4d reaction)\n- [Top Bugs](https://github.com/Payadel/pylity/issues?q=is%3Aissue+is%3Aopen+label%3Abug+sort%3Areactions-%2B1-desc) (\n Add your votes using the \ud83d\udc4d reaction)\n- [Newest Bugs](https://github.com/Payadel/pylity/issues?q=is%3Aopen+is%3Aissue+label%3Abug)\n\n## Support\n\nReach out to the maintainer at one of the following places:\n\n- [GitHub issues](https://github.com/Payadel/pylity/issues/new?assignees=&labels=question&template=SUPPORT_QUESTION.md&title=support%3A+)\n\n## Project assistance\n\nIf you want to say **thank you** or/and support active development of pylity:\n\n- Add a [GitHub Star](https://github.com/Payadel/pylity) to the project.\n- Tweet about the pylity.\n- Write interesting articles about the project on [Dev.to](https://dev.to/), [Medium](https://medium.com/) or your\n personal blog.\n\nTogether, we can make pylity **better**!\n\n## Contributing\n\nFirst off, thanks for taking the time to contribute! Contributions are what make the free/open-source community such an\namazing place to learn, inspire, and create. Any contributions you make will benefit everybody else and are **greatly\nappreciated**.\n\nPlease read [our contribution guidelines](docs/CONTRIBUTING.md), and thank you for being involved!\n\n## Authors & contributors\n\nThe original setup of this repository is by [Payadel](https://github.com/Payadel).\n\nFor a full list of all authors and contributors,\nsee [the contributors page](https://github.com/Payadel/pylity/contributors).\n\n## Security\n\n`pylity` follows good practices of security, but 100% security cannot be assured. `pylity` is provided **\"as\nis\"** without any **warranty**.\n\n_For more information and to report security issues, please refer to our [security documentation](docs/SECURITY.md)._\n\n## License\n\nThis project is licensed under the **GPLv3**.\n\nSee [LICENSE](LICENSE) for more information.\n",
"bugtrack_url": null,
"license": "GPLV3",
"summary": "A collection of utility functions for Python. pylity means Python Utility ",
"version": "0.0.10",
"split_keywords": [
"utility",
"helpers"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "06061b857458c85ad8bcc9493537ca874b8c45acc2d4faec9f17dbf5713f4802",
"md5": "63b9d7520153cbfd004e6fc12f0ef13d",
"sha256": "7bd347cc1ccba098ff204281b649ca5d428d06238d9bc740cd0fa2c3f4a5ca57"
},
"downloads": -1,
"filename": "pylity-0.0.10-py3-none-any.whl",
"has_sig": false,
"md5_digest": "63b9d7520153cbfd004e6fc12f0ef13d",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.8,<4.0",
"size": 21862,
"upload_time": "2023-04-19T07:19:03",
"upload_time_iso_8601": "2023-04-19T07:19:03.041879Z",
"url": "https://files.pythonhosted.org/packages/06/06/1b857458c85ad8bcc9493537ca874b8c45acc2d4faec9f17dbf5713f4802/pylity-0.0.10-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "1922ec2c390618fa705d4912d78b44e3476019ad6178ba97eaf94988d6bd17c5",
"md5": "438210fe094129430a93ea7cf945e95d",
"sha256": "690bc136d85293cfed274f3726fb665bbbebbd6ffef6ec90cf83b0acca2a78c6"
},
"downloads": -1,
"filename": "pylity-0.0.10.tar.gz",
"has_sig": false,
"md5_digest": "438210fe094129430a93ea7cf945e95d",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8,<4.0",
"size": 21478,
"upload_time": "2023-04-19T07:19:04",
"upload_time_iso_8601": "2023-04-19T07:19:04.597564Z",
"url": "https://files.pythonhosted.org/packages/19/22/ec2c390618fa705d4912d78b44e3476019ad6178ba97eaf94988d6bd17c5/pylity-0.0.10.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-04-19 07:19:04",
"github": true,
"gitlab": false,
"bitbucket": false,
"github_user": "Payadel",
"github_project": "pylity",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"requirements": [],
"tox": true,
"lcname": "pylity"
}
JSON
