# TypedGraph
Is a staticly typed graph library.
This is a cross compatible port of [TypedGraph][typed_graph-crates-io].
[](https://pypi.org/pypi/typed_graph/)
TypedGraph is build to provide an easy to use interface for manipulating an maintaining graphs with a rigid schema.
## Getting started
install using
```
pip install typed_graph
```
see the [example folder][examples-git] for information on how to create your first project using TypedGraph.
> Note that making and maintianing large static graphs can be time consuming, so using like [typed_graph_cli][typed_graph_cli-git] will make the library significantly easier to maintian
## Development
To run a local instance of the library:
```
.../typed_graph_py> pip install -e .
```
This will import the library using a symlink, so changes in the directory will be propegated to the python installation
Now it can be used as normal
```
import type_graph
```
[typed_graph-crates-io]: https://crates.io/crates/typed_graph
[examples-git]: https://github.com/build-aau/typed_graph/tree/master/typed_graph_py/examples "example folder in git"
[typed_graph_cli-git]: https://github.com/build-aau/typed_graph_cli "typed_graph_cli in git"
# Build release
First install twine
```pip install twine```
Then to build the release run:
```python setup.py sdist bdist_wheel```
Then test that the build is valid:
```twine check dist/*```
And finally upload to PyPi with:
```twine upload dist/*```
> To avoid having to retype your initials everytime setup a file in `$HOME/.pypirc`
```
[pypi]
username = <username>
password = <password>
```
> Note: your password will be stored in plain text!
> This is also compatible with PyPi access tokens
```
[pypi]
username = __token__
password = pypi-...
```
Raw data
{
"_id": null,
"home_page": "https://github.com/build-aau/typed_graph",
"name": "typed-graph",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.10",
"maintainer_email": null,
"keywords": "graph, type",
"author": "lcabyg",
"author_email": "lcabyg@build.aau.dk",
"download_url": "https://files.pythonhosted.org/packages/c2/ca/f049fd1cd9e00561f0086f10bccba4cda91f29764d552bc703e14ba2b988/typed_graph-0.2.0.tar.gz",
"platform": null,
"description": "# TypedGraph\r\nIs a staticly typed graph library.\r\nThis is a cross compatible port of [TypedGraph][typed_graph-crates-io].\r\n\r\n[](https://pypi.org/pypi/typed_graph/)\r\n\r\nTypedGraph is build to provide an easy to use interface for manipulating an maintaining graphs with a rigid schema.\r\n\r\n## Getting started\r\ninstall using\r\n```\r\npip install typed_graph\r\n```\r\n\r\nsee the [example folder][examples-git] for information on how to create your first project using TypedGraph.\r\n\r\n> Note that making and maintianing large static graphs can be time consuming, so using like [typed_graph_cli][typed_graph_cli-git] will make the library significantly easier to maintian \r\n\r\n## Development\r\nTo run a local instance of the library:\r\n```\r\n.../typed_graph_py> pip install -e .\r\n```\r\n\r\nThis will import the library using a symlink, so changes in the directory will be propegated to the python installation\r\n\r\nNow it can be used as normal\r\n```\r\nimport type_graph\r\n```\r\n\r\n[typed_graph-crates-io]: https://crates.io/crates/typed_graph\r\n[examples-git]: https://github.com/build-aau/typed_graph/tree/master/typed_graph_py/examples \"example folder in git\"\r\n[typed_graph_cli-git]: https://github.com/build-aau/typed_graph_cli \"typed_graph_cli in git\"\r\n\r\n# Build release\r\nFirst install twine\r\n```pip install twine``` \r\nThen to build the release run:\r\n```python setup.py sdist bdist_wheel``` \r\nThen test that the build is valid:\r\n```twine check dist/*``` \r\nAnd finally upload to PyPi with:\r\n```twine upload dist/*``` \r\n\r\n> To avoid having to retype your initials everytime setup a file in `$HOME/.pypirc`\r\n```\r\n[pypi]\r\nusername = <username>\r\npassword = <password>\r\n```\r\n\r\n> Note: your password will be stored in plain text!\r\n\r\n> This is also compatible with PyPi access tokens\r\n```\r\n[pypi]\r\nusername = __token__\r\npassword = pypi-...\r\n```\r\n\r\n\r\n\r\n",
"bugtrack_url": null,
"license": "Apache Software License v2.0",
"summary": "Staticly typed graph library",
"version": "0.2.0",
"project_urls": {
"Homepage": "https://github.com/build-aau/typed_graph"
},
"split_keywords": [
"graph",
" type"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "0f7c9b8f6e3cf6083f466ee442de854178370e7e29826279e8b1a1ef244ba19e",
"md5": "7735396568490cdc3be60d3a0f13cc30",
"sha256": "5306159b80f47b1c809f5da0c5dd63d28484183f45e8ed211b62b02c36cbca3d"
},
"downloads": -1,
"filename": "typed_graph-0.2.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "7735396568490cdc3be60d3a0f13cc30",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.10",
"size": 23186,
"upload_time": "2024-04-09T11:27:32",
"upload_time_iso_8601": "2024-04-09T11:27:32.823481Z",
"url": "https://files.pythonhosted.org/packages/0f/7c/9b8f6e3cf6083f466ee442de854178370e7e29826279e8b1a1ef244ba19e/typed_graph-0.2.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "c2caf049fd1cd9e00561f0086f10bccba4cda91f29764d552bc703e14ba2b988",
"md5": "8bbd788c6528a73357fd2357988223c8",
"sha256": "2e0899e00344b33c6bda6dcfeb695aec250bacba7d1cca961a1cbbc6c449ea1e"
},
"downloads": -1,
"filename": "typed_graph-0.2.0.tar.gz",
"has_sig": false,
"md5_digest": "8bbd788c6528a73357fd2357988223c8",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.10",
"size": 21238,
"upload_time": "2024-04-09T11:27:34",
"upload_time_iso_8601": "2024-04-09T11:27:34.152464Z",
"url": "https://files.pythonhosted.org/packages/c2/ca/f049fd1cd9e00561f0086f10bccba4cda91f29764d552bc703e14ba2b988/typed_graph-0.2.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-04-09 11:27:34",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "build-aau",
"github_project": "typed_graph",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"lcname": "typed-graph"
}
JSON
