text sherlock

نص شيرلوك (أو شيرلوك)

يوفر سريعًا وسهل التثبيت وبسيط استخدام محرك البحث للنص ، ولكنه تم تحسينه للرمز المصدر. يتطلب البديل ، OpenGrok ، وقتًا طويلاً للتثبيت (على الرغم من أنه قد يكون يستحق كل هذا العناء للبعض) ، ولكنه أكثر ثراءً. سوف يمنحك Text Sherlock إعدادًا أسهل بكثير ، ومؤشر نص ، وواجهة تطبيق ويب للبحث مع القليل من الجهد.

سولي ديو غلوريا

الإعداد الأساسي

تعليمات:

1. قم بتنزيل مصدر Sherlock من Github.
2. استخراج/ضع رمز مصدر Sherlock في دليل (تثبيت) المطلوب. سيكون هذا هو المكان الذي يعيش فيه شيرلوك.
3. قم بتشغيل sh setup/virtualenv-setup.sh لإعداد بيئة معزولة وتنزيل الحزم الأساسية.
4. تكوين الإعدادات. الافتراضيات في settings.py توفير وثائق لكل إعداد.
   • نسخ example.local_settings.yml إلى local_settings.yml .
   • تجاوز/انسخ أي إعداد من settings.py التحلي إلى local_settings.yml (قم بتغيير القيم حسب الحاجة). يجب أن تكون جميع مفاتيح/خيارات YAML صغيرة.
5. قم بتشغيل source sherlock_env/bin/activate لإدخال البيئة الافتراضية.
6. قم بتشغيل python main.py --index update أو --index rebuild لفهرسة المسار المحدد في الإعدادات. مشاهدة فهرسة الإخراج.
7. قم بتشغيل python main.py --runserver لبدء خادم الويب.
8. انتقل إلى http://localhost:7777 للوصول إلى واجهة الويب. يستخدم مجموعة أدوات bootstrap لواجهة المستخدم.

قد تحتاج إلى تثبيت بعض الحزم قبل تشغيل تثبيت Ubuntu دون خطأ.

• تثبيت Curl: sudo apt-get install curl
• تثبيت uuid libs: sudo apt-get install uuid-dev
• تثبيت Python Dev: sudo apt-get install python-dev

---

يشمل:

• الإعدادات/التكوين
  • انظر settings.py للحصول على التفاصيل.
• البرنامج النصي الإعداد (اقرأ محتويات البرنامج النصي لمزيد من المعلومات)
  • قم بتشغيل virtualenv-setup.sh لإجراء تثبيت معزول.
• نص تحكم رئيسي
  • تشغيل main.py -h لمزيد من المعلومات.
• واجهة من طرف إلى طرف
  • الفهرسة والبحث النص (رمز المصدر). دعم مدمج لـ Whoosh (البحث السريع) أو Xapian (بحث أسرع بكثير).
    • تمديد الفهرسة أو البحث بسهولة عبر الخلفية المخصصة.
  • تطبيق الويب الأمامي الذي يتم تقديمه باستخدام Werkzeug أو Cheroot.
    • werkzeug هو للتطوير لحركة المرور الصغيرة.
    • cheroot هو خادم HTTP النقي Pure-Python الذي يستخدمه Cherrypy.
  • الإعدادات والتكوين باستخدام Python.

واجهة الويب

سمات:

إلحاق لتوثيق عنوان URL.

• لتمييز الخطوط ، إلحاق عنوان URL: &hl=3,7,12-14,21
• للقفز إلى خط ، إلحاق إلى نهاية عنوان URL: #line-3

باستخدام الخلفية الأخرى

في settings.py .

• قم بتغيير قيم default_indexer و default_searcher لمطابقة الاسم المعطى مع الواجهة الخلفية.
  • القيم الممكنة:
    • whoosh الافتراضي ، لا حاجة إلى عمل إضافي.
    • يجب تثبيت xapian بشكل منفصل باستخدام البرنامج النصي setup/install-xapian.sh المضمون.

باستخدام خوادم الويب الأخرى

لدى Text Sherlock دعمًا مدمجًا لخوادم Werkzeug و Cheroot WSGI المتوافقة.

في settings.py .

• قم بتغيير قيمة server_type إلى أحد أنواع الخادم المتاحة.
  • القيم الممكنة:
    • default ، خادم الويب Werkzeug (افتراضي).
    • cheroot ، Production Ready Web Server.

الحزم الأساسية

يتطلب بيثون 3.5+

• Whoosh
• قارورة
• Jinja2
• مقاطع
• Peewee
• bootstrap v4.x
• pyyaml

مراجع أخرى

• https://pygments.org/
• http://docs.peewee-orm.com/
• https://cheroot.cherrypy.org/
• https://xapian.org/
• https://pyyaml.org/wiki/pyyamldocumentation
• https://zeptojs.com

أهداف المشروع

1. قم بتوفير حل محرك البحث عن النص سهل الإعداد والسريع وكافي.
2. تكون بديلاً محترمًا لـ OpenGrok.
3. تؤثر على المساهمين OpenGrok لتوفير عملية إعداد أبسط.
   • لقد نجحت في إعداد تثبيتين من OpenGrok على CentOS و Ubuntu 11.x. في كل مرة يستغرق الأمر أكثر من ساعتين . يستغرق إعداد Sherlock Text أقل من 5 دقائق (باستثناء وقت تنزيل الحزمة).

المساهمين

• كريستوفر بيس
• رافائيل بودول
• وآخرون ...