Merge pull request #1 from 64bit-lab/setup_tool

Setup tool

Author: acorrenson

.gitignore

@@ -0,0 +1,3 @@
+build/
+dist/
+logik.egg-info/

README.md

@@ -18,10 +18,23 @@ Logik provides 3 main features :
 
 ## How to use Logik ?
 
-Logik is designed to be use in a terminal. You can start Logik by executing `evaluator.py` :
+Logik is designed to be use in a terminal. You can install it by executing the following command directly inside the main folder. (you need to `git clone https://github.com/64bit-lab/Logik` first)
 
 ```
-$ python3 evaluator.py
+$ python3 setup.py install
+```
+
+This will install Logik directly on your machine. You can then start logik by typing :
+
+```
+$ logik
+```
+
+This will start the interactive command line interface :
+
+```
+$ logik
+>>> # type any expression here
 ```
 
 ### Syntax

bin/logik

@@ -0,0 +1,5 @@
+#!/usr/bin/env python3
+
+import logik
+
+logik.main()

logik/__init__.py

@@ -0,0 +1,54 @@
+from . evaluator import *
+
+"""
+Module : Logik
+
+Description :
+
+Logik provide a simple way to manipulate propositionnal logic in python !
+
+Author : Arthur Correnson
+Email  : [email protected]
+
+-------------------------------------------------------------------------------
+
+This software may be freely distributed under the MIT license :
+
+
+MIT License
+
+Copyright (c) 2019 Arthur Correnson
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.
+"""
+
+# Main function
+def main():
+    while True:
+        # input
+        string = input('>>> ')
+        # lexing
+        tokens = lex(string)
+        # parsing
+        seq = Seq(list(tokens))
+        ast = parse(seq)
+        # display the AST
+        print('\nSyntax tree :\n')
+        pprint(ast)
+        evaluate_all(ast)

evaluator.py renamed to logik/evaluator.py

@@ -1,4 +1,4 @@
-from parser import *
+from . parser import *
 from itertools import product
 
 
@@ -76,17 +76,4 @@ def evaluate_all(ast):
         print(evaluate(ast, {}))
 
 
-if __name__ == '__main__':
-    # input
-    string = input('>>> ')
-    # lexing
-    tokens = lex(string)
-    # parsing
-    seq = Seq(list(tokens))
-    ast = parse(seq)
-    # display the AST
-    print('\nSyntax tree :\n')
-    pprint(ast)
-    evaluate_all(ast)
-
 

lexer.py renamed to logik/lexer.py

@@ -1,6 +1,11 @@
 import re
 
 def lex(seq):
+    """
+        An iterator that extract all tokens from an input string.
+
+        seq -- the sequence of character to lex (string)
+    """
     l = len(seq)
 
     while l > 0:
@@ -40,6 +45,7 @@ def lex(seq):
 
 
 def pprint(token):
+    """Pretty print a token"""
     print('\033[31m'
         + token[0]
         + "\033[0m"

parser.py renamed to logik/parser.py

@@ -1,4 +1,4 @@
-from lexer import *
+from . lexer import *
 
 
 def priority(char):

setup.py

@@ -0,0 +1,12 @@
+from setuptools import setup
+
+setup(name='logik',
+      version='0.1',
+      description='A simple way to interact with propositional logic in python',
+      url='https://github.com/64bit-lab/Logik',
+      author='Arthur Correnson',
+      author_email='[email protected]',
+      license='MIT',
+      packages=['logik'],
+      scripts=['bin/logik'],
+      zip_safe=False)