[](https://pypi.org/project/subgroups/) [](https://pypi.org/project/subgroups/) [](https://pypi.org/project/subgroups/) 
[](https://github.com/antoniolopezmc/subgroups)
# subgroups
**subgroups** is a Python library that provides a collection of subgroup discovery algorithms and other data analysis utilities.
## Installation
The source code is currently hosted on: https://github.com/antoniolopezmc/subgroups
To install the 'subgroups' library from pip, it is necessary to execute:
```sh
pip install subgroups
```
## Testing
After installing the library, a collection of tests can be launched by executing:
```python
import subgroups.tests as st
st.run_all_tests()
```
## Documentation
The official documentation is hosted on https://antoniolopezmc.github.io/subgroups-docs/
## Manually generating the documentation
To manually generate the library documentation, it is necessary to execute:
```sh
# 1. Clone the repository.
git clone https://github.com/antoniolopezmc/subgroups.git
# 2. Go to the 'docs' subfolder.
cd subgroups/docs
# 3. Generate the documentation.
make build
```
The generated documentation will be located in the *build* subfolder.
Raw data
{
"_id": null,
"home_page": "https://github.com/antoniolopezmc/subgroups",
"name": "subgroups",
"maintainer": "Antonio L\u00f3pez Mart\u00ednez-Carrasco",
"docs_url": null,
"requires_python": ">=3.9.0",
"maintainer_email": "antoniolopezmc1995@gmail.com",
"keywords": "python,data-science,machine-learning,data-analysis,subgroups,subgroup-discovery",
"author": "Antonio L\u00f3pez Mart\u00ednez-Carrasco",
"author_email": "antoniolopezmc1995@gmail.com",
"download_url": "",
"platform": "any",
"description": "[](https://pypi.org/project/subgroups/) [](https://pypi.org/project/subgroups/) [](https://pypi.org/project/subgroups/) \r\n [](https://github.com/antoniolopezmc/subgroups)\r\n\r\n# subgroups\r\n\r\n**subgroups** is a Python library that provides a collection of subgroup discovery algorithms and other data analysis utilities.\r\n\r\n## Installation\r\n\r\nThe source code is currently hosted on: https://github.com/antoniolopezmc/subgroups\r\n\r\nTo install the 'subgroups' library from pip, it is necessary to execute:\r\n\r\n```sh\r\npip install subgroups\r\n```\r\n\r\n## Testing\r\n\r\nAfter installing the library, a collection of tests can be launched by executing:\r\n\r\n```python\r\nimport subgroups.tests as st\r\nst.run_all_tests()\r\n```\r\n\r\n## Documentation\r\n\r\nThe official documentation is hosted on https://antoniolopezmc.github.io/subgroups-docs/\r\n\r\n## Manually generating the documentation\r\n\r\nTo manually generate the library documentation, it is necessary to execute:\r\n\r\n```sh\r\n# 1. Clone the repository.\r\ngit clone https://github.com/antoniolopezmc/subgroups.git\r\n# 2. Go to the 'docs' subfolder.\r\ncd subgroups/docs\r\n# 3. Generate the documentation.\r\nmake build\r\n```\r\n\r\nThe generated documentation will be located in the *build* subfolder.\r\n",
"bugtrack_url": null,
"license": "BSD-3-Clause",
"summary": "subgroups is a python library which contains a collection of subgroup discovery algorithms and other data analysis utilities",
"version": "0.1.6",
"project_urls": {
"Homepage": "https://github.com/antoniolopezmc/subgroups"
},
"split_keywords": [
"python",
"data-science",
"machine-learning",
"data-analysis",
"subgroups",
"subgroup-discovery"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "f7c9251d2b903ca0f93fc629fdc78f31a6a3975000bf67f4fe1887b6ae2e7317",
"md5": "6b49eb588f05d844a9c9d6d386112e42",
"sha256": "5ef0c22cb0c7744cef6442317277cfeaf4a775c7daae9b4d3ed0ea04f7486d4e"
},
"downloads": -1,
"filename": "subgroups-0.1.6-py3-none-any.whl",
"has_sig": false,
"md5_digest": "6b49eb588f05d844a9c9d6d386112e42",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.9.0",
"size": 253890,
"upload_time": "2024-03-07T16:29:33",
"upload_time_iso_8601": "2024-03-07T16:29:33.230675Z",
"url": "https://files.pythonhosted.org/packages/f7/c9/251d2b903ca0f93fc629fdc78f31a6a3975000bf67f4fe1887b6ae2e7317/subgroups-0.1.6-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-03-07 16:29:33",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "antoniolopezmc",
"github_project": "subgroups",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"lcname": "subgroups"
}
JSON
