Skip to content

Commit

Permalink
Some extra documentation.
Browse files Browse the repository at this point in the history
  • Loading branch information
koenedaele committed Feb 21, 2015
1 parent 213ccf5 commit aaadce8
Show file tree
Hide file tree
Showing 2 changed files with 38 additions and 3 deletions.
8 changes: 5 additions & 3 deletions docs/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -3,14 +3,15 @@
You can adapt this file completely to your liking, but it should at least
contain the root `toctree` directive.
Welcome to Skosprovider_sqlalchemy's documentation!
===================================================
SkosProvider_SQLAlchemy
=======================

This library offers an implementation of the
:class:`skosprovider.providers.VocabularyProvider`
interface that uses a SQLALchemy_ backend. While a
:class:`VocabularyProvider <skosprovider.providers.VocabularyProvider>` is
a read-only interface, the underlying SQLAlchemy_ domain model is fully
a read-only interface, the underlying SQLAlchemy_
:mod:`domain model <skosprovider_sqlalchemy.models>` is fully
writeable.

This library is fully integrated into Atramhasis_, an online open source
Expand All @@ -19,6 +20,7 @@ editor for :term:`SKOS` vocabularies.
.. toctree::
:maxdepth: 2

setup
api
changes

Expand Down
33 changes: 33 additions & 0 deletions docs/setup.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,33 @@
.. _setup:

=====
Setup
=====

Installation
============

Installation of Skosprovider_sqlalchemy is easily done using :command:`pip`.

.. code-block:: bash
$ pip install skosprovider_sqlalchemy
Creating a database
===================

Since Skosprovider_sqlalchemy implements the SkosProvider_ interface with a
relational database as a backend, you first need to create this database.

.. note::

Because Skosprovider_sqlalchemy uses SQLAlchemy_ as an ORM layer, it's not
tailored to any specific database. The codebase is continuously tested
on both SQLite_ and PostgreSQL_. Other databases are untested by us, but as
long as they are supported by SQLAlchemy_, they should work.


.. _SkosProvider: http://skosprovider.readthedocs.org
.. _SQLAlchemy: http://docs.sqlalchemy.org/
.. _SQLite: http://www.sqlite.org
.. _PostgreSQL: http://www.postgresql.org

0 comments on commit aaadce8

Please sign in to comment.