Merge pull request #35 from letuananh/main

jamdict 0.1a10 with memory_mode

.gitignore

@@ -1,91 +1,93 @@
-*.py~
-*.sh~
-# Byte-compiled / optimized / DLL files
-__pycache__/
-*.py[cod]
-*$py.class
-
-# C extensions
-*.so
-
-# Distribution / packaging
-.Python
-env/
-build/
-develop-eggs/
-dist/
-downloads/
-eggs/
-.eggs/
-lib/
-lib64/
-parts/
-sdist/
-var/
-*.egg-info/
-.installed.cfg
-*.egg
-
-# PyInstaller
-#  Usually these files are written by a python script from a template
-#  before PyInstaller builds the exe, so as to inject date/other infos into it.
-*.manifest
-*.spec
-
-# Installer logs
-pip-log.txt
-pip-delete-this-directory.txt
-
-# Unit test / coverage reports
-htmlcov/
-.tox/
-.coverage
-.coverage.*
-.cache
-nosetests.xml
-coverage.xml
-*,cover
-.hypothesis/
-
-# Translations
-*.mo
-*.pot
-
-# Django stuff:
-*.log
-local_settings.py
-
-# Flask stuff:
-instance/
-.webassets-cache
-
-# Scrapy stuff:
-.scrapy
-
-# Sphinx documentation
-docs/_build/
-
-# PyBuilder
-target/
-
-# IPython Notebook
-.ipynb_checkpoints
-
-# pyenv
-.python-version
-
-# celery beat schedule file
-celerybeat-schedule
-
-# dotenv
-.env
-
-# virtualenv
-venv/
-ENV/
-
-# Spyder project settings
-.spyderproject
-
-# Rope project settings
-.ropeproject
+.idea/
+test/data/test.db
+*.py~
+*.sh~
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[cod]
+*$py.class
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+env/
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+*.egg-info/
+.installed.cfg
+*.egg
+
+# PyInstaller
+#  Usually these files are written by a python script from a template
+#  before PyInstaller builds the exe, so as to inject date/other infos into it.
+*.manifest
+*.spec
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*,cover
+.hypothesis/
+
+# Translations
+*.mo
+*.pot
+
+# Django stuff:
+*.log
+local_settings.py
+
+# Flask stuff:
+instance/
+.webassets-cache
+
+# Scrapy stuff:
+.scrapy
+
+# Sphinx documentation
+docs/_build/
+
+# PyBuilder
+target/
+
+# IPython Notebook
+.ipynb_checkpoints
+
+# pyenv
+.python-version
+
+# celery beat schedule file
+celerybeat-schedule
+
+# dotenv
+.env
+
+# virtualenv
+venv/
+ENV/
+
+# Spyder project settings
+.spyderproject
+
+# Rope project settings
+.ropeproject

README.md

@@ -22,7 +22,9 @@ Homepage: [https://github.com/neocl/jamdict](https://github.com/neocl/jamdict)
 
 # Try Jamdict out
 
-There is a demo Jamdict virtual machine to try out on the web on Repl.it: https://replit.com/@tuananhle/jamdict-demo
+There is a demo Jamdict virtual machine to try out online on Repl.it:
+
+https://replit.com/@tuananhle/jamdict-demo
 
 # Installation
 
@@ -188,6 +190,7 @@ See `jamdict_demo.py` and `jamdict/tools.py` for more information.
 # Contributors
 
 - [Le Tuan Anh](https://github.com/letuananh) (Maintainer)
+- [alt-romes](https://github.com/alt-romes)
 - [Matteo Fumagalli](https://github.com/matteofumagalli1275)
 - [Reem Alghamdi](https://github.com/reem-codes)
-- [alt-romes](https://github.com/alt-romes)
+- [Techno-coder](https://github.com/Techno-coder) 

docs/Makefile

@@ -12,6 +12,9 @@ BUILDDIR      = _build
 help:
 	@$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
 
+serve:
+	cd _build/dirhtml && python -m http.server 7001
+
 .PHONY: help Makefile
 
 # Catch-all target: route all unknown targets to Sphinx using the new

docs/index.rst

@@ -140,9 +140,10 @@ Contributors
 ------------
 
 -  `Le Tuan Anh <https://github.com/letuananh>`__ (Maintainer)
+-  `alt-romes <https://github.com/alt-romes>`__
 -  `Matteo Fumagalli <https://github.com/matteofumagalli1275>`__
 -  `Reem Alghamdi <https://github.com/reem-codes>`__
--  `alt-romes <https://github.com/alt-romes>`__
+-  `Techno-coder <https://github.com/Techno-coder>`__
 
 Useful links
 ------------

docs/recipes.rst

@@ -16,6 +16,19 @@ All code here assumed that you have created a Jamdict object named :samp:`jam`,
     >>> from jamdict import Jamdict
     >>> jam = Jamdict()
 
+High-performance tuning
+-----------------------
+
+When you need to do a lot of queries on the database, it is possible to load the whole database
+into memory to boost up querying performance (This will takes about 400 MB of RAM) by using the ``memory_mode``
+keyword argument, like this:
+
+>>> from jamdict import Jamdict
+>>> jam = Jamdict(memory_mode=True)
+
+The first query will be extremely slow (it may take about a minute for the whole database to be loaded into memory)
+but subsequent queries will be much faster.
+
 Kanjis and radical/components (KRAD/RADK mappings)
 --------------------------------------------------
 

docs/tutorials.rst

@@ -4,7 +4,7 @@ Tutorials
 Getting started
 ---------------
 
-Just install :keyword:`jamdict` and :keyword:`jamdict_data` packages via pip and you are ready to go.
+Just install ``jamdict`` and ``jamdict_data`` packages via pip and you are ready to go.
 
 .. code:: python
 

jamdict/__init__.py

@@ -1,59 +1,55 @@
-# -*- coding: utf-8 -*-
-
-'''
-Python library for manipulating Jim Breen's JMdict and KanjiDic2
-Latest version can be found at https://github.com/neocl/jamdict
-
-This package uses the [EDICT][1] and [KANJIDIC][2] dictionary files.
-These files are the property of the [Electronic Dictionary Research and Development Group][3], and are used in conformance with the Group's [licence][4].
-
-[1]: http://www.csse.monash.edu.au/~jwb/edict.html
-[2]: http://www.csse.monash.edu.au/~jwb/kanjidic.html
-[3]: http://www.edrdg.org/
-[4]: http://www.edrdg.org/edrdg/licence.html
-
-References:
-    JMDict website:
-        http://www.csse.monash.edu.au/~jwb/edict.html
-    Python documentation:
-        https://docs.python.org/
-    PEP 257 - Python Docstring Conventions:
-        https://www.python.org/dev/peps/pep-0257/
-
-@author: Le Tuan Anh <[email protected]>
-@license: MIT
-'''
-
-# Copyright (c) 2016, Le Tuan Anh <[email protected]>
-#
-# Permission is hereby granted, free of charge, to any person obtaining a copy
-# of this software and associated documentation files (the "Software"), to deal
-# in the Software without restriction, including without limitation the rights
-# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-# copies of the Software, and to permit persons to whom the Software is
-# furnished to do so, subject to the following conditions:
-#
-# The above copyright notice and this permission notice shall be included in
-# all copies or substantial portions of the Software.
-#
-# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
-# THE SOFTWARE.
-
-########################################################################
-
-from . import __version__ as version_info
-from .__version__ import __author__, __email__, __copyright__, __maintainer__
-from .__version__ import __credits__, __license__, __description__, __url__
-from .__version__ import __version_major__, __version_long__, __version__, __status__
-
-from .jmdict_sqlite import JMDictSQLite
-from .kanjidic2_sqlite import KanjiDic2SQLite
-from .util import Jamdict, JMDictXML, KanjiDic2XML
-from .krad import KRad
-__all__ = ['Jamdict', 'JMDictSQLite', 'JMDictXML', 'KanjiDic2SQLite', 'KanjiDic2XML', 'KRad',
-           "__version__", "__author__", "__description__", "__copyright__", "version_info"]
+# -*- coding: utf-8 -*-
+
+'''
+Python library for manipulating Jim Breen's JMdict and KanjiDic2
+Latest version can be found at https://github.com/neocl/jamdict
+
+This package uses the [EDICT][1] and [KANJIDIC][2] dictionary files.
+These files are the property of the [Electronic Dictionary Research and Development Group][3], and are used in conformance with the Group's [licence][4].
+
+[1]: http://www.csse.monash.edu.au/~jwb/edict.html
+[2]: http://www.csse.monash.edu.au/~jwb/kanjidic.html
+[3]: http://www.edrdg.org/
+[4]: http://www.edrdg.org/edrdg/licence.html
+
+References:
+    JMDict website:
+        http://www.csse.monash.edu.au/~jwb/edict.html
+
+@author: Le Tuan Anh <[email protected]>
+@license: MIT
+'''
+
+# Copyright (c) 2016, Le Tuan Anh <[email protected]>
+#
+# Permission is hereby granted, free of charge, to any person obtaining a copy
+# of this software and associated documentation files (the "Software"), to deal
+# in the Software without restriction, including without limitation the rights
+# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+# copies of the Software, and to permit persons to whom the Software is
+# furnished to do so, subject to the following conditions:
+#
+# The above copyright notice and this permission notice shall be included in
+# all copies or substantial portions of the Software.
+#
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+# THE SOFTWARE.
+
+########################################################################
+
+from . import __version__ as version_info
+from .__version__ import __author__, __email__, __copyright__, __maintainer__
+from .__version__ import __credits__, __license__, __description__, __url__
+from .__version__ import __version_major__, __version_long__, __version__, __status__
+
+from .jmdict_sqlite import JMDictSQLite
+from .kanjidic2_sqlite import KanjiDic2SQLite
+from .util import Jamdict, JMDictXML, KanjiDic2XML
+from .krad import KRad
+__all__ = ['Jamdict', 'JMDictSQLite', 'JMDictXML', 'KanjiDic2SQLite', 'KanjiDic2XML', 'KRad',
+           "__version__", "__author__", "__description__", "__copyright__", "version_info"]

jamdict/__version__.py

@@ -10,6 +10,6 @@
 __url__ = "https://github.com/neocl/jamdict"
 __maintainer__ = "Le Tuan Anh"
 __version_major__ = "0.1"
-__version__ = "{}a9".format(__version_major__)
-__version_long__ = "{} - Alpha".format(__version_major__)
+__version__ = "{}a10.post2".format(__version_major__)
+__version_long__ = "{} - Alpha - Post 002".format(__version_major__)
 __status__ = "Prototype"