nekroze/contextualize repository overview

⁠Contextualise: Manage Your Knowledge

Contextualise is a simple and flexible tool particularly suited for organising information-heavy projects and activities consisting of unstructured and widely diverse data and information resources -- think of investigative journalism, personal and professional research projects, world building_ (for books, movies or computer games) and many kinds of hobbies.

.. image:: resources/topic-view.png :alt: Contextualise's topic view

Contextualise's topic view

.. image:: resources/graph-view.png :alt: Contextualise's interactive network graph view (allowing for navigation between topics)

Contextualise's interactive network graph view (allowing for navigation between topics)

.. image:: resources/interactive-3d-viewer.png :alt: Contextualise's interactive 3D viewer

Contextualise's interactive 3D viewer

Contextualise's main dependency is TopicDB, an open source topic maps-based graph library. Topic maps provide a way to describe complex relationships between abstract concepts and real-world (information) resources.

⁠Why?

I built and published my first knowledge documentation tool in 2007 which I was still using until very recently, almost unmodified, twelve years later. If I remember correctly, it was built with PHP version 5.2.5! Twelve years is an eternity in software terms. Nowadays, my preferred choice for web development is Python together with the Flask_ web development framework. What's more, after twelve years of using my own and other knowledge management tools, I have several improvements in mind for the next version (many of which are simplifications, for that matter). And perhaps one of the most important reasons for building a new tool like this is that I want it to be open source: both Contextualise (the web application) and TopicDB (the actual topic maps engine on top of which Contextualise is built -- also written by me) are licensed with the permissive open source MIT license_.

⁠Feature Support

The following provides an overview of Contextualise's existing (and planned) feature set:

Existing Features

• Support for multiple (self-contained) topic maps
• Support for both private and public topic maps
• Extensive support for notes including the ability to attach a note to an existing topic and convert a note into a topic
• Markdown_-based text editor for topic text and notes
• The ability to attach files (including images, PDFs, and so forth) to topics
• The ability to attach (glTF_-based) 3D models to topics with an accompanying interactive 3D model viewer
• Powerful (semantic) associations with the ability to create typed associations with role-based members
• Flexible filtering of topic occurrences and associations by scope (that is, context)
• Interactive visual network graph of related topics (allowing navigation between topics)
• Auto-complete on all form fields that expect a topic reference

Missing Version 1.0 Features

• Augmented Reality <https://en.wikipedia.org/wiki/Augmented_reality>_ (AR) support for 3D occurrences
• Full-text search
• Google Maps support
• Timeline <https://timeline.knightlab.com/docs/index.html>_ support allowing to navigate between topics using a visual timeline component
• WikiMedia API integration to automatically enhance existing topics with relevant information from Wikipedia <https://www.wikipedia.org/>_
• Semantic tagging

For a more exhaustive list of missing features take a look at Contextualise's list of issues <https://github.com/brettkromkamp/contextualise/issues>_.

⁠Install the Development Version

Contextualise officially supports Python 3.6–3.8.

If you have Git <https://git-scm.com/>_ installed on your system, it is possible to install the development version of Contextualise.

Certain build prerequisites need to be met including the presence of a C compiler, the Python header files, the libpq header files and the pg_config program as outlined, here: Build prerequisites <http://initd.org/psycopg/docs/install.html#build-prerequisites>_.

Then do::

$ git clone https://github.com/brettkromkamp/contextualise
$ cd contextualise
$ pip install -e .

The pip install -e . command allows you to follow the development branch as it changes by creating links in the right places and installing the command line scripts to the appropriate locations.

Then, if you want to update Contextualise at any time, in the same directory do::

$ git pull

TopicDB, the topic maps engine on top of which Contextualise is built is regularly updated. However, the version of TopicDB published on PyPI <https://pypi.org/project/topic-db/> could lag behind. For that reason, it is recommended that you also install TopicDB directly from GitHub::

$ pip uninstall topic-db
$ git clone https://github.com/brettkromkamp/topic-db.git
$ cd topic-db
$ pip install -e .

Then, if you want to update TopicDB at any time, in the same directory do::

$ git pull

After having installed Contextualise, you would have to separately install and configure the PostgreSQL database. Brief instructions on how to do so are provided, here: Setting up the TopicDB database <https://gist.github.com/brettkromkamp/87aaa99b056578ff1dc23a43a49aca89>_. You need to ensure that the database username, password and database name match with the settings.ini file in the project's root folder.

Finally, to run the application in development mode you need to change to the project's top-level directory and set two environment variables followed by running the flask command with the run parameter::

$ export FLASK_APP=contextualise
$ export FLASK_ENV=development
$ flask run

You should see something similar to the following in the terminal::

* Serving Flask app "contextualise" (lazy loading)
* Environment: development
* Debug mode: on
* Running on http://127.0.0.1:5000/ (Press CTRL+C to quit)
* Restarting with stat
* Debugger is active!
* Debugger PIN: 521-258-444

Opening the browser and navigating to http://127.0.0.1:5000/ should result in showing the application's Welcome page.

.. image:: resources/welcome-page.png :alt: The Contextualise Welcome page

The Contextualise Welcome page

Flask's built-in server is not suitable for production purposes. However, it is quite straightforward to run Contextualise using Gunicorn <https://gunicorn.org/>_, a Python WSGI HTTP server::

$ gunicorn -w 4 -b 0.0.0.0:5000 contextualise.wsgi:app

For further information for properly running a flask application in production, take a look at Flask's own documentation <https://flask.palletsprojects.com/en/1.1.x/deploying/#deployment>_.

⁠Docker

Support for running Contextualise within Docker <https://www.docker.com/>_ is still in development. To run it from the root of a local clone of the source:

1. Copy settings-docker-sample.ini to settings.ini file in the root and replace your email settings. For example::

   [DATABASE] Username = postgres Password = postgres Database = postgres Host = db Port = 5432

   [EMAIL] Username = changeme Password = changeme Server = mail.changeme.com Sender = Change Me

2. Run docker-compose up --build for a production like deployment running behind gunicorn in an immutable image so any source code changes require a rebuild. If, however, you want a more dynamic environment for development add in the development config file with docker-compose -f docker-compose.yml -f docker-compose.dev.yml up --build where source changes occur immediately within the image. Modifying requirements.txt requires a rebuild of the image however.

⁠First-Time Use

Several users (with the roles of admin and user, respectively) are created by the application for testing purposes. To log in as the admin user, provide the following credentials: [email protected] (user name) and Passw0rd1 (password). To log in as a non-admin user, provide the following credentials: [email protected] and Passw0rd1.

⁠Tutorial

Pending.

⁠Documentation

Pending.

⁠Miscellaneous

Currently, I am using Contextualise for worldbuilding purposes of the Brave Robot fictional universe including its Codex Roboticus <https://brettkromkamp.com/posts/codex-roboticus/>_.

.. image:: resources/codex-roboticus1.png :alt: Codex Roboticus

⁠How to Contribute

#. Check for open issues or open a fresh issue to start a discussion around a feature idea or a bug. #. Fork the repository_ on GitHub to start making your changes to the master branch (or branch off of it). #. Write a test which shows that the bug was fixed or that the feature works as expected. #. Send a pull request and bug the maintainer until it gets merged and published. :) Make sure to add yourself to AUTHORS_.

.. _topic maps: https://msdn.microsoft.com/en-us/library/aa480048.aspx⁠ .. _world building: https://en.wikipedia.org/wiki/Worldbuilding⁠ .. _TopicDB: https://github.com/brettkromkamp/topic-db⁠ .. _Knowledge Management Using Topic Maps: http://quesucede.com/page/show/id/frontpage⁠ .. _PHP version 5.2.5: http://php.net/ChangeLog-5.php#5.2.5⁠ .. _Python: https://www.python.org/⁠ .. _Flask: http://flask.pocoo.org/docs/1.0/⁠ .. _MIT license: https://github.com/brettkromkamp/contextualise/blob/master/LICENSE⁠ .. _the repository: https://github.com/brettkromkamp/contextualise⁠ .. _AUTHORS: https://github.com/brettkromkamp/contextualise/blob/master/AUTHORS.rst⁠ .. _Markdown: https://daringfireball.net/projects/markdown/syntax⁠ .. _glTF: https://www.khronos.org/gltf/⁠