Merge pull request #17 from jedymatt/add-docs

Update docs

Author: jedymatt

docs/source/api.rst

@@ -1,40 +1,38 @@
-.. currentmodule:: sqlalchemyseed
-
 API Reference
 =============
 
 Seeders
---------------
+-------
 
-.. autoclass:: seeder.Seeder
+.. autoclass:: sqlalchemyseed.Seeder
     :members:
     :undoc-members:
 
-.. autoclass:: seeder.HybridSeeder
+.. autoclass:: sqlalchemyseed.HybridSeeder
     :members:
     :undoc-members:
 
 Loaders
 -------
 
-.. automodule:: loader
-    :members:
-    :undoc-members:
+.. autofunction:: sqlalchemyseed.load_entities_from_json
+    
+.. autofunction:: sqlalchemyseed.load_entities_from_yaml
+
+.. autofunction:: sqlalchemyseed.load_entities_from_csv
+
 
 Validators
 ----------
 
-.. autoclass:: validator.SchemaValidator
-    :members:
-
-.. autofunction:: validator.validate
+.. autofunction:: sqlalchemyseed.validator.validate
 
 
-.. autofunction:: validator.hybrid_validate 
+.. autofunction:: sqlalchemyseed.validator.hybrid_validate 
 
 
 Exceptions
 ----------
 
-.. automodule:: errors
+.. automodule:: sqlalchemyseed.errors
     :members:

docs/source/conf.py

@@ -28,7 +28,7 @@
 # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
 # ones.
 extensions = [
-    'sphinx.ext.autodoc'
+    'sphinx.ext.autodoc',
 ]
 
 # Add any paths that contain templates here, relative to this directory.

docs/source/index.rst

@@ -6,14 +6,9 @@
 Welcome to sqlalchemyseed's documentation!
 ==========================================
 
-sqlalchemyseed is a SQLAlchemy seeder that supports nested relationships
-with an easy to read text files.
-
-Contents
-========
-
 .. toctree::
     :maxdepth: 2
+    :caption: Contents
 
     intro
     api

docs/source/intro.rst

@@ -10,10 +10,50 @@ Supported file types.
 - yaml
 - csv
 
-Example of json file
+Installation
+------------
+
+Default installation
+
+.. code-block:: console
+
+    pip install sqlalchemyseed
+
+When using yaml to load entities from yaml files,
+execute this command to install necessary dependencies
+
+.. code-block:: console
+
+    pip install sqlalchemyseed[yaml]
+
+Getting Started
+---------------
+
+Here's a simple snippet to get started from :code:`main.py` file.
+
+.. code-block:: python
+
+    from sqlalchemyseed import load_entities_from_json
+    from sqlalchemyseed import Seeder
+    from db import session
+
+    # load entities
+    entities = load_entities_from_json('data.json')
 
-.. code-block :: json
+    # Initializing Seeder
+    seeder = Seeder(session)
 
+    # Seeding
+    seeder.seed(entities)
+
+    # Committing
+    session.commit()  # or seeder.session.commit()
+
+
+And the :code:`data.json` file.
+
+.. code-block:: json
+    
     {
         "model": "models.Person",
         "data": [
@@ -27,16 +67,3 @@ Example of json file
             }
         ]
     }
-
-
-Installation
-------------
-
-Default installation ::
-
-    pip install sqlalchemyseed
-
-When using yaml to load entities from yaml files,
-execute this command to install necessary dependencies ::
-
-    pip install sqlalchemyseed[yaml]