Skip to content

ptsavol/Spine-Database-API

 
 

Repository files navigation

Spine Database API

Documentation Status Unit tests codecov PyPI version

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 branch, or a tag, for instance:

$ pip install spinedb_api==0.12.1

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 additional documentation building requirements 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:

> docs\make.bat html

or

$ pushd docs
$ make html
$ popd

depending on your operating system.

After running the build, the index page can be found in docs/build/html/index.html.

 


EU emblem 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.
EU emblem This project has received funding from the European Union’s Horizon 2020 research and innovation programme under grant agreement No 774629.

About

Database interface to Spine generic data model

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Languages

  • Python 100.0%