{ "info": { "author": "NIST IT Lab", "author_email": "itl_inquiries@nist.gov", "bugtrack_url": null, "classifiers": [], "description": "=============\nCore Main App\n=============\n\nThis Django reusable app contains the main functionalities for the curator\ncore project.\n\nPre-requisites\n==============\n\nFor automated and manual install, the following software are needed:\n\n* ``python``\n* ``pip``\n* virtual env (``conda`` or ``venv``)\n\nIn addition, for manual setup, ``git`` is needed.\n\nInstallation\n============\n\nAutomated installation\n----------------------\n\n.. code:: bash\n\n $ pip install core_main_app\n\nManual installation\n-------------------\n\n.. code:: bash\n\n $ git clone https://github.com/usnistgov/core_main_app.git\n $ cd core_main_app\n $ python setup.py\n $ pip install sdist/*.tar.gz\n\n\nConfiguration\n=============\n\nEdit the setting.py file\n------------------------\n\nAdd the ``\"core_main_app\"`` and ``\"tz_detect\"`` under ``INSTALLED_APPS`` as\nsuch:\n\n.. code:: python\n\n INSTALLED_APPS = [\n ...\n \"tz_detect\",\n \"core_main_app\",\n ]\n\nAdd the middleware required by ``tz_detect``:\n\n.. code:: python\n\n MIDDLEWARE = (\n ...\n 'tz_detect.middleware.TimezoneMiddleware',\n )\n\n\nEdit the urls.py file\n---------------------\n\nAdd the ``core_main_app`` urls to the Django project as such.\n\n.. code:: python\n\n url(r'^', include(\"core_main_app.urls\")),\n\n\nInternationalization (i18n)\n===========================\n\nBefore running the project, don't forget to compile the translation file at\nproject level. i18n uses the ``gettext`` package, so please make sure it is\ninstalled prior to using this command.\n\n.. code:: bash\n\n $ python manage.py compilemessages\n\nTests\n=====\n\nTo play the test suite created for this package, download the git repository\nand run:\n\n.. code:: bash\n\n $ python runtests.py\n\nDocumentation\n=============\n\nDocumentation has been generated using Sphinx. To generate a local version of\nthe docs, please clone the repository and run:\n\n.. code:: bash\n\n $ cd docs/\n $ make html\n\nOr, directly using Sphinx:\n\n.. code:: bash\n\n $ cd docs/\n $ sphinx-build -b html . ../dist/_docs\n\nEnable SSL connection\n=====================\n\nPlease follow these steps to configure the connection to any system running over HTTPS (including the local instance).\n\n* Create a folder for SSL certificates,\n* Copy the certificate in the folder,\n* Run ``c_rehash`` on the folder (needs to be done every time a new certificate is added to the folder),\n* Update the SSL_CERTIFICATES_DIR setting to point to the SSL certificate folder previously created.\n\n.. code:: bash\n\n $ mkdir certs\n $ cp cdcs.crt certs/\n $ c_rehash certs/\n\nEnable Redis Server authentication\n==================================\n\nPlease follow these steps to enable authentication on the redis server.\nDepending on the way Redis is started on the machine, the method may differ.\n\nYou can follow instructions at https://redis.io/topics/security#authentication-feature to enable authentication:\n* Open the file redis.conf (e.g. /usr/local/etc/redis.conf),\n* Uncomment the authentication setting (# requirepass foobared),\n* It is recommended to replace the default password (foobared) by a strong and long password,\n* Restart the Redis Server.\n\nYou should then update the CDCS settings using a Redis connection URL with the password chosen in the previous steps.\n\n.. code:: python\n\n BROKER_URL = 'redis://:@localhost:6379/0'\n CELERY_RESULT_BACKEND = 'redis://:@localhost:6379/0'\n\n\nEnable SMTP server\n==================\n\nPlease follow these steps to configure the SMTP server:\n\n* Set these constants in your setting.py file (all these constants are required)\n\n.. code:: py\n\n EMAIL_HOST = 'smtp.myserver.com'\n EMAIL_PORT = 587\n DEFAULT_FROM_EMAIL = 'TestSite Team '\n\n\n* These optional constants can be added in your setting.py according to your SMTP server configuration\n\n.. code:: py\n\n EMAIL_USE_TLS = True\n EMAIL_HOST_USER = 'testsite_app'\n EMAIL_HOST_PASSWORD = 'mys3cr3tp4ssw0rd'", "description_content_type": "", "docs_url": null, "download_url": "", "downloads": { "last_day": -1, "last_month": -1, "last_week": -1 }, "home_page": "https://github.com/usnistgov/core_main_app", "keywords": "", "license": "", "maintainer": "", "maintainer_email": "", "name": "core-main-app", "package_url": "https://pypi.org/project/core-main-app/", "platform": "", "project_url": "https://pypi.org/project/core-main-app/", "project_urls": { "Homepage": "https://github.com/usnistgov/core_main_app" }, "release_url": "https://pypi.org/project/core-main-app/1.5.0/", "requires_dist": null, "requires_python": "", "summary": "Main functionalities for the curator core project", "version": "1.5.0" }, "last_serial": 5983965, "releases": { "1.0.0": [ { "comment_text": "", "digests": { "md5": "c1ce9ba4e6722ba61eecf9d522ab04e4", "sha256": "6c01a79200772a86c5abf47a90b84f7e5bb83cee990d6db79c5cba61481892d3" }, "downloads": -1, "filename": "core_main_app-1.0.0.tar.gz", "has_sig": false, "md5_digest": "c1ce9ba4e6722ba61eecf9d522ab04e4", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 1326767, "upload_time": "2019-02-27T19:00:12", "url": "https://files.pythonhosted.org/packages/77/3e/1eef24514d4bd83448951c138ec0d9b20b29127673943d1bdd2512e90b34/core_main_app-1.0.0.tar.gz" } ], "1.0.0b1": [ { "comment_text": "", "digests": { "md5": "8bda0c7834ec62d04ff3a647a5d14390", "sha256": "55b0bc1684cf7603dea5431ff29d9275e7565459857e4b43a183b64ecff89eee" }, "downloads": -1, "filename": "core_main_app-1.0.0b1.tar.gz", "has_sig": false, "md5_digest": "8bda0c7834ec62d04ff3a647a5d14390", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 1302788, "upload_time": "2018-04-26T16:43:07", "url": "https://files.pythonhosted.org/packages/ef/94/ea4f75b474f3b11f9003726f09de8108bb9ee85c4e779eca13fe9320f663/core_main_app-1.0.0b1.tar.gz" } ], "1.0.0b2": [ { "comment_text": "", "digests": { "md5": "6a89baeea7308f5f4eaafcc5090a3add", "sha256": "b7f862afd842bb37555a7c7f5463f4af6840144e34db90b0dc741f726ca797be" }, "downloads": -1, "filename": "core_main_app-1.0.0b2.tar.gz", "has_sig": false, "md5_digest": "6a89baeea7308f5f4eaafcc5090a3add", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 1304787, "upload_time": "2018-05-30T15:23:33", "url": "https://files.pythonhosted.org/packages/13/31/d5f6b6a37268c81b9f79be7b6e476c40c7d9f3aebc9241f1c43f0153f30b/core_main_app-1.0.0b2.tar.gz" } ], "1.0.0b3": [ { "comment_text": "", "digests": { "md5": "e59c62a80818778857a3d3f1965d1159", "sha256": "efe0e47ed6ebfc7d8b99c1963ab781d184f9e946104bdfca8e3ec55e0c013b4f" }, "downloads": -1, "filename": "core_main_app-1.0.0b3.tar.gz", "has_sig": false, "md5_digest": "e59c62a80818778857a3d3f1965d1159", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 1306541, "upload_time": "2018-07-03T14:58:02", "url": "https://files.pythonhosted.org/packages/43/10/a5de4f1c36615c8a1d0d043b86b1d21909058ea1165bb1c659ff89c69077/core_main_app-1.0.0b3.tar.gz" } ], "1.0.0b4": [ { "comment_text": "", "digests": { "md5": "0416dc062cb54ad46432e9dd0ff064ce", "sha256": "9fbfd800ca0ce8042a16035408d83404fd38c24abaa1a9acec3188c06b10b4e2" }, "downloads": -1, "filename": "core_main_app-1.0.0b4.tar.gz", "has_sig": false, "md5_digest": "0416dc062cb54ad46432e9dd0ff064ce", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 1306653, "upload_time": "2018-08-15T15:21:54", "url": "https://files.pythonhosted.org/packages/ec/fe/fa8b79c2aa1bc211cd3cf29380fb02d026310ad94b8b85f171feb6851915/core_main_app-1.0.0b4.tar.gz" } ], "1.0.0b5": [ { "comment_text": "", "digests": { "md5": "c2e8c6d65f10274c312e1299218bb5e9", "sha256": "e2b8e2b898723cbd2745cf41d7aaf730e1a4af556282f867bf9bc04d19092589" }, "downloads": -1, "filename": "core_main_app-1.0.0b5.tar.gz", "has_sig": false, "md5_digest": "c2e8c6d65f10274c312e1299218bb5e9", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 1306361, "upload_time": "2018-09-27T17:34:33", "url": "https://files.pythonhosted.org/packages/9f/c1/5a550cc69666f5e49af3308dc5d94463486a8878bbfc5922925a027597cd/core_main_app-1.0.0b5.tar.gz" } ], "1.0.0rc1": [ { "comment_text": "", "digests": { "md5": "dbcc4f9b7298fba9d4f7e4e4e5c7874d", "sha256": "fd957bd95ea43d7a5b87971584a26109bce6c9f2ada25d7e6e99108029b7ba9d" }, "downloads": -1, "filename": "core_main_app-1.0.0rc1.tar.gz", "has_sig": false, "md5_digest": "dbcc4f9b7298fba9d4f7e4e4e5c7874d", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 1313326, "upload_time": "2018-11-05T16:46:41", "url": "https://files.pythonhosted.org/packages/d3/43/87ce5387199db8b64fff15ee94bd86817af237eaac46a9eafbcd9e58ad86/core_main_app-1.0.0rc1.tar.gz" } ], "1.0.0rc2": [ { "comment_text": "", "digests": { "md5": "ff0de6cf2329018979ea5cdcc523798b", "sha256": "6f551307539f6130966b5c4b4f434e73618c8c4dea03b30865c945990d1201f4" }, "downloads": -1, "filename": "core_main_app-1.0.0rc2.tar.gz", "has_sig": false, "md5_digest": "ff0de6cf2329018979ea5cdcc523798b", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 1316750, "upload_time": "2018-12-10T17:03:42", "url": "https://files.pythonhosted.org/packages/2d/30/e785cbef84ff8b03d27b1a7b7b88fb5229aca2bdb91db26e50d3881df13d/core_main_app-1.0.0rc2.tar.gz" } ], "1.0.1": [ { "comment_text": "", "digests": { "md5": "46cf605dce84d584344a3dafe35ea4fc", "sha256": "0b39ec3cbc4c35ca3807022ad62d5e29fd8b2687a5c353c2733057868ce60ae6" }, "downloads": -1, "filename": "core_main_app-1.0.1.tar.gz", "has_sig": false, "md5_digest": "46cf605dce84d584344a3dafe35ea4fc", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 1326735, "upload_time": "2019-03-18T15:45:23", "url": "https://files.pythonhosted.org/packages/d5/e9/2094cd17d2e860586b6c8a0c4e2383c5a0a911dc8e9a9ccc933759789e91/core_main_app-1.0.1.tar.gz" } ], "1.1.0": [ { "comment_text": "", "digests": { "md5": "f1004043fba9e1e0dd505971ba25063b", "sha256": "99ab21e94e53480e525b42e260cc2644b51fe6ea941ff18e5163b77988241f65" }, "downloads": -1, "filename": "core_main_app-1.1.0.tar.gz", "has_sig": false, "md5_digest": "f1004043fba9e1e0dd505971ba25063b", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 1327224, "upload_time": "2019-04-15T18:36:43", "url": "https://files.pythonhosted.org/packages/f6/6d/d69ac87e327a822253f5a6f78b84cc3cf4afac120972e3a056fb6a3b4df5/core_main_app-1.1.0.tar.gz" } ], "1.2.0": [ { "comment_text": "", "digests": { "md5": "e565ad5b60f41035aeaaea353a9478ce", "sha256": "f1c391293afbb84034957b9ebf30c36e66b144b5f57955f76e8f00729e9cb6af" }, "downloads": -1, "filename": "core_main_app-1.2.0.tar.gz", "has_sig": false, "md5_digest": "e565ad5b60f41035aeaaea353a9478ce", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 1329253, "upload_time": "2019-06-03T18:46:05", "url": "https://files.pythonhosted.org/packages/f6/3b/7b1e1c13c08c1982f858e21a6166342be0c975ce4ede93ed4cb52bb13829/core_main_app-1.2.0.tar.gz" } ], "1.3.0": [ { "comment_text": "", "digests": { "md5": "3b7ae09e3700dcae08ad52f845c0ed95", "sha256": "e18cbe945cfe0b875aa827819d6eb716227a8ad5b0dddcd5354c0ffee761d375" }, "downloads": -1, "filename": "core_main_app-1.3.0.tar.gz", "has_sig": false, "md5_digest": "3b7ae09e3700dcae08ad52f845c0ed95", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 1329385, "upload_time": "2019-07-15T18:49:43", "url": "https://files.pythonhosted.org/packages/51/49/eba4be6a3daddf553c1fe0f833e0f34e98021aff43ba9ab0a3f974174c2b/core_main_app-1.3.0.tar.gz" } ], "1.4.0": [ { "comment_text": "", "digests": { "md5": "8f2144659d73c65fdadf63a39bb5b9ea", "sha256": "d5f4e330d91401caa4eff7e4a5beb5442e6414e5af682ad580e4a8cb1123ff99" }, "downloads": -1, "filename": "core_main_app-1.4.0.tar.gz", "has_sig": false, "md5_digest": "8f2144659d73c65fdadf63a39bb5b9ea", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 1334441, "upload_time": "2019-08-26T16:10:05", "url": "https://files.pythonhosted.org/packages/9d/a6/17d7e43cd983f8adfd5cd72ba9331874eb112c313fe3017b0b477a7156a6/core_main_app-1.4.0.tar.gz" } ], "1.5.0": [ { "comment_text": "", "digests": { "md5": "1c9cfdaed6b1c75b9900ba756ff8b507", "sha256": "f051744ee7d7256d3b2cbd0aea7f13beccb2aa26247ced6aea375a07178abec4" }, "downloads": -1, "filename": "core_main_app-1.5.0.tar.gz", "has_sig": false, "md5_digest": "1c9cfdaed6b1c75b9900ba756ff8b507", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 1340243, "upload_time": "2019-10-16T15:01:47", "url": "https://files.pythonhosted.org/packages/35/5f/b591199d20198d4421f76f24079542869a523722482b377fd20069bd1c9d/core_main_app-1.5.0.tar.gz" } ] }, "urls": [ { "comment_text": "", "digests": { "md5": "1c9cfdaed6b1c75b9900ba756ff8b507", "sha256": "f051744ee7d7256d3b2cbd0aea7f13beccb2aa26247ced6aea375a07178abec4" }, "downloads": -1, "filename": "core_main_app-1.5.0.tar.gz", "has_sig": false, "md5_digest": "1c9cfdaed6b1c75b9900ba756ff8b507", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 1340243, "upload_time": "2019-10-16T15:01:47", "url": "https://files.pythonhosted.org/packages/35/5f/b591199d20198d4421f76f24079542869a523722482b377fd20069bd1c9d/core_main_app-1.5.0.tar.gz" } ] }