| Name | raphtory-stubs JSON |
| Version |
0.1.3
JSON |
| download |
| home_page | None |
| Summary | Type stubs for the Raphtory library |
| upload_time | 2024-07-03 00:22:25 |
| maintainer | None |
| docs_url | None |
| author | None |
| requires_python | >=3.7 |
| license | MIT |
| keywords |
raphtory
stubs
type hints
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# raphtory-stubs
🚧 WIP! Some of these types are incomplete and/or incorrect 🚧
Type stubs for the [Raphtory](https://github.com/pometry/raphtory) library.
## Description
`raphtory-stubs` provides type information for the Raphtory library, enabling better IDE support and static type checking when using Raphtory in your Python projects.
## Installation
You can install `raphtory-stubs` using pip:
```bash
pip install raphtory-stubs
```
## Usage
After installation, your type checker and IDE should automatically recognize the type information for Raphtory. You don't need to change your import statements; just import Raphtory as usual:
```python
from raphtory import Graph, Node, Edge
# Your IDE should now provide better autocompletion and type information
graph = Graph()
```
## Type Checking
To run type checking on your project that uses Raphtory, you can use a tool like mypy:
```bash
mypy your_script.py
```
## Supported Raphtory Version
This stubs package is compatible with Raphtory version 0.9.3. Please ensure you're using a compatible version of Raphtory.
## Contributing
Contributions to improve the type stubs are welcome! Please submit a pull request or open an issue on the [GitHub repository](https://github.com/hallofstairs/raphtory-stubs).
## License
This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.
## Disclaimer
This package contains type stubs to support static typing. It does not contain the actual implementation of Raphtory. Please refer to the [official Raphtory documentation](https://raphtory.readthedocs.io/) for usage information.
## Contact
If you have any questions or issues, please open an issue on the [GitHub repository](https://github.com/hallofstairs/raphtory-stubs/issues).
Raw data
{
"_id": null,
"home_page": null,
"name": "raphtory-stubs",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.7",
"maintainer_email": null,
"keywords": "raphtory, stubs, type hints",
"author": null,
"author_email": "Jett Hollister <jetthollister@pm.me>",
"download_url": "https://files.pythonhosted.org/packages/cb/c7/295042f064b9c8a70214d72aeac5da826a71d591aadcea9e2a529c1c6798/raphtory_stubs-0.1.3.tar.gz",
"platform": null,
"description": "# raphtory-stubs\n\n\ud83d\udea7 WIP! Some of these types are incomplete and/or incorrect \ud83d\udea7\n\nType stubs for the [Raphtory](https://github.com/pometry/raphtory) library.\n\n## Description\n\n`raphtory-stubs` provides type information for the Raphtory library, enabling better IDE support and static type checking when using Raphtory in your Python projects.\n\n## Installation\n\nYou can install `raphtory-stubs` using pip:\n\n```bash\npip install raphtory-stubs\n```\n\n## Usage\n\nAfter installation, your type checker and IDE should automatically recognize the type information for Raphtory. You don't need to change your import statements; just import Raphtory as usual:\n\n```python\nfrom raphtory import Graph, Node, Edge\n\n# Your IDE should now provide better autocompletion and type information\ngraph = Graph()\n```\n\n## Type Checking\n\nTo run type checking on your project that uses Raphtory, you can use a tool like mypy:\n\n```bash\nmypy your_script.py\n```\n\n## Supported Raphtory Version\n\nThis stubs package is compatible with Raphtory version 0.9.3. Please ensure you're using a compatible version of Raphtory.\n\n## Contributing\n\nContributions to improve the type stubs are welcome! Please submit a pull request or open an issue on the [GitHub repository](https://github.com/hallofstairs/raphtory-stubs).\n\n## License\n\nThis project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.\n\n## Disclaimer\n\nThis package contains type stubs to support static typing. It does not contain the actual implementation of Raphtory. Please refer to the [official Raphtory documentation](https://raphtory.readthedocs.io/) for usage information.\n\n## Contact\n\nIf you have any questions or issues, please open an issue on the [GitHub repository](https://github.com/hallofstairs/raphtory-stubs/issues).\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "Type stubs for the Raphtory library",
"version": "0.1.3",
"project_urls": {
"Bug Tracker": "https://github.com/hallofstairs/raphtory-stubs/issues",
"Homepage": "https://github.com/hallofstairs/raphtory-stubs"
},
"split_keywords": [
"raphtory",
" stubs",
" type hints"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "0d5d5cf6db0bba444603a859ede0c1bd35e58069648efd68fcb5e1bf12f3dc13",
"md5": "d30f5a31f59a737c739bd48e57d8cc54",
"sha256": "d88080c19cfcbd7352c6957f15a8052d9332cc0f65e4d27ad3137abe4692c89e"
},
"downloads": -1,
"filename": "raphtory_stubs-0.1.3-py3-none-any.whl",
"has_sig": false,
"md5_digest": "d30f5a31f59a737c739bd48e57d8cc54",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.7",
"size": 7577,
"upload_time": "2024-07-03T00:22:23",
"upload_time_iso_8601": "2024-07-03T00:22:23.330054Z",
"url": "https://files.pythonhosted.org/packages/0d/5d/5cf6db0bba444603a859ede0c1bd35e58069648efd68fcb5e1bf12f3dc13/raphtory_stubs-0.1.3-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "cbc7295042f064b9c8a70214d72aeac5da826a71d591aadcea9e2a529c1c6798",
"md5": "5de87c3b98b114484988e229bffc922c",
"sha256": "401b727563237f290262546f5c0a3ef338a916649d1651f624b8ef85a8cd7f66"
},
"downloads": -1,
"filename": "raphtory_stubs-0.1.3.tar.gz",
"has_sig": false,
"md5_digest": "5de87c3b98b114484988e229bffc922c",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.7",
"size": 8507,
"upload_time": "2024-07-03T00:22:25",
"upload_time_iso_8601": "2024-07-03T00:22:25.074317Z",
"url": "https://files.pythonhosted.org/packages/cb/c7/295042f064b9c8a70214d72aeac5da826a71d591aadcea9e2a529c1c6798/raphtory_stubs-0.1.3.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-07-03 00:22:25",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "hallofstairs",
"github_project": "raphtory-stubs",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"lcname": "raphtory-stubs"
}
