This is an alpha release of dcodex: a software framework for manuscript analysis.
Some documentation is available at https://www.dcodex.net. More documentation to come. For now, contact me to get a pre-publication version of my PhD thesis where I go into detail regarding the design of the software and each of the components.
At the time of writing, dcodex must be run on Python 3.8 or 3.9, so make sure that you have one of these versions downloaded (https://www.python.org/downloads/) and installed on your machine. You also need to have poetry to build your dcodex project, so make sure that you have it downloaded (https://python-poetry.org/docs/) and installed on your machine.
For a brand new dcodex site, it is easiest to install using dcodex-cookiecutter. Once you have setup your dcodex project using the instructions laid out in that repo, enter the directory for your project. If your default version of Python is 3.10 or later, you must ensure that poetry is using a virtual environment running version 3.8 or 3.9:
poetry env use <path>/<to>/Python38/python
poetry env use <path>/<to>/Python39/python
Then install all dependencies for your dcodex project via
poetry install
If you are installing dcodex on Windows, you will need to have Microsoft Visual Studio and C++ Build Tools (https://visualstudio.microsoft.com/vs/) installed on your system.
If you are setting up a dcodex project with dcodex-cookiecutter, make sure you enter y for the windows option.
If your default version of Python is 3.10 or later, you must ensure that poetry is using a virtual environment running version 3.8 or 3.9:
poetry env use <path>\<to>\Python38\python.exe
poetry env use <path>\<to>\Python39\python.exe
(If you have the typical installation of Python under your user account, then the first part of this path should be C:\Users\<you>\AppData\Local\Programs\Python\.)
To install dcodex as a plugin in a Django site already set up. Install with pip:
pip install dcodex
Then add to your installed apps:
INSTALLED_APPS += [
# dcodex dependencies
"adminsortable2",
'easy_thumbnails',
'filer',
'mptt',
'imagedeck',
# dcodex apps
"dcodex",
]
Then add the urls to your main urls.py:
urlpatterns += [
path('dcodex/', include('dcodex.urls')),
]
The base dcodex app (i.e. this repository) is designed to be used with other apps to give the details for the types of manuscripts being used as well as the textual units. For example, see
There are other dcodex packages to extend the functionality of dcodex such as:
To run the tests use the following command:
./runtests.py
To check the coverage:
coverage run -m runtests
coverage report