Installation#
Installation of EdgeGraph is rather simple via Pip:
$ pip install edgegraph
Details of the Pip package can be found on Pip at https://pypi.org/project/edgegraph/ .
Extras#
Edgegraph’s pip definition contains some optional extra components:
$ pip install edgegraph[foreign]for all the foreign Python modules edgegraph can interface with$ pip install edgegraph[full]for all the above options$ pip install edgegraph[development]for the full devops packages needed to develop, test, document, build, and publish edgegraph itself (this includes edgegraph[full])
Versioning#
Edgegraph follows a subset of semantic versioning that is compatible with
PyPI’s version specification. Version numbers are formatted as X.Y.Z,
where:
Xis the “major” version number, incrementing when backwards-incompatible changes are madeYis the “minor” version number, incrementing when backwards-compatible new features are addedZis the “patch” version number, incrementing when minute changes and/or bugfix-only changes are made
See also
https://semver.org , the Semantic Versioning standard
https://packaging.python.org/en/latest/specifications/version-specifiers/#version-specifiers , the PyPI version specification
To maintain easy compatibility between these version standards, SemVer pre-release or build metadata are not used.
Development versions#
EdgeGraph can also be “installed” by cloning the repository and adding it to
your Python module path (though, be sure to add the edgegraph folder within
the repo, and not the repo itself). You may check out any of the branches you
wish, though note that only the master branch is guaranteed to be stable
at any given moment.
You can also use Pip’s repository installation:
$ pip install git+https://github.com/mishaturnbull/edgegraph@branch
The repository is tagged for each versioned release; the tag names are the
version prefixed with a v. For example, v0.2.0 is the tag name for
version 0.2.0.
See also
More information about branches can be found here: Version Control.