Finalized v1 release

.gitignore

@@ -29,6 +29,7 @@ share/python-wheels/
 .installed.cfg
 *.egg
 MANIFEST
+.DS_Store
 
 # PyInstaller
 #  Usually these files are written by a python script from a template

README.md

@@ -25,10 +25,12 @@ pip install snowfall
 ```
 
 ### Quickstart
-To start generating IDs, simply instantiate a `Snowfall`.
+To start generating IDs, simply create a schema group and start a `Snowfall`. 
 ```
 from snowfall import Snowfall
+from snowfall.generator_syncers import SimpleSyncer
 
+SimpleSyncer.create_schema_group()
 id_generator = Snowfall()
 ```
 Successively calling `get_guid()` will return valid GUIDs. 
@@ -49,10 +51,11 @@ The `generator_syncers` module contains classes that enforce this constraint by
 
 #### For single-process projects
 For single-process projects, we provide a `SimpleSyncer` that records the manifest as a Python data structure. First, create a new global schema group, and then bind the Snowfall instance to it.
+
+All `Snowfall` instances that share the same schema group will not create duplicate GUIDs.
 ```
-from datetime import datetime
 from snowfall import Snowfall
-from snowfall.generator_syncers.simple_syncer import SimpleSyncer
+from snowfall.generator_syncers import SimpleSyncer
 
 SimpleSyncer.create_schema_group(
     schema_group_name="example_schema_group"
@@ -84,7 +87,7 @@ For multi-process, multi-container projects, we need to persist the `generator_i
 ```
 from datetime import datetime
 from snowfall import Snowfall
-from snowfall.generator_syncers.database_syncer import DatabaseSyncer
+from snowfall.generator_syncers import DatabaseSyncer
 
 DatabaseSyncer.create_schema_group(
     schema_group_name="example_schema_group"

snowfall/__init__.py

@@ -0,0 +1 @@
+from snowfall.main import Snowfall

snowfall/generator_syncers/__init__.py

@@ -0,0 +1,3 @@
+from snowfall.generator_syncers.abstracts import BaseSyncer
+from snowfall.generator_syncers.database_syncer import DatabaseSyncer
+from snowfall.generator_syncers.simple_syncer import SimpleSyncer

src/generator_syncers/abstracts.py → snowfall/generator_syncers/abstracts.py

@@ -1,7 +1,7 @@
 from abc import ABC, abstractmethod
 from apscheduler.schedulers.background import BackgroundScheduler
 
-from utils import get_current_timestamp_ms
+from snowfall.utils import get_current_timestamp_ms
 
 
 class BaseSyncer(ABC):

src/generator_syncers/database_syncer.py → snowfall/generator_syncers/database_syncer.py

@@ -9,8 +9,8 @@
 from sqlalchemy.ext.declarative import declarative_base
 from sqlalchemy.engine.base import Engine
 
-from generator_syncers.abstracts import BaseSyncer
-from utils import get_current_timestamp_ms
+from snowfall.generator_syncers.abstracts import BaseSyncer
+from snowfall.utils import get_current_timestamp_ms
 
 
 class DatabaseSyncer(BaseSyncer):

src/generator_syncers/simple_syncer.py → snowfall/generator_syncers/simple_syncer.py

@@ -2,8 +2,8 @@
 from collections import namedtuple
 import numpy as np
 
-from generator_syncers.abstracts import BaseSyncer
-from utils import get_current_timestamp_ms
+from snowfall.generator_syncers.abstracts import BaseSyncer
+from snowfall.utils import get_current_timestamp_ms
 
 
 SchemaGroup = namedtuple(

src/main.py → snowfall/main.py

@@ -2,8 +2,8 @@
 from datetime import datetime
 from time import sleep
 
-from generator_syncers import BaseSyncer, SimpleSyncer
-from utils import get_current_timestamp_ms
+from snowfall.generator_syncers import BaseSyncer, SimpleSyncer
+from snowfall.utils import get_current_timestamp_ms
 
 
 class Snowfall: