Add basic functionality

[gabriel-duque]

I just pushed some commits to start the project.

I basically added a skeleton we can build on.

In the source code I:

• added some logging, warning and error handling functions
• wrote a function to read assets (our words) in from different files
• parsed command line options so we can specify a file for the grammar and a file for assets
• added empty functions to do the rest

Everything seems to be fine for now!

This is a draft pull request so we shouldn't set it as mergeable untill it works well.

[gabriel-duque]

CHANGELOG:

• python classes now
• -v flag to turn on verbose
• initial test suite

[bandang0]

Hi dude, Thanks for kicking off our project!

I just have a couple of questions:

Technical questions:

• On aamg/generator.py: we have this line:

  self.grammar: typing.Dict[str, str] = dict()

Should it be typing.Dict[str, typing.List[str]]?

• On tests/lexer_test.py: are there some \n missing in file_content?

General questions:

• On ASSETS and GRAMMAR: I think the end user will not use these particular grammars and asset files, and we may use others to illustrate the functioning of the project. So what do you say we have examples/grammars and examples/assets folders with these grammar and assets files (and others!)? Eventually, we could also put grammars and assets for tests in there.

• On README.md: I like the CHANGELOG you put in the thread up there, what do you say we have a CHANGELOG entry in the README, or a separate CHANGES.md file that we update every PR with significant improvements?

• On setup.py and tests/: first of all this mock interface is awesome, and I'm not used to testing (bad gollum!) but I'd like to get used to testing in this manner. Unfortunately, when you run python3 setup.py test (with Setuptools 45.2.0 and Python 3.8.1), you get:

running test WARNING: Testing via this command is deprecated and will be removed in a future version. Users looking for a generic test entry point independent of test runner are encouraged to use tox.

As discussed in this issue of setuptools, the test command will be deprecated in further versions. Should we find some other handle for the tests (now or later)?

Apart from the technical questions, I'm ready to rebase & merge this and address the general questions in later changes.

[gabriel-duque]

I just applied your fixes.