# 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/62/5d/ab17e8529feaa1b36255bb9442a512d8b70886b968892601dd614144430d/typed_graph-0.3.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.3.0",
"project_urls": {
"Homepage": "https://github.com/build-aau/typed_graph"
},
"split_keywords": [
"graph",
" type"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "dcd36da8809af6553fb11c41224cf20470cc76d98cc6a70be8c1b6a1b7ddd57e",
"md5": "408875f7de424118e025285e2f2cf3a0",
"sha256": "6f016ada88f18815c6a87686eb6e4bfe95c942501c3a469105f377b2b8e47554"
},
"downloads": -1,
"filename": "typed_graph-0.3.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "408875f7de424118e025285e2f2cf3a0",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.10",
"size": 23239,
"upload_time": "2024-11-18T08:28:37",
"upload_time_iso_8601": "2024-11-18T08:28:37.119645Z",
"url": "https://files.pythonhosted.org/packages/dc/d3/6da8809af6553fb11c41224cf20470cc76d98cc6a70be8c1b6a1b7ddd57e/typed_graph-0.3.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "625dab17e8529feaa1b36255bb9442a512d8b70886b968892601dd614144430d",
"md5": "a1ed21f2757f61c828e0f41b1ae58a37",
"sha256": "e2846553c1c0ac39471911dcba878706c4690bc92000071c3468d7ee7b87019a"
},
"downloads": -1,
"filename": "typed_graph-0.3.0.tar.gz",
"has_sig": false,
"md5_digest": "a1ed21f2757f61c828e0f41b1ae58a37",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.10",
"size": 21158,
"upload_time": "2024-11-18T08:28:38",
"upload_time_iso_8601": "2024-11-18T08:28:38.716388Z",
"url": "https://files.pythonhosted.org/packages/62/5d/ab17e8529feaa1b36255bb9442a512d8b70886b968892601dd614144430d/typed_graph-0.3.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-11-18 08:28:38",
"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
