| Name | igrafx-mining-sdk JSON |
| Version |
2.36.1
JSON |
| download |
| home_page | None |
| Summary | The iGrafx P360 Live Mining SDK is an open source application that can be used to manage your mining projects. |
| upload_time | 2025-07-29 09:40:53 |
| maintainer | None |
| docs_url | None |
| author | iGrafx |
| requires_python | <3.12.1,>=3.10.0 |
| license | MIT |
| keywords |
process
mining
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# iGrafx P360 Live Mining SDK
[](https://pypi.python.org/pypi/ansicolortags/)
[](https://github.com/igrafx/mining-python-sdk/blob/main/LICENSE)
[](https://github.com/igrafx/mining-python-sdk/forks)
[](http://www.repostatus.org/#active)
[](https://www.python.org/)
[](https://github.com/ellerbrock/open-source-badges/)
***
## Introduction
The **iGrafx P360 Live Mining SDK** is an open source application that can be used to manage your mining projects.
It is a python implementation of the iGrafx P360 Live Mining API.
With this SDK, you will be able to create workgroups, projects, datasources and graphs (and graph instances). You will also be able to create and
add a column mapping.
Please note that you must have an iGrafx account in order to be able to use the SDK properly. Please contact us to create an account.
The iGrafx P360 Live Mining SDK uses Python.
A detailed tutorial can be found in the [howto.md](https://github.com/igrafx/mining-python-sdk/blob/dev/howto.md) file.
You may find the github of the iGrafx Mining SDK [here](https://github.com/igrafx/mining-python-sdk).
You may also find the github of the iGrafx KNIME Mining Extension [here](https://github.com/igrafx/KNIME-Mining-connector)
which is based on the iGrafx Mining SDK.
## Requirements
This package requires python 3.10 or above. Get the latest version of [Python](https://www.python.org/).
The required packages should be installed via the ```pyproject.toml``` when running the ```poetry install``` command.
This project includes a jar from Apache Calcite Avatica
(https://mvnrepository.com/artifact/org.apache.calcite.avatica/avatica),
which is licensed under the Apache License, Version 2.0.
The original Apache License can be found in LICENSES/Apache-2.0.txt.
## Installing
### With pip:
To install the current release of the iGrafx P360 Live Mining SDK with **pip**, simply navigate to the console and type the following command:
````shell
pip install igrafx_mining_sdk
````
### To begin:
Go ahead and **import** the package:
```python
import igrafx_mining_sdk as igx # the 'as igx' is entirely optional, but it will make the rest of our code much more readable
```
## Documentation
The full documentation can be found in the ```howto.md``` file [here](https://github.com/igrafx/mining-python-sdk/blob/dev/howto.md).
Follow the instructions to try out the SDK.
## Contributing
Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.
Please make sure to update tests as appropriate.
For more information on how to contribute, please see the [CONTRIBUTING.md](https://github.com/igrafx/mining-python-sdk/blob/dev/CONTRIBUTING.md) file.
## Support
Support is available at the following address: [support@igrafx.com](mailto:support@igrafx.com).
## Notice
Your feedback and contributions are important to us. Don't hesitate to contribute to the project.
## License
This SDK is licensed under the MIT License. See the ````LICENSE```` file for more details.
It also includes dependencies that are licensed under **Apache License 2.0**.
See `LICENSES/Apache-2.0.txt` and `NOTICE` for details.
Raw data
{
"_id": null,
"home_page": null,
"name": "igrafx-mining-sdk",
"maintainer": null,
"docs_url": null,
"requires_python": "<3.12.1,>=3.10.0",
"maintainer_email": null,
"keywords": "process mining",
"author": "iGrafx",
"author_email": "contact@igrafx.com",
"download_url": "https://files.pythonhosted.org/packages/d3/94/98ac900bf3bbfe99cedbbdbf756251c99d9dc8d6a97608fd1b68c86faa6c/igrafx_mining_sdk-2.36.1.tar.gz",
"platform": null,
"description": "\n\n# iGrafx P360 Live Mining SDK\n\n\n[](https://pypi.python.org/pypi/ansicolortags/)\n\n[](https://github.com/igrafx/mining-python-sdk/blob/main/LICENSE)\n[](https://github.com/igrafx/mining-python-sdk/forks)\n\n[](http://www.repostatus.org/#active)\n\n\n[](https://www.python.org/)\n[](https://github.com/ellerbrock/open-source-badges/)\n\n***\n\n## Introduction\n\nThe **iGrafx P360 Live Mining SDK** is an open source application that can be used to manage your mining projects.\nIt is a python implementation of the iGrafx P360 Live Mining API.\n\nWith this SDK, you will be able to create workgroups, projects, datasources and graphs (and graph instances). You will also be able to create and \nadd a column mapping.\n\nPlease note that you must have an iGrafx account in order to be able to use the SDK properly. Please contact us to create an account.\n\nThe iGrafx P360 Live Mining SDK uses Python.\n\nA detailed tutorial can be found in the [howto.md](https://github.com/igrafx/mining-python-sdk/blob/dev/howto.md) file.\n\nYou may find the github of the iGrafx Mining SDK [here](https://github.com/igrafx/mining-python-sdk).\n\nYou may also find the github of the iGrafx KNIME Mining Extension [here](https://github.com/igrafx/KNIME-Mining-connector) \nwhich is based on the iGrafx Mining SDK.\n\n\n\n## Requirements\n\nThis package requires python 3.10 or above. Get the latest version of [Python](https://www.python.org/).\n\nThe required packages should be installed via the ```pyproject.toml``` when running the ```poetry install``` command. \n\nThis project includes a jar from Apache Calcite Avatica\n(https://mvnrepository.com/artifact/org.apache.calcite.avatica/avatica),\nwhich is licensed under the Apache License, Version 2.0.\n\nThe original Apache License can be found in LICENSES/Apache-2.0.txt.\n\n\n## Installing\n\n### With pip:\nTo install the current release of the iGrafx P360 Live Mining SDK with **pip**, simply navigate to the console and type the following command: \n````shell\npip install igrafx_mining_sdk\n````\n\n### To begin:\nGo ahead and **import** the package:\n```python\nimport igrafx_mining_sdk as igx # the 'as igx' is entirely optional, but it will make the rest of our code much more readable\n```\n\n## Documentation\n\nThe full documentation can be found in the ```howto.md``` file [here](https://github.com/igrafx/mining-python-sdk/blob/dev/howto.md).\nFollow the instructions to try out the SDK.\n\n\n## Contributing\n\nPull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.\n\nPlease make sure to update tests as appropriate.\n\nFor more information on how to contribute, please see the [CONTRIBUTING.md](https://github.com/igrafx/mining-python-sdk/blob/dev/CONTRIBUTING.md) file.\n\n## Support\n\nSupport is available at the following address: [support@igrafx.com](mailto:support@igrafx.com).\n\n## Notice\n\nYour feedback and contributions are important to us. Don't hesitate to contribute to the project.\n\n## License\n\nThis SDK is licensed under the MIT License. See the ````LICENSE```` file for more details.\n\nIt also includes dependencies that are licensed under **Apache License 2.0**.\nSee `LICENSES/Apache-2.0.txt` and `NOTICE` for details.\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "The iGrafx P360 Live Mining SDK is an open source application that can be used to manage your mining projects.",
"version": "2.36.1",
"project_urls": {
"Homepage": "https://www.igrafx.com/",
"Repository": "https://github.com/igrafx/mining-python-sdk"
},
"split_keywords": [
"process",
"mining"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "28643737ce5d5948d41d9ca8589f957d6d27f88ac69433d2416768a7f0bfbe9b",
"md5": "ea413b1de5aeba1c1d1d857b78c03bc4",
"sha256": "770b3f41bfc5f4ade81dc85a9139248de66ee96a431691937920c337b7a86082"
},
"downloads": -1,
"filename": "igrafx_mining_sdk-2.36.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "ea413b1de5aeba1c1d1d857b78c03bc4",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": "<3.12.1,>=3.10.0",
"size": 7066377,
"upload_time": "2025-07-29T09:40:51",
"upload_time_iso_8601": "2025-07-29T09:40:51.676113Z",
"url": "https://files.pythonhosted.org/packages/28/64/3737ce5d5948d41d9ca8589f957d6d27f88ac69433d2416768a7f0bfbe9b/igrafx_mining_sdk-2.36.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "d39498ac900bf3bbfe99cedbbdbf756251c99d9dc8d6a97608fd1b68c86faa6c",
"md5": "48544673627fef647a796ea30df5815e",
"sha256": "e310367e4089fec4e7f9bb562806d5d926e4adf74af17c9ade560dd9098a63d1"
},
"downloads": -1,
"filename": "igrafx_mining_sdk-2.36.1.tar.gz",
"has_sig": false,
"md5_digest": "48544673627fef647a796ea30df5815e",
"packagetype": "sdist",
"python_version": "source",
"requires_python": "<3.12.1,>=3.10.0",
"size": 7066652,
"upload_time": "2025-07-29T09:40:53",
"upload_time_iso_8601": "2025-07-29T09:40:53.214542Z",
"url": "https://files.pythonhosted.org/packages/d3/94/98ac900bf3bbfe99cedbbdbf756251c99d9dc8d6a97608fd1b68c86faa6c/igrafx_mining_sdk-2.36.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2025-07-29 09:40:53",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "igrafx",
"github_project": "mining-python-sdk",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "igrafx-mining-sdk"
}
