diff --git a/.nojekyll b/.nojekyll new file mode 100644 index 00000000..e69de29b diff --git a/404.html b/404.html new file mode 100644 index 00000000..3bf22364 --- /dev/null +++ b/404.html @@ -0,0 +1,807 @@ + + + +
+ + + + + + + + + + + + + + + + + + +All types of contributions are welcome. You can:
+The best way to get your issue solved is to provide a minimal, complete, verifiable example. In order to submit a bug report, click here and fill out the template.
+The following seems to be the easiest way to debug internals:
+from stata_kernel.kernel import StataKernel
+from stata_kernel.code_manager import CodeManager
+
+kernel = StataKernel()
+session = kernel.stata
+
+# If on windows, may be helpful
+session.show_gui()
+
+code = 'sysuse auto, clear'
+cm = CodeManager(code)
+text_to_run, md5, text_to_exclude = cm.get_text(kernel.conf, session)
+rc, res = session.do(
+ text_to_run, md5, text_to_exclude=text_to_exclude, display=False)
+
Tests are contained in the Python files in the tests/
folder. The test_stata_lexer.py
and test_mata_lexer.py
files run automated tests on the code Stata kernel uses to parse user input.
To run the tests, you need to install pytest
and jupyter_kernel_test
:
+
pip install pytest jupyter_kernel_test
+
From the project root, to run all tests, run
+pytest tests/
+
To run just the non-automated tests that depend on having Stata available locally, run
+pytest tests/test_kernel.py
+
For each of the above, if you get a ModuleNotFound
error, you may need to use python -m pytest tests/
.
First install mkdocs
:
pip install mkdocs mkdocs-material
+
Then cd
to the docs folder:
+
cd docs/
+
Then to serve the documentation website in real time, run +
mkdocs serve
+
localhost:8000
, click Enter, and you should see the website. This will update in real time as you write more documentation.
+To create a static website, run: +
mkdocs build
+
To publish the website to the documentation website (if you have repository push access) run: +
mkdocs gh-deploy
+
To increment version numbers, run one of: +
bumpversion major
+bumpversion minor
+bumpversion patch
+
git push origin master --tags
+
so that Github sees the newest tag.
+Then to release:
+python setup.py sdist bdist_wheel
+python -m twine upload dist/stata_kernel-VERSION*
+
As an ardent open-source advocate and someone who actively dislikes using Stata, +it somewhat pains me that my work creates value for a proprietary, closed-source +program. I hope that this program improves research in a utilitarian way, and +shows to new users the scope of the open-source tools that have existed for +upwards of a decade.
+{"use strict";/*!
+ * escape-html
+ * Copyright(c) 2012-2013 TJ Holowaychuk
+ * Copyright(c) 2015 Andreas Lubbe
+ * Copyright(c) 2015 Tiancheng "Timothy" Gu
+ * MIT Licensed
+ */var Va=/["'&<>]/;qn.exports=za;function za(e){var t=""+e,r=Va.exec(t);if(!r)return t;var o,n="",i=0,s=0;for(i=r.index;i