Rework project structure and publish on pypi

ilevn · Dec 5, 2020 · ef47991 · ef47991
1 parent 229fe4d
commit ef47991
Show file tree

Hide file tree

Showing 8 changed files with 27 additions and 10 deletions.
diff --git a/README.md → README.rst b/README.md → README.rst
@@ -1,4 +1,5 @@
-# sql-generator
+sql-generator
+=============
 
 This tool lets you generate postgresql insert statements for common data types.  
 It's pretty minimalistic at the moment but offers support for basic statements 
@@ -7,10 +8,26 @@ and foreign key relations.
 In addition to that, `sql-generator` supports custom generators for table columns
 and data types.
 
-## Usage
+Installation
+------------
+**Python 3.9 or higher is required**
+
+To install the module, run the following command:
+```
+# Linux/macOS
+python3 -m pip install -U sql-generator
+
+# Windows
+py -3 -m pip install -U sql-generator
+
+# Poetry
+poetry add sql-generator
+```
+Usage
+-----
 
 ```python
-from generator import Generator, write_results_to_file
+from sql_generator import Generator, write_results_to_file
 import psycopg2
 
 # Custom converter for all columns or data types with

diff --git a/requirements.txt b/requirements.txt
diff --git a/sql_generator/__init__.py b/sql_generator/__init__.py
@@ -0,0 +1,3 @@
+from .analyser import Analyser
+from .generator import Generator, write_results_to_file, flatten_dict_list
+from .generators import *
diff --git a/analyser.py → sql_generator/analyser.py b/analyser.py → sql_generator/analyser.py
diff --git a/generator.py → sql_generator/generator.py b/generator.py → sql_generator/generator.py
@@ -3,8 +3,8 @@
 
 import toposort
 
-from analyser import Analyser
-from generators import password_generator, first_name_generator, last_name_generator, text_generator, email_generator, \
+from .analyser import Analyser
+from .generators import password_generator, first_name_generator, last_name_generator, text_generator, email_generator, \
     phone_generator, get_converter
 
 

diff --git a/generators.py → sql_generator/generators.py b/generators.py → sql_generator/generators.py
@@ -29,8 +29,8 @@
 from argon2 import PasswordHasher
 
 # https://github.com/imsky/wordlists, Licenced: Copyright (c) 2017-2019 Ivan Malopinsky
-FIRSTS = open("first.txt").readlines()
-LASTS = open("last.txt").readlines()
+FIRSTS = open("sql_generator/resources/first.txt").readlines()
+LASTS = open("sql_generator/resources/last.txt").readlines()
 
 PW_HASHER = PasswordHasher()
 PRINTABLE = list(string.ascii_letters + string.digits + string.punctuation)

diff --git a/first.txt → sql_generator/resources/first.txt b/first.txt → sql_generator/resources/first.txt
diff --git a/last.txt → sql_generator/resources/last.txt b/last.txt → sql_generator/resources/last.txt