add doc and change version in setup.py

docs/tutorial.mdwn

@@ -0,0 +1,152 @@
+# Utilisation de pyMath
+
+## À quoi sert pyMath?
+
+pyMath est un module python qui permet la manipulation d'expressions mathématiques. Voici ce qu'il est capable de faire:
+
+* *Calculer comme un collégien*: Pour faire de la correction automatisé d'exercice, un logiciel de calcul formel ne suffit pas. Si les étapes de calculs ne sont pas présentes, l'élève ne pourra pas analyser ses erreurs ou s'inspirer de la correction.
+
+* *Créer des exercices aléatoirement*: Pour faire des devoirs personnels, des fiches de révisions ou des exercices en classe, un générateur d'expressions est inclus.
+
+* *Différents type de données*: Pour le moment, pyMath est capable de gérer les entiers naturels et les rationnels (sous forme de fractions). L'utilisation des nombres à virgules, des racines et des polynômes devraient être ajouter dans les prochaines versions.
+
+* *Deux types de rendus*: Un en mode texte pour l'affichage dans une console. Un deuxième spécialement pour écrire des documents latex.
+
+Ce module a pour but d'être un outil pour faciliter la construction d'exercices et leurs correction. Il a pour but d'être le plus simple possible d'utilisation afin que tout le monde avec un minimum de connaissance en programmation puisse créer librement des exercices. 
+
+## Calculer comme un collégien.
+
+Actuellement le module pour faire calculer python comme un collégien est *pymath.expression*.
+
+    >>> from pymath.expression import Expression
+
+Un expression peut être initialisée de deux façons différentes: à partir d'une chaine de caractère ou à partir de la liste des termes.
+
+    >>> exp = Expression("1 + 2 * 3")
+    >>> exp = Expression([1, "+", 2, "*", 3])
+
+On peut ensuite afficher l'expression avec un *print* (pour un rendu en mode texte).
+
+    >>> print(exp)
+    1 + 2 * 3
+
+Et si l'on souhaite un rendu en latex:
+
+    >>> from pymath.renders import tex_render
+    >>> exp.render(render = tex_render)
+    1 + 2 \times 3
+
+### Simplification des expressions
+Une fois les expressions créées, elles peuvent se réduire en expliquant les étapes et en respectant les règles de priorités. Les exemples suivants seront données avec un rendu texte.
+
+    >>> from pymath.renders import txt_render
+    >>> exp = Expression("1 + 2 * 3")
+    >>> for i in exp.simplify(render = txt_render):
+    ...     print(i)
+    ... 
+    1 + 2 * 3
+    1 + 6
+    7
+        
+
+Les opérations autorisées sont les opérations "classique": + - * / ^. L'utilisation des parenthèses est aussi gérée.
+
+    >>> exp = Expression("1 + 2 / 5")
+    >>> for i in exp.simplify(render = txt_render):
+    ...     print(i)
+    ... 
+    1 + 2 / 5
+    ( 1 * 5 ) / ( 1 * 5 ) + ( 2 * 1 ) / ( 5 * 1 )
+    ( 5 + 2 ) / 5
+    7 / 5
+
+    >>> exp = Expression("(2 + 4)(3 - 4 * 2)")
+    >>> for i in exp.simplify(render = txt_render):
+    ...     print(i)
+    ... 
+    ( 2 + 4 ) ( 3 - ( 4 * 2 ) )
+    6 * ( 3 - 8 )
+    6 * ( -5 )
+    -30
+
+### Différents rendus
+Comme dit dans l'introduction, il y a deux types de rendus: un rendus texte (utilisé depuis le début) et un rendus latex. Voici un exemple de l'utilisation du rendu latex
+
+    >>> from pymath.renders import txt_render
+    >>> exp = Expression("1 + 2 / 5")
+    >>> for i in exp.simplify(render = tex_render):
+    ...     print(i)
+    ... 
+    ( 2  +  4 ) ( 3  -  ( 4 \times 2 ) )
+    6 \times ( 3  -  8 )
+    6 \times ( -5 )
+    -30
+
+## Générer des expressions aléatoirement.
+
+Le module qui permet de générer des expressions aléatoirement est *pymath.random_expression*
+
+    >>> from pymath.random_expression import RdExpression
+
+### Créer un expression
+Pour créer une expression il faut au moins une chose: la forme de l'expression. Toutes les lettres entre accolades seront remplacées par des valeurs aléatoires (par défaut entre -10 et 10 et non nulles).
+
+    >>> form = "2* {a} + 3"
+    >>> rd_exp = RdExpression(form)
+    >>> rd_exp()
+    '2 \\times 9  +  3'
+    >>> rd_exp(30, 40)
+    '2 \\times 31  +  3'
+
+On remarque que ici le rendu est directement en latex (je ne sais d'ailleurs pas si c'est une très bonne idée que le rendu par défaut ne soit pas le même qu'avec expression...).
+
+### Créer une expression avec conditions
+Parfois il peut être nécessaire d'imposer des conditions sur les éléments à générer pour créer des exercices spécifiques.
+
+    >>> form = "{a} / {b} + {c} / {d}"
+    >>> cond = ["abs({b}) != 1", "{d} > 1", "{b} != {d}", "gcd({a},{b}) == 1", "gcd({c},{d}) == 1"]
+    >>> rd_frac_add = RdExpression(form, cond)
+    >>> rd_frac_add()
+    '\\frac{ 4 }{ 5 }  +  \\frac{ 9 }{ 7 }'
+
+La méthode pour créer les valeurs avec des conditions est la méthode par rejet. Elle n'est pas très efficace et rien n'est encore prévu dans le cas où aucune valeur n'est possible. 
+
+### Opérations avec les valeurs générées
+Pour éviter de faire tourner la méthode par rejet trop longtemps, il est possible de faire des calculs avec les valeurs générées.
+
+    >>> form = "{a} / {b} + {c} / {k*b}"
+    >>> cond = ["abs({b}) != 1", "{d} > 1", "{b} != {d}", "gcd({a},{b}) == 1", "gcd({c},{k*b}) == 1"]
+    >>> rd_frac_add = RdExpression(form, cond)
+    >>> rd_frac_add()
+    '\\frac{ -9 }{ 7 }  +  \\frac{ 1 }{ 28 }
+
+### Rendu des expressions
+Le rendu des expressions se fait avec la classe Expression présentée plus haut. C'est pratique car cela permet de profiter des rendus automatiques en latex. Mais cela ne permet par de réutiliser facilement l'expression (pour une correction par exemple) et cela gène quand on veut utiliser des choses que Expression ne sait pas gérer.
+
+    >>> form = "{a} / {b} + {c} / {k*b}"
+    >>> cond = ["abs({b}) != 1", "{d} > 1", "{b} != {d}", "gcd({a},{b}) == 1", "gcd({c},{k*b}) == 1"]
+    >>> rd_frac_add = RdExpression(form, cond)
+    >>> exp = rd_frac_add.raw_exp()
+    >>> print(exp)
+    -2 / 5 + -8 / 35
+    >>> for i in exp.simplify(render = txt_render):
+    ...     print(i)
+    ... 
+    -2 / 5 + -8 / 35
+    -2 / 5 + ( -8 / 35 )
+    ( -2 * 7 ) / ( 5 * 7 ) + ( -8 * 1 ) / ( 35 * 1 )
+    ( -14 + ( -8 ) ) / 35
+    -22 / 35
+    
+    >>> form = "{a**2}x^2 + {2*a*b} x + {b**2}"
+    >>> rd_id_rmq = RdExpression(form, with_Exp = False)
+    >>> rd_id_rmq()
+    '100x^2 + -180 x + 81'
+    >>> rd_id_rmq()
+    '49x^2 + 42 x + 9'
+
+On remarque le défaut d'utiliser *with_Exp* le rendu est moins bien fait (dans l'exemple, il n'y a pas de parenthèses autour du -180).
+
+
+
+ 

setup.py

@@ -3,7 +3,7 @@
 from distutils.core import setup
 
 setup(name='pyMath',
-      version='0.1dev',
+      version='0.2',
       description='Computing like a student',
       author='Benjamin Bertrand',
       author_email='lafrite@poneyworld.net',