# Spine Database API
[](https://spine-database-api.readthedocs.io/en/latest/?badge=latest)
[](https://github.com/spine-tools/Spine-Database-API/actions?query=workflow%3A"Unit+tests")
[](https://codecov.io/gh/spine-tools/Spine-Database-API)
[](https://badge.fury.io/py/spinedb-api)
A Python package to access and manipulate Spine databases in a customary, unified way.
## License
Spine Database API is released under the GNU Lesser General Public License (LGPL) license. All accompanying
documentation and manual are released under the Creative Commons BY-SA 4.0 license.
## Getting started
### Installation
To install the package run:
$ pip install spinedb_api
To upgrade to the most recent version, run:
$ pip install --upgrade spinedb_api
You can also specify a version, for instance:
$ pip install spinedb_api==0.32.0
To install the latest development version use the Git repository url:
$ pip install --upgrade git+https://github.com/spine-tools/Spine-Database-API.git
## Building the documentation
Source files for the documentation can be found in `docs/source` directory. In order to
build the HTML docs, you need to install the developer dependencies
by running:
$ pip install -r dev-requirements.txt
This installs Sphinx (among other things), which is required in building the documentation.
When Sphinx is installed, you can build the HTML pages from the source files by running:
> bin\build_doc.bat
or
$ bin/build_doc.py
depending on your operating system.
After running the build, the index page can be found in `docs/build/html/index.html`.
<hr>
<table width=500px frame="none">
<tr>
<td valign="middle" width=100px>
<img src=fig/eu-emblem-low-res.jpg alt="EU emblem" width=100%></td>
<td valign="middle">This project has received funding from European Climate, Infrastructure and Environment Executive Agency under the European Union’s HORIZON Research and Innovation Actions under grant agreement N°101095998.</td>
<tr>
<td valign="middle" width=100px>
<img src=fig/eu-emblem-low-res.jpg alt="EU emblem" width=100%></td>
<td valign="middle">This project has received funding from the European Union’s Horizon 2020 research and innovation programme under grant agreement No 774629.</td>
</table>
Raw data
{
"_id": null,
"home_page": null,
"name": "spinedb-api",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.9",
"maintainer_email": null,
"keywords": "energy system modelling, workflow, optimisation, database",
"author": null,
"author_email": "Spine Project consortium <spine_info@vtt.fi>",
"download_url": "https://files.pythonhosted.org/packages/a6/00/a0ee44e67f025990a43544d77a0f344611e8c5a4d5c144c40435a1119e8d/spinedb_api-0.34.0.tar.gz",
"platform": null,
"description": "# Spine Database API\n\n[](https://spine-database-api.readthedocs.io/en/latest/?badge=latest)\n[](https://github.com/spine-tools/Spine-Database-API/actions?query=workflow%3A\"Unit+tests\")\n[](https://codecov.io/gh/spine-tools/Spine-Database-API)\n[](https://badge.fury.io/py/spinedb-api)\n\nA Python package to access and manipulate Spine databases in a customary, unified way.\n\n## License\n\nSpine Database API is released under the GNU Lesser General Public License (LGPL) license. All accompanying\ndocumentation and manual are released under the Creative Commons BY-SA 4.0 license.\n\n## Getting started\n\n### Installation\n\nTo install the package run:\n\n $ pip install spinedb_api\n\nTo upgrade to the most recent version, run:\n\n $ pip install --upgrade spinedb_api\n\nYou can also specify a version, for instance:\n\n $ pip install spinedb_api==0.32.0\n\nTo install the latest development version use the Git repository url:\n\n $ pip install --upgrade git+https://github.com/spine-tools/Spine-Database-API.git\n\n\n## Building the documentation\n\nSource files for the documentation can be found in `docs/source` directory. In order to \nbuild the HTML docs, you need to install the developer dependencies\nby running:\n\n $ pip install -r dev-requirements.txt\n\nThis installs Sphinx (among other things), which is required in building the documentation.\nWhen Sphinx is installed, you can build the HTML pages from the source files by running:\n\n > bin\\build_doc.bat\n \nor\n\n $ bin/build_doc.py\n \ndepending on your operating system. \n \nAfter running the build, the index page can be found in `docs/build/html/index.html`.\n\n \n<hr>\n<table width=500px frame=\"none\">\n<tr>\n<td valign=\"middle\" width=100px>\n<img src=fig/eu-emblem-low-res.jpg alt=\"EU emblem\" width=100%></td>\n<td valign=\"middle\">This project has received funding from European Climate, Infrastructure and Environment Executive Agency under the European Union\u2019s HORIZON Research and Innovation Actions under grant agreement N\u00b0101095998.</td>\n<tr>\n<td valign=\"middle\" width=100px>\n<img src=fig/eu-emblem-low-res.jpg alt=\"EU emblem\" width=100%></td>\n<td valign=\"middle\">This project has received funding from the European Union\u2019s Horizon 2020 research and innovation programme under grant agreement No 774629.</td>\n</table>\n",
"bugtrack_url": null,
"license": "LGPL-3.0-or-later",
"summary": "An API to talk to Spine databases.",
"version": "0.34.0",
"project_urls": {
"Repository": "https://github.com/spine-tools/Spine-Database-API"
},
"split_keywords": [
"energy system modelling",
" workflow",
" optimisation",
" database"
],
"urls": [
{
"comment_text": null,
"digests": {
"blake2b_256": "def7d08bf8502b4cd2227e409ceb374e736293d40b25fa187080016f5f837c25",
"md5": "fe81ce72b8529ec5de92e29864b2d4db",
"sha256": "91725017271f1eea6faa4657ac65782607ff76689aa7cfac1a8884aa1022ec58"
},
"downloads": -1,
"filename": "spinedb_api-0.34.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "fe81ce72b8529ec5de92e29864b2d4db",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.9",
"size": 253416,
"upload_time": "2025-03-31T11:02:55",
"upload_time_iso_8601": "2025-03-31T11:02:55.842707Z",
"url": "https://files.pythonhosted.org/packages/de/f7/d08bf8502b4cd2227e409ceb374e736293d40b25fa187080016f5f837c25/spinedb_api-0.34.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": null,
"digests": {
"blake2b_256": "a600a0ee44e67f025990a43544d77a0f344611e8c5a4d5c144c40435a1119e8d",
"md5": "431991db19e4b8a35bf412e45b52e3e5",
"sha256": "8a26835393433f2e2cfb755a9dba26cc5205d0d6524b4fe42cc13702a855dd7e"
},
"downloads": -1,
"filename": "spinedb_api-0.34.0.tar.gz",
"has_sig": false,
"md5_digest": "431991db19e4b8a35bf412e45b52e3e5",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.9",
"size": 382160,
"upload_time": "2025-03-31T11:02:58",
"upload_time_iso_8601": "2025-03-31T11:02:58.326618Z",
"url": "https://files.pythonhosted.org/packages/a6/00/a0ee44e67f025990a43544d77a0f344611e8c5a4d5c144c40435a1119e8d/spinedb_api-0.34.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2025-03-31 11:02:58",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "spine-tools",
"github_project": "Spine-Database-API",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "spinedb-api"
}
JSON
