Merge pull request #49 from ninezerozeronine/develop

Adding tox and coverage
ninezerozeronine · May 20, 2019 · 41e1d55 · 41e1d55
2 parents b25bc80 + aa6dfe8
commit 41e1d55
Show file tree

Hide file tree

Showing 390 changed files with 112 additions and 43,545 deletions.
diff --git a/.gitignore b/.gitignore
@@ -1,5 +1,9 @@
-sphinx_docs/_build
+docs/_build
 *.pyc
-src/python/.pytest_cache
-src/python/.coverage
-src/python/cov_html
+build
+dist
+src/*.egg-info
+.tox
+.coverage
+htmlcov
+*__pycache__
diff --git a/.travis.yml b/.travis.yml
@@ -0,0 +1,12 @@
+language: python
+
+python:
+  - "2.7"
+
+install:
+- pip install tox-travis
+- pip install coverage
+- pip install coveralls
+
+script:
+  - tox -e travis
diff --git a/LICENSE b/LICENSE
@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2018 Andy Palmer
+Copyright (c) 2018-2019 Andy Palmer
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

diff --git a/README.md b/README.md
@@ -1,44 +1,47 @@
 # 8 bit Computer
 
-This is a project to make a basic but fully functional 8 bit computer 
-using 7400 series ICs.
+[![Documentation Status](https://readthedocs.org/projects/eight-bit-computer/badge/?version=master)](https://eight-bit-computer.readthedocs.io/en/master/?badge=master)
 
-The full docs can be found on the GitHub Pages pages for this
-project: https://ninezerozeronine.github.io/eight_bit_computer/
+[![Coverage Status](https://coveralls.io/repos/github/ninezerozeronine/eight-bit-computer/badge.svg?branch=master)](https://coveralls.io/github/ninezerozeronine/eight-bit-computer?branch=master)
 
-# License
+This is a project to make a basic but fully functional 8 bit computer 
+using 7400 series ICs.
 
-The content of this project itself is licensed under the [Creative Commons Attribution 3.0 license](http://creativecommons.org/licenses/by/3.0/us/deed.en_US), 
-and any code used is licensed under the [MIT license](http://opensource.org/licenses/mit-license.php).
+The full docs can be found on the Read the Docs: https://eight-bit-computer.readthedocs.io/
 
 # Docs
 
 To build the docs on mac run:
 
-    sphinx-apidoc --force --separate --no-toc -o software/source/ ../src/python/eight_bit_computer/
     make clean
     make html
 
-in `sphinx_docs`.
+in `docs`.
 
 To build the docs in windows run:
 
-    sphinx-apidoc --force --separate --no-toc -o software/source/ ../src/python/eight_bit_computer/
     sphinx-build.exe . _build
 
-in `sphinx_docs`.
-
-Then copy `sphinx_docs/_build/html/*` into `docs` so that github pages can see them.
+in `docs`.
 
 # Tests
 
 To run the tests, run:
 
-    python -B -m pytest
+    tox -e test
 
-in `src/python`
+in the root directory.
 
 To generate a coverage report run:
 
-    python -B -m pytest --cov=eight_bit_computer --cov-report=html:cov_html tests
+    tox -e cov
+
+in the root directory.
+
+# License
 
+The content of this project itself is licensed under the
+[Attribution-ShareAlike 4.0 International
+license](http://creativecommons.org/licenses/by-sa/4.0/), and any source code used
+in conjunction with the project is licensed under the [MIT
+license](http://opensource.org/licenses/mit-license.php).
diff --git a/src/python/csv_to_html_table.py → dev_helpers/csv_to_html_table.py b/src/python/csv_to_html_table.py → dev_helpers/csv_to_html_table.py
diff --git a/src/python/sandbox.py → dev_helpers/sandbox.py b/src/python/sandbox.py → dev_helpers/sandbox.py
diff --git a/docs/.buildinfo b/docs/.buildinfo
diff --git a/docs/.doctrees/credits.doctree b/docs/.doctrees/credits.doctree
diff --git a/docs/.doctrees/development_tools.doctree b/docs/.doctrees/development_tools.doctree
diff --git a/docs/.doctrees/environment.pickle b/docs/.doctrees/environment.pickle
diff --git a/docs/.doctrees/hardware/debouncing.doctree b/docs/.doctrees/hardware/debouncing.doctree
diff --git a/docs/.doctrees/hardware/edge_detection.doctree b/docs/.doctrees/hardware/edge_detection.doctree
diff --git a/docs/.doctrees/hardware/eeprom_programmer.doctree b/docs/.doctrees/hardware/eeprom_programmer.doctree
diff --git a/docs/.doctrees/hardware/fanout.doctree b/docs/.doctrees/hardware/fanout.doctree
diff --git a/docs/.doctrees/hardware/hct_vs_ls.doctree b/docs/.doctrees/hardware/hct_vs_ls.doctree
diff --git a/docs/.doctrees/hardware/index.doctree b/docs/.doctrees/hardware/index.doctree
diff --git a/docs/.doctrees/hardware/materials_and_tools.doctree b/docs/.doctrees/hardware/materials_and_tools.doctree
diff --git a/docs/.doctrees/hardware/open_collector.doctree b/docs/.doctrees/hardware/open_collector.doctree
diff --git a/docs/.doctrees/hardware/safe_clock_enable.doctree b/docs/.doctrees/hardware/safe_clock_enable.doctree
diff --git a/docs/.doctrees/index.doctree b/docs/.doctrees/index.doctree
diff --git a/docs/.doctrees/language/assembly.doctree b/docs/.doctrees/language/assembly.doctree
diff --git a/docs/.doctrees/language/index.doctree b/docs/.doctrees/language/index.doctree
diff --git a/docs/.doctrees/language/machine_code.doctree b/docs/.doctrees/language/machine_code.doctree
diff --git a/docs/.doctrees/language/micro_code.doctree b/docs/.doctrees/language/micro_code.doctree
diff --git a/docs/.doctrees/modules/alu.doctree b/docs/.doctrees/modules/alu.doctree
diff --git a/docs/.doctrees/modules/clock.doctree b/docs/.doctrees/modules/clock.doctree
diff --git a/docs/.doctrees/modules/control_unit.doctree b/docs/.doctrees/modules/control_unit.doctree
diff --git a/docs/.doctrees/modules/index.doctree b/docs/.doctrees/modules/index.doctree
diff --git a/docs/.doctrees/modules/program_counter.doctree b/docs/.doctrees/modules/program_counter.doctree
diff --git a/docs/.doctrees/modules/ram.doctree b/docs/.doctrees/modules/ram.doctree
diff --git a/docs/.doctrees/modules/register.doctree b/docs/.doctrees/modules/register.doctree
diff --git a/docs/.doctrees/modules/two_to_one.doctree b/docs/.doctrees/modules/two_to_one.doctree
diff --git a/docs/.doctrees/overview.doctree b/docs/.doctrees/overview.doctree
diff --git a/docs/.doctrees/software/assembler.doctree b/docs/.doctrees/software/assembler.doctree
diff --git a/docs/.doctrees/software/index.doctree b/docs/.doctrees/software/index.doctree
diff --git a/docs/.doctrees/software/source/eight_bit_computer.assembler.doctree b/docs/.doctrees/software/source/eight_bit_computer.assembler.doctree
diff --git a/docs/.doctrees/software/source/eight_bit_computer.assembly_summary.doctree b/docs/.doctrees/software/source/eight_bit_computer.assembly_summary.doctree
diff --git a/docs/.doctrees/software/source/eight_bit_computer.assembly_validity.doctree b/docs/.doctrees/software/source/eight_bit_computer.assembly_validity.doctree
diff --git a/docs/.doctrees/software/source/eight_bit_computer.bitdef.doctree b/docs/.doctrees/software/source/eight_bit_computer.bitdef.doctree
diff --git a/docs/.doctrees/software/source/eight_bit_computer.data_structures.doctree b/docs/.doctrees/software/source/eight_bit_computer.data_structures.doctree
diff --git a/docs/.doctrees/software/source/eight_bit_computer.doctree b/docs/.doctrees/software/source/eight_bit_computer.doctree
diff --git a/docs/.doctrees/software/source/eight_bit_computer.exceptions.doctree b/docs/.doctrees/software/source/eight_bit_computer.exceptions.doctree
diff --git a/docs/.doctrees/software/source/eight_bit_computer.export.doctree b/docs/.doctrees/software/source/eight_bit_computer.export.doctree
diff --git a/docs/.doctrees/software/source/eight_bit_computer.language_defs.doctree b/docs/.doctrees/software/source/eight_bit_computer.language_defs.doctree
diff --git a/docs/.doctrees/software/source/eight_bit_computer.main.doctree b/docs/.doctrees/software/source/eight_bit_computer.main.doctree
diff --git a/docs/.doctrees/software/source/eight_bit_computer.number_utils.doctree b/docs/.doctrees/software/source/eight_bit_computer.number_utils.doctree
diff --git a/docs/.doctrees/software/source/eight_bit_computer.operation_utils.doctree b/docs/.doctrees/software/source/eight_bit_computer.operation_utils.doctree
diff --git a/docs/.doctrees/software/source/eight_bit_computer.operations.copy_op.doctree b/docs/.doctrees/software/source/eight_bit_computer.operations.copy_op.doctree
diff --git a/docs/.doctrees/software/source/eight_bit_computer.operations.doctree b/docs/.doctrees/software/source/eight_bit_computer.operations.doctree
diff --git a/docs/.doctrees/software/source/eight_bit_computer.operations.fetch.doctree b/docs/.doctrees/software/source/eight_bit_computer.operations.fetch.doctree
diff --git a/docs/.doctrees/software/source/eight_bit_computer.operations.load.doctree b/docs/.doctrees/software/source/eight_bit_computer.operations.load.doctree
diff --git a/docs/.doctrees/software/source/eight_bit_computer.operations.operation_template.doctree b/docs/.doctrees/software/source/eight_bit_computer.operations.operation_template.doctree
diff --git a/docs/.doctrees/software/source/eight_bit_computer.operations.set_op.doctree b/docs/.doctrees/software/source/eight_bit_computer.operations.set_op.doctree
diff --git a/docs/.doctrees/software/source/eight_bit_computer.rom.doctree b/docs/.doctrees/software/source/eight_bit_computer.rom.doctree
diff --git a/docs/.doctrees/software/source/eight_bit_computer.token_utils.doctree b/docs/.doctrees/software/source/eight_bit_computer.token_utils.doctree
diff --git a/docs/.doctrees/usage.doctree b/docs/.doctrees/usage.doctree
diff --git a/docs/.nojekyll b/docs/.nojekyll
diff --git a/sphinx_docs/Makefile → docs/Makefile b/sphinx_docs/Makefile → docs/Makefile
diff --git a/docs/_downloads/4cd40d388b67c3f0809f4b3bd4d2124f/language_table.csv b/docs/_downloads/4cd40d388b67c3f0809f4b3bd4d2124f/language_table.csv
diff --git a/docs/_modules/eight_bit_computer/assembler.html b/docs/_modules/eight_bit_computer/assembler.html
diff --git a/docs/_modules/eight_bit_computer/assembly_summary.html b/docs/_modules/eight_bit_computer/assembly_summary.html
diff --git a/docs/_modules/eight_bit_computer/assembly_validity.html b/docs/_modules/eight_bit_computer/assembly_validity.html