Get ready for release 1.0.0

Author: rocky

AUTHORS.txt

@@ -7,31 +7,8 @@ Up until around  2017 was maintained by:
 - Angus Griffith @sn6uv
 - Ben Jones @bnjones
 
-Currently it is maintained by the Mathics Team
+The current module is maintained by the Mathics Team
 
-Additional contributions were made by:
-
-- Mingye Wang @Arthur2e5
-- Ali Abbas @alouche
-- Andrew Zhao @azhao12345
-- @Bth8
-- Chong Jiang @cjiang
-- Antonio Marquez-Raygoza @freshwater
-- @GitAnt
-- Josh Chen @jaycech3n
-- Yingjie Lan @lanyjie
-- @limeblack
-- Martin Portman @mportman
-- Mauricio Matera @mmatera
-- Marek Šuppa @mrshu
-- Marco Savelli @Piruzzolo
-- Toshiyuki Ogura @ogra
-- Bernhard Liebl @poke1024
-- @proxy-sander
-- Andrew Murray @radarhere
-- Jim Radford @radford
-- Timothy Cyrus @tcyrus
-- Wolf Vollprecht @wolfv
-- Сухарик @suhr
 - Pablo Emilio Escobar Gaviria @GarkGarcia
+- Mauricio Matera @mmatera
 - Rocky Bernstein @rocky

CHANGES.rst

@@ -4,7 +4,11 @@ CHANGES
 1.0.0
 -----
 
-The scanner split off from Mathics3
+The scanner split off from Mathics3.
 
+Tables added for converting between WL names and Unicode, ASCII and character properties.
+See implementation.rst for details
+
+Code and docstring gone over.
 
 See git in Mathics before Jan 18, 2021 for old history of these files.

COPYING.txt

@@ -1,45 +1,6 @@
-This file is about the copyright on Mathics and all included components. 
- 
-* ORIGINAL MATHICS CODE:
-
-  All original Mathics code is distributed under the terms of the 
-  GNU General Public License, version 3.
- 
-     This code is distributed in the hope that it will be useful,
-     but WITHOUT ANY WARRANTY; without even the implied warranty of
-     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
-     General Public License for more details.
- 
-The full text of the GPL is available below in this file. Details of
-the licenses of the components of Mathics are included below as well.
- 
-* LICENSES OF INCLUDED DATA:
-
-Mathics includes data from Wikipedia that is published under the Creative 
-Commons Attribution-Sharealike 3.0 Unported License and the GNU Free 
-Documentation License contributed by the respective authors that are listed 
-on the websites specified in "data/elements.txt".
-
-
-* LICENSES OF INCLUDED SOFTWARE:
- 
-SOFTWARE                           LICENSE
-----------------------------------------------
-scripaculous                       MIT
-Prototype                          MIT
-MathJax                            Apache 2.0
-Three.js                           MIT
-pymimemagic                        BSD 3-Clause
-SciPy                              BSD 3-Clause
- 
- 
-CONTACT INFO:
-     Jan Poeschko; [email protected]; 
-     https://mathics.org/
-
 =========================================================================
- 
- 
+
+
                     GNU GENERAL PUBLIC LICENSE
                        Version 3, 29 June 2007
 
@@ -714,7 +675,7 @@ may consider it more useful to permit linking proprietary applications with
 the library.  If this is what you want to do, use the GNU Lesser General
 Public License instead of this License.  But first, please read
 <http://www.gnu.org/philosophy/why-not-lgpl.html>.
- 
+
 ================================================================================
 
 scriptaculous:

Makefile

@@ -31,6 +31,10 @@ build: mathics_scanner/data/characters.json
 develop: mathics_scanner/data/characters.json
 	$(PIP) install -e .
 
+#: Build distribution
+dist: admin-tools/make-dist.sh
+	$(ShelL) admin-tools/make-dist.sh
+
 #: Install mathics
 install: build
 	$(PYTHON) setup.py install

README.rst

@@ -23,11 +23,17 @@ Usage
   ``mathics_scanner.tokenizer.Tokenizer`` class.
 - To convert between Wolfram Language named characters and Unicode/ASCII, use
   the ``mathics_scanner.characters.replace_wl_with_plain_text`` and
-  ``mathics_scanner.characters.replace_unicode_with_wl`` functions. 
+  ``mathics_scanner.characters.replace_unicode_with_wl`` functions.
 - To convert between qualified names of named characters (such ``FormalA`` for
   ``\[FormalA]``) and Wolfram's internal representation use the
   ``m̀athics_scanner.characters.named_characters`` dictionary.
 
+To regenerate scanner tables run:
+
+::
+
+   $ python -m mathics_scanner.generate
+
 Implementation
 --------------
 
@@ -46,4 +52,3 @@ License
 Mathics is released under the GNU General Public License Version 3 (GPL3).
 
 .. |Workflows| image:: https://github.com/Mathics3/mathics-scanner/workflows/Mathics%20(ubuntu)/badge.svg
-

admin-tools/make-dist.sh

@@ -1,3 +1,4 @@
+#!/bin/bash
 PACKAGE=mathics-scanner
 
 # FIXME put some of the below in a common routine

mathics_scanner/characters.py

@@ -1,4 +1,3 @@
-#!/usr/bin/env python3
 # -*- coding: utf-8 -*-
 
 import re
@@ -50,8 +49,8 @@ def replace_wl_with_plain_text(wl_input: str, use_unicode=True) -> str:
     Language named characters. This functions replaces all occurrences of such
     characters with their corresponding Unicode/ASCII equivalents.
 
-    @param: wl_input    The string whose characters will be replaced. 
-    @param: use_unicode A flag that indicates whether to use Unicode or ASCII 
+    @param: wl_input    The string whose characters will be replaced.
+    @param: use_unicode A flag that indicates whether to use Unicode or ASCII
                         for the conversion.
 
     Note that the occurrences of named characters in ``wl_input`` are expect to
@@ -73,7 +72,7 @@ def replace_unicode_with_wl(unicode_input: str) -> str:
     corresponding Unicode equivalents of such characters with the characters
     themselves.
 
-    @param: unicode_input The string whose characters will be replaced. 
+    @param: unicode_input The string whose characters will be replaced.
 
     Note that the occurrences of named characters in the output of
     ``replace_unicode_with_wl`` are represented using Wolfram's internal
@@ -85,4 +84,3 @@ def replace_unicode_with_wl(unicode_input: str) -> str:
     return _unicode_to_wl_re.sub(
         lambda m: _unicode_to_wl[m.group(0)], unicode_input
     )
-

mathics_scanner/prescanner.py

@@ -1,4 +1,3 @@
-#!/usr/bin/env python3
 # -*- coding: utf-8 -*-
 
 

mathics_scanner/tokeniser.py

@@ -1,4 +1,3 @@
-#!/usr/bin/env python3
 # -*- coding: utf-8 -*-
 
 
@@ -340,17 +339,17 @@ class Tokeniser(object):
     """
     A tokeniser for the Wolfram Language.
 
-    When subclassing ``Tokeniser``, custom tokenisation rules can be defined by 
-    declaring methods whose names are preceded by ``t_``, such as in the 
+    When subclassing ``Tokeniser``, custom tokenisation rules can be defined by
+    declaring methods whose names are preceded by ``t_``, such as in the
     following example: ::
 
         class MyTokeniser(Tokeniser):
             def t_MyWeirdRule(self, match):
                 # Your logic goes here...
                 pass
 
-    In this example, ``t_MyWeirdRule`` is supposed to update the internal state 
-    of the tokeniser and return a ``Token`` with an appropriate tag. ``m̀atch`` 
+    In this example, ``t_MyWeirdRule`` is supposed to update the internal state
+    of the tokeniser and return a ``Token`` with an appropriate tag. ``m̀atch``
     is expected to be an instance of ``re.Match``.
     """
     modes = {
@@ -516,4 +515,3 @@ def t_PutAppend(self, match):
     def t_Filename(self, match):
         "Filename rule"
         return self._token_mode(match, "Filename", "expr")
-

mathics_scanner/version.py

@@ -1,8 +1,7 @@
-#!/usr/bin/env python3
 # -*- coding: utf-8 -*-
 
 
 # This file is suitable for sourcing inside POSIX shell as
 # well as importing into Python. That's why there is no
 # space around "=" below.
-__version__="1.0.0.dev0"  # noqa
+__version__="1.0.0"  # noqa