kallithea Changeset - 7784a1212471

Changeset - 7784a1212471

Parent rev.

Child rev.

[Not reviewed]

default

1 8 1

Thomas De Schampheleire - 7 years ago 2018-11-18 20:02:17
thomas.de_schampheleire@nokia.com

cli: convert 'gearbox make-config' into 'kallithea-cli config-create'

... and update documentation.

9 files changed with 43 insertions and 62 deletions:

docs/contributing.rst

docs/dev/dbmigrations.rst

docs/installation_win.rst

docs/installation_win_old.rst

docs/setup.rst

docs/upgrade.rst

kallithea/bin/kallithea_cli.py

kallithea/bin/kallithea_cli_config.py

setup.py

0 comments (0 inline, 0 general)

docs/contributing.rst

➞

Show inline comments

 .. _contributing:
 =========================
 Contributing to Kallithea
 =========================
 Kallithea is developed and maintained by its users. Please join us and scratch
 your own itch.
 Infrastructure
 --------------
 The main repository is hosted on Our Own Kallithea (aka OOK) at
 https://kallithea-scm.org/repos/kallithea/, our self-hosted instance
 of Kallithea.
 For now, we use Bitbucket_ for `pull requests`_ and `issue tracking`_. The
 issue tracker is for tracking bugs, not for support, discussion, or ideas --
 please use the `mailing list`_ or :ref:`IRC <readme>` to reach the community.
 We use Weblate_ to translate the user interface messages into languages other
 than English. Join our project on `Hosted Weblate`_ to help us.
 To register, you can use your Bitbucket or GitHub account. See :ref:`translations`
 for more details.
 Getting started
 ---------------
 To get started with Kallithea development::
         hg clone https://kallithea-scm.org/repos/kallithea
         cd kallithea
         virtualenv ../kallithea-venv
         source ../kallithea-venv/bin/activate
         pip install --upgrade pip setuptools
         pip install --upgrade -e .
         pip install --upgrade -r dev_requirements.txt
         npm install     # install dependencies - both tools and data
         npm run less    # for generating css from less
-        gearbox make-config my.ini
+        kallithea-cli config-create my.ini
         gearbox setup-db -c my.ini --user=user --email=user@example.com --password=password --repos=/tmp
         gearbox serve -c my.ini --reload &
         firefox http://127.0.0.1:5000/
 If you plan to use Bitbucket_ for sending contributions, you can also fork
 Kallithea on Bitbucket_ first (https://bitbucket.org/conservancy/kallithea) and
 then replace the clone step above by a clone of your fork. In this case, please
 see :ref:`contributing-guidelines` below for configuring your fork correctly.
 Contribution flow
 -----------------
 Starting from an existing Kallithea clone, make sure it is up to date with the
 latest upstream changes::
         hg pull
         hg update
 Review the :ref:`contributing-guidelines` and :ref:`coding-guidelines`.
 If you are new to Mercurial, refer to Mercurial `Quick Start`_ and `Beginners
 Guide`_ on the Mercurial wiki.
 Now, make some changes and test them (see :ref:`contributing-tests`). Don't
 forget to add new tests to cover new functionality or bug fixes.
 For documentation changes, run ``make html`` from the ``docs`` directory to
 generate the HTML result, then review them in your browser.
 Before submitting any changes, run the cleanup script::
         ./scripts/run-all-cleanup
 When you are completely ready, you can send your changes to the community for
 review and inclusion. Most commonly used methods are sending patches to the
 mailing list (via ``hg email``) or by creating a pull request on Bitbucket_.
 .. _contributing-tests:
 Running tests
 -------------
 After finishing your changes make sure all tests pass cleanly. Run the testsuite
 by invoking ``py.test`` from the project root::
     py.test
 Note that testing on Python 2.6 also requires ``unittest2``.
 Note that on unix systems, the temporary directory (``/tmp`` or where
 ``$TMPDIR`` points) must allow executable files; Git hooks must be executable,
 and the test suite creates repositories in the temporary directory. Linux
 systems with /tmp mounted noexec will thus fail.
 You can also use ``tox`` to run the tests with all supported Python versions
 (currently Python 2.6--2.7).
 When running tests, Kallithea generates a `test.ini` based on template values
 in `kallithea/tests/conftest.py` and populates the SQLite database specified
 there.
 It is possible to avoid recreating the full test database on each invocation of
 the tests, thus eliminating the initial delay. To achieve this, run the tests as::
     gearbox serve -c /tmp/kallithea-test-XXX/test.ini --pid-file=test.pid --daemon
     KALLITHEA_WHOOSH_TEST_DISABLE=1 KALLITHEA_NO_TMP_PATH=1 py.test
     kill -9 $(cat test.pid)
 In these commands, the following variables are used::
     KALLITHEA_WHOOSH_TEST_DISABLE=1 - skip whoosh index building and tests
     KALLITHEA_NO_TMP_PATH=1 - disable new temp path for tests, used mostly for testing_vcs_operations
 You can run individual tests by specifying their path as argument to py.test.
 py.test also has many more options, see `py.test -h`. Some useful options
 are::
     -k EXPRESSION         only run tests which match the given substring
                           expression. An expression is a python evaluable
                           expression where all names are substring-matched
                           against test names and their parent classes. Example:
     -x, --exitfirst       exit instantly on first error or failed test.
     --lf                  rerun only the tests that failed at the last run (or
                           all if none failed)
     --ff                  run all tests but run the last failures first. This
                           may re-order tests and thus lead to repeated fixture
                           setup/teardown
     --pdb                 start the interactive Python debugger on errors.
     -s, --capture=no      don't capture stdout (any stdout output will be
                           printed immediately)
 Performance tests
 ^^^^^^^^^^^^^^^^^
 A number of performance tests are present in the test suite, but they are
 not run in a standard test run. These tests are useful to
 evaluate the impact of certain code changes with respect to performance.
 To run these tests::
     env TEST_PERFORMANCE=1 py.test kallithea/tests/performance
 To analyze performance, you could install pytest-profiling_, which enables the
 --profile and --profile-svg options to py.test.
 .. _pytest-profiling: https://github.com/manahl/pytest-plugins/tree/master/pytest-profiling
 .. _contributing-guidelines:
 Contribution guidelines
 -----------------------
 Kallithea is GPLv3 and we assume all contributions are made by the
 committer/contributor and under GPLv3 unless explicitly stated. We do care a
 lot about preservation of copyright and license information for existing code
 that is brought into the project.
 Contributions will be accepted in most formats -- such as pull requests on
 Bitbucket, something hosted on your own Kallithea instance, or patches sent by
 email to the `kallithea-general`_ mailing list.
 When contributing via Bitbucket, please make your fork of
 https://bitbucket.org/conservancy/kallithea/ `non-publishing`_ -- it is one of
 the settings on "Repository details" page. This ensures your commits are in
 "draft" phase and makes it easier for you to address feedback and for project
 maintainers to integrate your changes.
 .. _non-publishing: https://www.mercurial-scm.org/wiki/Phases#Publishing_Repository
 Make sure to test your changes both manually and with the automatic tests
 before posting.
 We care about quality and review and keeping a clean repository history. We
 might give feedback that requests polishing contributions until they are
 "perfect". We might also rebase and collapse and make minor adjustments to your
 changes when we apply them.
 We try to make sure we have consensus on the direction the project is taking.
 Everything non-sensitive should be discussed in public -- preferably on the
 mailing list.  We aim at having all non-trivial changes reviewed by at least
 one other core developer before pushing. Obvious non-controversial changes will
 be handled more casually.
 There is a main development branch ("default") which is generally stable so that
 it can be (and is) used in production. There is also a "stable" branch that is
 almost exclusively reserved for bug fixes or trivial changes. Experimental
 changes should live elsewhere (for example in a pull request) until they are
 ready.
 .. _coding-guidelines:
 Coding guidelines
 -----------------
 We don't have a formal coding/formatting standard. We are currently using a mix
 of Mercurial's (https://www.mercurial-scm.org/wiki/CodingStyle), pep8, and
 consistency with existing code. Run ``scripts/run-all-cleanup`` before
 committing to ensure some basic code formatting consistency.
 We support both Python 2.6.x and 2.7.x and nothing else. For now we don't care
 about Python 3 compatibility.
 We try to support the most common modern web browsers. IE9 is still supported
 to the extent it is feasible, IE8 is not.
 We primarily support Linux and OS X on the server side but Windows should also work.
 HTML templates should use 2 spaces for indentation ... but be pragmatic. We
 should use templates cleverly and avoid duplication. We should use reasonable
 semantic markup with element classes and IDs that can be used for styling and testing.
 We should only use inline styles in places where it really is semantic (such as
 ``display: none``).
 JavaScript must use ``;`` between/after statements. Indentation 4 spaces. Inline
 multiline functions should be indented two levels -- one for the ``()`` and one for
 ``{}``.
 Variables holding jQuery objects should be named with a leading ``$``.
 Commit messages should have a leading short line summarizing the changes. For
 bug fixes, put ``(Issue #123)`` at the end of this line.
 Use American English grammar and spelling overall. Use `English title case`_ for
 page titles, button labels, headers, and 'labels' for fields in forms.
 .. _English title case: https://en.wikipedia.org/wiki/Capitalization#Title_case
 Template helpers (that is, everything in ``kallithea.lib.helpers``)
 should only be referenced from templates. If you need to call a
 helper from the Python code, consider moving the function somewhere
 else (e.g. to the model).
 Notes on the SQLAlchemy session
 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
 Each HTTP request runs inside an independent SQLAlchemy session (as well
 as in an independent database transaction). ``Session`` is the session manager
 and factory. ``Session()`` will create a new session on-demand or return the
 current session for the active thread. Many database operations are methods on
 such session instances - only ``Session.remove()`` should be called directly on
 the manager.
 Database model objects
 (almost) always belong to a particular SQLAlchemy session, which means
 that SQLAlchemy will ensure that they're kept in sync with the database
 (but also means that they cannot be shared across requests).
 Objects can be added to the session using ``Session().add``, but this is
 rarely needed:
 * When creating a database object by calling the constructor directly,
   it must explicitly be added to the session.
 * When creating an object using a factory function (like
   ``create_repo``), the returned object has already (by convention)
   been added to the session, and should not be added again.
 * When getting an object from the session (via ``Session().query`` or
   any of the utility functions that look up objects in the database),
   it's already part of the session, and should not be added again.
   SQLAlchemy monitors attribute modifications automatically for all
   objects it knows about and syncs them to the database.
 SQLAlchemy also flushes changes to the database automatically; manually
 calling ``Session().flush`` is usually only necessary when the Python
 code needs the database to assign an "auto-increment" primary key ID to
 a freshly created model object (before flushing, the ID attribute will
 be ``None``).
 TurboGears2 DebugBar
 ^^^^^^^^^^^^^^^^^^^^
 It is possible to enable the TurboGears2-provided DebugBar_, a toolbar overlayed
 over the Kallithea web interface, allowing you to see:
 * timing information of the current request, including profiling information
 * request data, including GET data, POST data, cookies, headers and environment
   variables
 * a list of executed database queries, including timing and result values
 DebugBar is only activated when ``debug = true`` is set in the configuration
 file. This is important, because the DebugBar toolbar will be visible for all
 users, and allow them to see information they should not be allowed to see. Like
 is anyway the case for ``debug = true``, do not use this in production!
 To enable DebugBar, install ``tgext.debugbar`` and ``kajiki`` (typically via
 ``pip``) and restart Kallithea (in debug mode).
 "Roadmap"
 ---------
 We do not have a road map but are waiting for your contributions. Refer to the
 wiki_ for some ideas of places we might want to go -- contributions in these
 areas are very welcome.
 Thank you for your contribution!
 --------------------------------
 .. _Weblate: http://weblate.org/
 .. _issue tracking: https://bitbucket.org/conservancy/kallithea/issues?status=new&status=open
 .. _pull requests: https://bitbucket.org/conservancy/kallithea/pull-requests
 .. _bitbucket: http://bitbucket.org/
 .. _mailing list: http://lists.sfconservancy.org/mailman/listinfo/kallithea-general
 .. _kallithea-general: http://lists.sfconservancy.org/mailman/listinfo/kallithea-general
 .. _Hosted Weblate: https://hosted.weblate.org/projects/kallithea/kallithea/
 .. _wiki: https://bitbucket.org/conservancy/kallithea/wiki/Home
 .. _DebugBar: https://github.com/TurboGears/tgext.debugbar
 .. _Quick Start: https://www.mercurial-scm.org/wiki/QuickStart
 .. _Beginners Guide: https://www.mercurial-scm.org/wiki/BeginnersGuides

docs/dev/dbmigrations.rst

➞

Show inline comments

 =======================
 Database schema changes
 =======================
 Kallithea uses Alembic for :ref:`database migrations <upgrade_db>`
 (upgrades and downgrades).
 If you are developing a Kallithea feature that requires database schema
 changes, you should make a matching Alembic database migration script:
 . :ref:`Create a Kallithea configuration and database <setup>` for testing
    the migration script, or use existing ``development.ini`` setup.
    Ensure that this database is up to date with the latest database
    schema *before* the changes you're currently developing. (Do not
    create the database while your new schema changes are applied.)
 . Create a separate throwaway configuration for iterating on the actual
    database changes::
-    gearbox make-config temp.ini
+    kallithea-cli config-create temp.ini
    Edit the file to change database settings. SQLite is typically fine,
    but make sure to change the path to e.g. ``temp.db``, to avoid
    clobbering any existing database file.
 . Make your code changes (including database schema changes in ``db.py``).
 . After every database schema change, recreate the throwaway database
    to test the changes::
     rm temp.db
     gearbox setup-db -c temp.ini --repos=/var/repos --user=doe --email doe@example.com --password=123456 --no-public-access --force-yes
     gearbox repo-scan -c temp.ini
 . Once satisfied with the schema changes, auto-generate a draft Alembic
    script using the development database that has *not* been upgraded.
    (The generated script will upgrade the database to match the code.)
    ::
     alembic -c development.ini revision -m "area: add cool feature" --autogenerate
 . Edit the script to clean it up and fix any problems.
    Note that for changes that simply add columns, it may be appropriate
    to not remove them in the downgrade script (and instead do nothing),
    to avoid the loss of data. Unknown columns will simply be ignored by
    Kallithea versions predating your changes.
 . Run ``alembic -c development.ini upgrade head`` to apply changes to
    the (non-throwaway) database, and test the upgrade script. Also test
    downgrades.
    The included ``development.ini`` has full SQL logging enabled. If
    you're using another configuration file, you may want to enable it
    by setting ``level = DEBUG`` in section ``[handler_console_sql]``.
 The Alembic migration script should be committed in the same revision as
 the database schema (``db.py``) changes.
 See the `Alembic documentation`__ for more information, in particular
 the tutorial and the section about auto-generating migration scripts.
 .. __: http://alembic.zzzcomputing.com/en/latest/
 Troubleshooting
 ---------------
 * If ``alembic --autogenerate`` responds "Target database is not up to
   date", you need to either first use Alembic to upgrade the database
   to the most recent version (before your changes), or recreate the
   database from scratch (without your schema changes applied).

docs/installation_win.rst

➞

Show inline comments

 .. _installation_win:
 ====================================================
 Installation on Windows (7/Server 2008 R2 and newer)
 ====================================================
 First time install
 ------------------
 Target OS: Windows 7 and newer or Windows Server 2008 R2 and newer
 Tested on Windows 8.1, Windows Server 2008 R2 and Windows Server 2012
 To install on an older version of Windows, see `<installation_win_old.html>`_
 Step 1 -- Install Python
 ^^^^^^^^^^^^^^^^^^^^^^^^
 Install Python 2.x.y (x = 6 or 7). Latest version is recommended. If you need another version, they can run side by side.
 .. warning:: Python 3.x is not supported.
 - Download Python 2.x.y from http://www.python.org/download/
 - Choose and click on the version
 - Click on "Windows X86-64 Installer" for x64 or "Windows x86 MSI installer" for Win32.
 - Disable UAC or run the installer with admin privileges. If you chose to disable UAC, do not forget to reboot afterwards.
 While writing this guide, the latest version was v2.7.9.
 Remember the specific major and minor versions installed, because they will
 be needed in the next step. In this case, it is "2.7".
 Step 2 -- Python BIN
 ^^^^^^^^^^^^^^^^^^^^
 Add Python BIN folder to the path. This can be done manually (editing
 "PATH" environment variable) or by using Windows Support Tools that
 come pre-installed in Windows Vista/7 and later.
 Open a CMD and type::
   SETX PATH "%PATH%;[your-python-path]" /M
 Please substitute [your-python-path] with your Python installation
 path. Typically this is ``C:\\Python27``.
 Step 3 -- Install pywin32 extensions
 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
 Download pywin32 from:
 http://sourceforge.net/projects/pywin32/files/
 - Click on "pywin32" folder
 - Click on the first folder (in this case, Build 219, maybe newer when you try)
 - Choose the file ending with ".amd64-py2.x.exe" (".win32-py2.x.exe"
   for Win32) where x is the minor version of Python you installed.
   When writing this guide, the file was:
   http://sourceforge.net/projects/pywin32/files/pywin32/Build%20219/pywin32-219.win-amd64-py2.7.exe/download
   (x64)
   http://sourceforge.net/projects/pywin32/files/pywin32/Build%20219/pywin32-219.win32-py2.7.exe/download
   (Win32)
 Step 4 -- Install pip
 ^^^^^^^^^^^^^^^^^^^^^
 pip is a package management system for Python. You will need it to install Kallithea and its dependencies.
 If you installed Python 2.7.9+, you already have it (as long as you ran the installer with admin privileges or disabled UAC).
 If it was not installed or if you are using Python>=2.6,<2.7.9:
 - Go to https://bootstrap.pypa.io
 - Right-click on get-pip.py and choose Saves as...
 - Run "python2 get-pip.py" in the folder where you downloaded get-pip.py (may require admin access).
 .. note::
    See http://stackoverflow.com/questions/4750806/how-to-install-pip-on-windows
    for details and alternative methods.
 Note that pip.exe will be placed inside your Python installation's
 Scripts folder, which is likely not on your path. To correct this,
 open a CMD and type::
   SETX PATH "%PATH%;[your-python-path]\Scripts" /M
 Step 5 -- Kallithea folder structure
 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
 Create a Kallithea folder structure.
 This is only an example to install Kallithea. Of course, you can
 change it. However, this guide will follow the proposed structure, so
 please later adapt the paths if you change them. Folders without
 spaces are recommended.
 Create the following folder structure::
   C:\Kallithea
   C:\Kallithea\Bin
   C:\Kallithea\Env
   C:\Kallithea\Repos
 Step 6 -- Install virtualenv
 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^
 .. note::
    A python virtual environment will allow for isolation between the Python packages of your system and those used for Kallithea.
    It is strongly recommended to use it to ensure that Kallithea does not change a dependency that other software uses or vice versa.
 In a command prompt type::
   pip install virtualenv
 Virtualenv will now be inside your Python Scripts path (C:\\Python27\\Scripts or similar).
 To create a virtual environment, run::
   virtualenv C:\Kallithea\Env
 Step 7 -- Install Kallithea
 ^^^^^^^^^^^^^^^^^^^^^^^^^^^
 In order to install Kallithea, you need to be able to run "pip install kallithea". It will use pip to install the Kallithea Python package and its dependencies.
 Some Python packages use managed code and need to be compiled.
 This can be done on Linux without any special steps. On Windows, you will need to install Microsoft Visual C++ compiler for Python 2.7.
 Download and install "Microsoft Visual C++ Compiler for Python 2.7" from http://aka.ms/vcpython27
 .. note::
   You can also install the dependencies using already compiled Windows binaries packages. A good source of compiled Python packages is http://www.lfd.uci.edu/~gohlke/pythonlibs/. However, not all of the necessary packages for Kallithea are on this site and some are hard to find, so we will stick with using the compiler.
 In a command prompt type (adapting paths if necessary)::
   cd C:\Kallithea\Env\Scripts
   activate
   pip install --upgrade pip setuptools
 The prompt will change into "(Env) C:\\Kallithea\\Env\\Scripts" or similar
 (depending of your folder structure). Then type::
   pip install kallithea
 .. note:: This will take some time. Please wait patiently until it is fully
           complete. Some warnings will appear. Don't worry, they are
           normal.
 Step 8 -- Install Git (optional)
 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
 Mercurial being a python package, was installed automatically when doing ``pip install kallithea``.
 You need to install Git manually if you want Kallithea to be able to host Git repositories.
 See http://git-scm.com/book/en/v2/Getting-Started-Installing-Git#Installing-on-Windows for instructions.
 The location of the Git binaries (like ``c:\path\to\git\bin``) must be
 added to the ``PATH`` environment variable so ``git.exe`` and other tools like
 ``gzip.exe`` are available.
 Step 9 -- Configuring Kallithea
 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
 Steps taken from `<setup.html>`_
 You have to use the same command prompt as in Step 7, so if you closed
 it, reopen it following the same commands (including the "activate"
 one). When ready, type::
   cd C:\Kallithea\Bin
-  gearbox make-config my.ini
+  kallithea-cli config-create my.ini
 Then you must edit my.ini to fit your needs (IP address, IP
 port, mail settings, database, etc.). `NotePad++`__ or a similar text
 editor is recommended to properly handle the newline character
 differences between Unix and Windows.
 __ http://notepad-plus-plus.org/
 For the sake of simplicity, run it with the default settings. After your edits (if any) in the previous command prompt, type::
   gearbox setup-db -c my.ini
 .. warning:: This time a *new* database will be installed. You must
              follow a different process to later :ref:`upgrade <upgrade>`
              to a newer Kallithea version.
 The script will ask you for confirmation about creating a new database, answer yes (y)
 The script will ask you for the repository path, answer C:\\Kallithea\\Repos (or similar).
 The script will ask you for the admin username and password, answer "admin" + "123456" (or whatever you want)
 The script will ask you for admin mail, answer "admin@xxxx.com" (or whatever you want).
 If you make a mistake and the script doesn't end, don't worry: start it again.
 If you decided not to install Git, you will get errors about it that you can ignore.
 Step 10 -- Running Kallithea
 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^
 In the previous command prompt, being in the C:\\Kallithea\\Bin folder, type::
   gearbox serve -c my.ini
 Open your web server, and go to http://127.0.0.1:5000
 It works!! :-)
 Remark:
 If it does not work the first time, Ctrl-C the CMD process and start it again. Don't forget the "http://" in Internet Explorer.
 What this guide does not cover:
 - Installing Celery
 - Running Kallithea as a Windows Service. You can investigate here:
   - http://pypi.python.org/pypi/wsgisvc
   - http://ryrobes.com/python/running-python-scripts-as-a-windows-service/
   - http://wiki.pylonshq.com/display/pylonscookbook/How+to+run+Pylons+as+a+Windows+service
 - Using Apache. You can investigate here:
   - https://groups.google.com/group/rhodecode/msg/c433074e813ffdc4

docs/installation_win_old.rst

➞

Show inline comments

 .. _installation_win_old:
 ==========================================================
 Installation on Windows (XP/Vista/Server 2003/Server 2008)
 ==========================================================
 First-time install
 ------------------
 Target OS: Windows XP SP3 32-bit English (Clean installation)
 + All Windows Updates until 24-may-2012
 .. note::
    This installation is for 32-bit systems, for 64-bit Windows you might need
    to download proper 64-bit versions of the different packages (Windows Installer, Win32py extensions)
    plus some extra tweaks.
    These extra steps haven been marked as "64-bit".
    Tested on Windows Server 2008 R2 SP1, 9-feb-2013.
    If you run into any 64-bit related problems, please check these pages:
    - http://blog.victorjabur.com/2011/06/05/compiling-python-2-7-modules-on-windows-32-and-64-using-msvc-2008-express/
    - http://bugs.python.org/issue7511
 Step 1 -- Install Visual Studio 2008 Express
 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
 Optional: You can also install MinGW, but VS2008 installation is easier.
 Download "Visual C++ 2008 Express Edition with SP1" from:
 http://download.microsoft.com/download/E/8/E/E8EEB394-7F42-4963-A2D8-29559B738298/VS2008ExpressWithSP1ENUX1504728.iso
 (if not found or relocated, google for "visual studio 2008 express" for updated link. This link was taken from http://stackoverflow.com/questions/15318560/visual-c-2008-express-download-link-dead)
 You can also download full ISO file for offline installation, just
 choose "All -- Offline Install ISO image file" in the previous page and
 choose "Visual C++ 2008 Express" when installing.
 .. note::
    Using other versions of Visual Studio will lead to random crashes.
    You must use Visual Studio 2008!"
 .. note::
    Silverlight Runtime and SQL Server 2008 Express Edition are not
    required, you can uncheck them
 .. note::
 -bit: You also need to install the Microsoft Windows SDK for .NET 3.5 SP1 (.NET 4.0 won't work).
    Download from: http://www.microsoft.com/en-us/download/details.aspx?id=3138
 .. note::
 -bit: You also need to copy and rename a .bat file to make the Visual C++ compiler work.
    I am not sure why this is not necessary for 32-bit.
    Copy C:\Program Files (x86)\Microsoft Visual Studio 9.0\VC\bin\vcvars64.bat to C:\Program Files (x86)\Microsoft Visual Studio 9.0\VC\bin\amd64\vcvarsamd64.bat
 Step 2 -- Install Python
 ^^^^^^^^^^^^^^^^^^^^^^^^
 Install Python 2.x.y (x = 6 or 7) x86 version (32-bit). DO NOT USE A 3.x version.
 Download Python 2.x.y from:
 http://www.python.org/download/
 Choose "Windows Installer" (32-bit version) not "Windows X86-64
 Installer". While writing this guide, the latest version was v2.7.3.
 Remember the specific major and minor version installed, because it will
 be needed in the next step. In this case, it is "2.7".
 .. note::
 -bit: Just download and install the 64-bit version of python.
 Step 3 -- Install Win32py extensions
 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
 Download pywin32 from:
 http://sourceforge.net/projects/pywin32/files/
 - Click on "pywin32" folder
 - Click on the first folder (in this case, Build 217, maybe newer when you try)
 - Choose the file ending with ".win32-py2.x.exe" -> x being the minor
   version of Python you installed (in this case, 7)
   When writing this guide, the file was:
   http://sourceforge.net/projects/pywin32/files/pywin32/Build%20217/pywin32-217.win32-py2.7.exe/download
   .. note::
 -bit: Download and install the 64-bit version.
      At the time of writing you can find this at:
      http://sourceforge.net/projects/pywin32/files/pywin32/Build%20218/pywin32-218.win-amd64-py2.7.exe/download
 Step 4 -- Python BIN
 ^^^^^^^^^^^^^^^^^^^^
 Add Python BIN folder to the path
 You have to add the Python folder to the path, you can do it manually
 (editing "PATH" environment variable) or using Windows Support Tools
 that came preinstalled in Vista/7 and can be installed in Windows XP.
 - Using support tools on WINDOWS XP:
   If you use Windows XP you can install them using Windows XP CD and
   navigating to \SUPPORT\TOOLS. There, execute Setup.EXE (not MSI).
   Afterwards, open a CMD and type::
     SETX PATH "%PATH%;[your-python-path]" -M
   Close CMD (the path variable will be updated then)
 - Using support tools on WINDOWS Vista/7:
   Open a CMD and type::
     SETX PATH "%PATH%;[your-python-path]" /M
   Please substitute [your-python-path] with your Python installation path.
   Typically: C:\\Python27
 Step 5 -- Kallithea folder structure
 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
 Create a Kallithea folder structure
 This is only a example to install Kallithea, you can of course change
 it. However, this guide will follow the proposed structure, so please
 later adapt the paths if you change them. My recommendation is to use
 folders with NO SPACES. But you can try if you are brave...
 Create the following folder structure::
   C:\Kallithea
   C:\Kallithea\Bin
   C:\Kallithea\Env
   C:\Kallithea\Repos
 Step 6 -- Install virtualenv
 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^
 Install Virtual Env for Python
 Navigate to: http://www.virtualenv.org/en/latest/index.html#installation
 Right click on "virtualenv.py" file and choose "Save link as...".
 Download to C:\\Kallithea (or whatever you want)
 (the file is located at
 https://raw.github.com/pypa/virtualenv/master/virtualenv.py)
 Create a virtual Python environment in C:\\Kallithea\\Env (or similar). To
 do so, open a CMD (Python Path should be included in Step3), navigate
 where you downloaded "virtualenv.py", and write::
   python2 virtualenv.py C:\Kallithea\Env
 (--no-site-packages is now the default behaviour of virtualenv, no need
 to include it)
 Step 7 -- Install Kallithea
 ^^^^^^^^^^^^^^^^^^^^^^^^^^^
 Finally, install Kallithea
 Close previously opened command prompt/s, and open a Visual Studio 2008
 Command Prompt (**IMPORTANT!!**). To do so, go to Start Menu, and then open
 "Microsoft Visual C++ 2008 Express Edition" -> "Visual Studio Tools" ->
 "Visual Studio 2008 Command Prompt"
 .. note::
 -bit: For 64-bit you need to modify the shortcut that is used to start the
    Visual Studio 2008 Command Prompt. Use right-mouse click to open properties.
 Change commandline from::
 %comspec% /k ""C:\Program Files (x86)\Microsoft Visual Studio 9.0\VC\vcvarsall.bat"" x86
 to::
 %comspec% /k ""C:\Program Files (x86)\Microsoft Visual Studio 9.0\VC\vcvarsall.bat"" amd64
 In that CMD (loaded with VS2008 PATHs) type::
   cd C:\Kallithea\Env\Scripts (or similar)
   activate
   pip install --upgrade pip setuptools
 The prompt will change into "(Env) C:\\Kallithea\\Env\\Scripts" or similar
 (depending of your folder structure). Then type::
  pip install kallithea
 (long step, please wait until fully complete)
 Some warnings will appear, don't worry as they are normal.
 Step 8 -- Configuring Kallithea
 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
 steps taken from http://packages.python.org/Kallithea/setup.html
 You have to use the same Visual Studio 2008 command prompt as Step7, so
 if you closed it reopen it following the same commands (including the
 "activate" one). When ready, just type::
   cd C:\Kallithea\Bin
-  gearbox make-config my.ini
+  kallithea-cli config-create my.ini
 Then, you must edit my.ini to fit your needs (network address and
 port, mail settings, database, whatever). I recommend using NotePad++
 (free) or similar text editor, as it handles well the EndOfLine
 character differences between Unix and Windows
 (http://notepad-plus-plus.org/)
 For the sake of simplicity lets run it with the default settings. After
 your edits (if any), in the previous Command Prompt, type::
  gearbox setup-db -c my.ini
 .. warning:: This time a *new* database will be installed. You must
              follow a different process to later :ref:`upgrade <upgrade>`
              to a newer Kallithea version.
 The script will ask you for confirmation about creating a NEW database,
 answer yes (y)
 The script will ask you for repository path, answer C:\\Kallithea\\Repos
 (or similar)
 The script will ask you for admin username and password, answer "admin"
 + "123456" (or whatever you want)
 The script will ask you for admin mail, answer "admin@xxxx.com" (or
 whatever you want)
 If you make some mistake and the script does not end, don't worry, start
 it again.
 Step 9 -- Running Kallithea
 ^^^^^^^^^^^^^^^^^^^^^^^^^^^
 In the previous command prompt, being in the C:\\Kallithea\\Bin folder,
 just type::
  gearbox serve -c my.ini
 Open yout web server, and go to http://127.0.0.1:5000
 It works!! :-)
 Remark:
 If it does not work first time, just Ctrl-C the CMD process and start it
 again. Don't forget the "http://" in Internet Explorer
 What this Guide does not cover:
 - Installing Celery
 - Running Kallithea as Windows Service. You can investigate here:
   - http://pypi.python.org/pypi/wsgisvc
   - http://ryrobes.com/python/running-python-scripts-as-a-windows-service/
   - http://wiki.pylonshq.com/display/pylonscookbook/How+to+run+Pylons+as+a+Windows+service
 - Using Apache. You can investigate here:
   - https://groups.google.com/group/rhodecode/msg/c433074e813ffdc4

docs/setup.rst

➞

Show inline comments

 .. _setup:
 =====
 Setup
 =====
 Preparing front-end
 -------------------
 Temporarily, in the current Kallithea version, some extra steps are required to
 build front-end files:
 Find the right ``kallithea/public/less`` path with::
     python -c "import os, kallithea; print os.path.join(os.path.dirname(os.path.abspath(kallithea.__file__)), 'public', 'less')"
 Then run::
     npm install
     npm run less
 Setting up Kallithea
 --------------------
 First, you will need to create a Kallithea configuration file. Run the
 following command to do so::
-    gearbox make-config my.ini
+    kallithea-cli config-create my.ini
 This will create the file ``my.ini`` in the current directory. This
 configuration file contains the various settings for Kallithea, e.g.
 proxy port, email settings, usage of static files, cache, Celery
 settings, and logging. Extra settings can be specified like::
-    gearbox make-config my.ini host=8.8.8.8 "[handler_console]" formatter=color_formatter
+    kallithea-cli config-create my.ini host=8.8.8.8 "[handler_console]" formatter=color_formatter
 Next, you need to create the databases used by Kallithea. It is recommended to
 use PostgreSQL or SQLite (default). If you choose a database other than the
 default, ensure you properly adjust the database URL in your ``my.ini``
 configuration file to use this other database. Kallithea currently supports
 PostgreSQL, SQLite and MySQL databases. Create the database by running
 the following command::
     gearbox setup-db -c my.ini
 This will prompt you for a "root" path. This "root" path is the location where
 Kallithea will store all of its repositories on the current machine. After
 entering this "root" path ``setup-db`` will also prompt you for a username
 and password for the initial admin account which ``setup-db`` sets
 up for you.
 The ``setup-db`` values can also be given on the command line.
 Example::
     gearbox setup-db -c my.ini --user=nn --password=secret --email=nn@example.com --repos=/srv/repos
 The ``setup-db`` command will create all needed tables and an
 admin account. When choosing a root path you can either use a new
 empty location, or a location which already contains existing
 repositories. If you choose a location which contains existing
 repositories Kallithea will add all of the repositories at the chosen
 location to its database.  (Note: make sure you specify the correct
 path to the root).
 .. note:: the given path for Mercurial_ repositories **must** be write
           accessible for the application. It's very important since
           the Kallithea web interface will work without write access,
           but when trying to do a push it will fail with permission
           denied errors unless it has write access.
 You are now ready to use Kallithea. To run it simply execute::
     gearbox serve -c my.ini
 - This command runs the Kallithea server. The web app should be available at
   http://127.0.0.1:5000. The IP address and port is configurable via the
   configuration file created in the previous step.
 - Log in to Kallithea using the admin account created when running ``setup-db``.
 - The default permissions on each repository is read, and the owner is admin.
   Remember to update these if needed.
 - In the admin panel you can toggle LDAP, anonymous, and permissions
   settings, as well as edit more advanced options on users and
   repositories.
 Internationalization (i18n support)
 -----------------------------------
 The Kallithea web interface is automatically displayed in the user's preferred
 language, as indicated by the browser. Thus, different users may see the
 application in different languages. If the requested language is not available
 (because the translation file for that language does not yet exist or is
 incomplete), the language specified in setting ``i18n.lang`` in the Kallithea
 configuration file is used as fallback. If no fallback language is explicitly
 specified, English is used.
 If you want to disable automatic language detection and instead configure a
 fixed language regardless of user preference, set ``i18n.enabled = false`` and
 set ``i18n.lang`` to the desired language (or leave empty for English).
 Using Kallithea with SSH
 ------------------------
 Kallithea currently only hosts repositories using http and https. (The addition
 of ssh hosting is a planned future feature.) However you can easily use ssh in
 parallel with Kallithea. (Repository access via ssh is a standard "out of
 the box" feature of Mercurial_ and you can use this to access any of the
 repositories that Kallithea is hosting. See PublishingRepositories_)
 Kallithea repository structures are kept in directories with the same name
 as the project. When using repository groups, each group is a subdirectory.
 This allows you to easily use ssh for accessing repositories.
 In order to use ssh you need to make sure that your web server and the users'
 login accounts have the correct permissions set on the appropriate directories.
 .. note:: These permissions are independent of any permissions you
           have set up using the Kallithea web interface.
 If your main directory (the same as set in Kallithea settings) is for
 example set to ``/srv/repos`` and the repository you are using is
 named ``kallithea``, then to clone via ssh you should run::
     hg clone ssh://user@kallithea.example.com/srv/repos/kallithea
 Using other external tools such as mercurial-server_ or using ssh key-based
 authentication is fully supported.
 .. note:: In an advanced setup, in order for your ssh access to use
           the same permissions as set up via the Kallithea web
           interface, you can create an authentication hook to connect
           to the Kallithea db and run check functions for permissions
           against that.
 Setting up Whoosh full text search
 ----------------------------------
 Kallithea provides full text search of repositories using `Whoosh`__.
 .. __: https://whoosh.readthedocs.io/en/latest/
 For an incremental index build, run::
     gearbox make-index -c my.ini
 For a full index rebuild, run::
     gearbox make-index -c my.ini -f
 The ``--repo-location`` option allows the location of the repositories to be overridden;
 usually, the location is retrieved from the Kallithea database.
 The ``--index-only`` option can be used to limit the indexed repositories to a comma-separated list::
     gearbox make-index -c my.ini --index-only=vcs,kallithea
 To keep your index up-to-date it is necessary to do periodic index builds;
 for this, it is recommended to use a crontab entry. Example::
 3  *  *  *  /path/to/virtualenv/bin/gearbox make-index -c /path/to/kallithea/my.ini
 When using incremental mode (the default), Whoosh will check the last
 modification date of each file and add it to be reindexed if a newer file is
 available. The indexing daemon checks for any removed files and removes them
 from index.
 If you want to rebuild the index from scratch, you can use the ``-f`` flag as above,
 or in the admin panel you can check the "build from scratch" checkbox.
 Integration with issue trackers
 -------------------------------
 Kallithea provides a simple integration with issue trackers. It's possible
 to define a regular expression that will match an issue ID in commit messages,
 and have that replaced with a URL to the issue.
 This is achieved with following three variables in the ini file::
     issue_pat = #(\d+)
     issue_server_link = https://issues.example.com/{repo}/issue/\1
     issue_sub =
 ``issue_pat`` is the regular expression describing which strings in
 commit messages will be treated as issue references. The expression can/should
 have one or more parenthesized groups that can later be referred to in
 ``issue_server_link`` and ``issue_sub`` (see below). If you prefer, named groups
 can be used instead of simple parenthesized groups.
 If the pattern should only match if it is preceded by whitespace, add the
 following string before the actual pattern: ``(?:^|(?<=\s))``.
 If the pattern should only match if it is followed by whitespace, add the
 following string after the actual pattern: ``(?:$|(?=\s))``.
 These expressions use lookbehind and lookahead assertions of the Python regular
 expression module to avoid the whitespace to be part of the actual pattern,
 otherwise the link text will also contain that whitespace.
 Matched issue references are replaced with the link specified in
 ``issue_server_link``, in which any backreferences are resolved. Backreferences
 can be ``\1``, ``\2``, ... or for named groups ``\g<groupname>``.
 The special token ``{repo}`` is replaced with the full repository path
 (including repository groups), while token ``{repo_name}`` is replaced with the
 repository name (without repository groups).
 The link text is determined by ``issue_sub``, which can be a string containing
 backreferences to the groups specified in ``issue_pat``. If ``issue_sub`` is
 empty, then the text matched by ``issue_pat`` is used verbatim.
 The example settings shown above match issues in the format ``#<number>``.
 This will cause the text ``#300`` to be transformed into a link:
 .. code-block:: html
   <a href="https://issues.example.com/example_repo/issue/300">#300</a>
 The following example transforms a text starting with either of 'pullrequest',
 'pull request' or 'PR', followed by an optional space, then a pound character
 (#) and one or more digits, into a link with the text 'PR #' followed by the
 digits::
     issue_pat = (pullrequest|pull request|PR) ?#(\d+)
     issue_server_link = https://issues.example.com/\2
     issue_sub = PR #\2
 The following example demonstrates how to require whitespace before the issue
 reference in order for it to be recognized, such that the text ``issue#123`` will
 not cause a match, but ``issue #123`` will::
     issue_pat = (?:^|(?<=\s))#(\d+)
     issue_server_link = https://issues.example.com/\1
     issue_sub =
 If needed, more than one pattern can be specified by appending a unique suffix to
 the variables. For example, also demonstrating the use of named groups::
     issue_pat_wiki = wiki-(?P<pagename>\S+)
     issue_server_link_wiki = https://wiki.example.com/\g<pagename>
     issue_sub_wiki = WIKI-\g<pagename>
 With these settings, wiki pages can be referenced as wiki-some-id, and every
 such reference will be transformed into:
 .. code-block:: html
   <a href="https://wiki.example.com/some-id">WIKI-some-id</a>
 Refer to the `Python regular expression documentation`_ for more details about
 the supported syntax in ``issue_pat``, ``issue_server_link`` and ``issue_sub``.
 Hook management
 ---------------
 Hooks can be managed in similar way to that used in ``.hgrc`` files.
 To manage hooks, choose *Admin > Settings > Hooks*.
 The built-in hooks cannot be modified, though they can be enabled or disabled in the *VCS* section.
 To add another custom hook simply fill in the first textbox with
 ``<name>.<hook_type>`` and the second with the hook path. Example hooks
 can be found in ``kallithea.lib.hooks``.
 Changing default encoding
 -------------------------
 By default, Kallithea uses UTF-8 encoding.
 This is configurable as ``default_encoding`` in the .ini file.
 This affects many parts in Kallithea including user names, filenames, and
 encoding of commit messages. In addition Kallithea can detect if the ``chardet``
 library is installed. If ``chardet`` is detected Kallithea will fallback to it
 when there are encode/decode errors.
 The Mercurial encoding is configurable as ``hgencoding``. It is similar to
 setting the ``HGENCODING`` environment variable, but will override it.
 Celery configuration
 --------------------
 Kallithea can use the distributed task queue system Celery_ to run tasks like
 cloning repositories or sending emails.
 Kallithea will in most setups work perfectly fine out of the box (without
 Celery), executing all tasks in the web server process. Some tasks can however
 take some time to run and it can be better to run such tasks asynchronously in
 a separate process so the web server can focus on serving web requests.
 For installation and configuration of Celery, see the `Celery documentation`_.
 Note that Celery requires a message broker service like RabbitMQ_ (recommended)
 or Redis_.
 The use of Celery is configured in the Kallithea ini configuration file.
 To enable it, simply set::
   use_celery = true
 and add or change the ``celery.*`` and ``broker.*`` configuration variables.
 Remember that the ini files use the format with '.' and not with '_' like
 Celery. So for example setting `BROKER_HOST` in Celery means setting
 `broker.host` in the configuration file.
 To start the Celery process, run::
   gearbox celeryd -c my.ini
 Extra options to the Celery worker can be passed after ``--`` - see ``-- -h``
 for more info.
 .. note::
    Make sure you run this command from the same virtualenv, and with the same
    user that Kallithea runs.
 HTTPS support
 -------------
 Kallithea will by default generate URLs based on the WSGI environment.
 Alternatively, you can use some special configuration settings to control
 directly which scheme/protocol Kallithea will use when generating URLs:
 - With ``https_fixup = true``, the scheme will be taken from the
   ``X-Url-Scheme``, ``X-Forwarded-Scheme`` or ``X-Forwarded-Proto`` HTTP header
   (default ``http``).
 - With ``force_https = true`` the default will be ``https``.
 - With ``use_htsts = true``, Kallithea will set ``Strict-Transport-Security`` when using https.
 .. _nginx_virtual_host:
 Nginx virtual host example
 --------------------------
 Sample config for Nginx using proxy:
 .. code-block:: nginx
     upstream kallithea {
         server 127.0.0.1:5000;
         # add more instances for load balancing
         #server 127.0.0.1:5001;
         #server 127.0.0.1:5002;
+    }
     ## gist alias
     server {
        listen          443;
        server_name     gist.example.com;
        access_log      /var/log/nginx/gist.access.log;
        error_log       /var/log/nginx/gist.error.log;
        ssl on;
        ssl_certificate     gist.your.kallithea.server.crt;
        ssl_certificate_key gist.your.kallithea.server.key;
        ssl_session_timeout 5m;
        ssl_protocols SSLv3 TLSv1;
        ssl_ciphers DHE-RSA-AES256-SHA:DHE-RSA-AES128-SHA:EDH-RSA-DES-CBC3-SHA:AES256-SHA:DES-CBC3-SHA:AES128-SHA:RC4-SHA:RC4-MD5;
        ssl_prefer_server_ciphers on;
        rewrite ^/(.+)$ https://kallithea.example.com/_admin/gists/$1;
        rewrite (.*)    https://kallithea.example.com/_admin/gists;
+    }
     server {
        listen          443;
        server_name     kallithea.example.com
        access_log      /var/log/nginx/kallithea.access.log;
        error_log       /var/log/nginx/kallithea.error.log;
        ssl on;
        ssl_certificate     your.kallithea.server.crt;
        ssl_certificate_key your.kallithea.server.key;
        ssl_session_timeout 5m;
        ssl_protocols SSLv3 TLSv1;
        ssl_ciphers DHE-RSA-AES256-SHA:DHE-RSA-AES128-SHA:EDH-RSA-DES-CBC3-SHA:AES256-SHA:DES-CBC3-SHA:AES128-SHA:RC4-SHA:RC4-MD5;
        ssl_prefer_server_ciphers on;
        ## uncomment root directive if you want to serve static files by nginx
        ## requires static_files = false in .ini file
        #root /srv/kallithea/kallithea/kallithea/public;
        include         /etc/nginx/proxy.conf;
        location / {
             try_files $uri @kallithea;
+       }
        location @kallithea {
             proxy_pass      http://127.0.0.1:5000;
+       }
+    }
 Here's the proxy.conf. It's tuned so it will not timeout on long
 pushes or large pushes::
     proxy_redirect              off;
     proxy_set_header            Host $host;
     ## needed for container auth
     #proxy_set_header            REMOTE_USER $remote_user;
     #proxy_set_header            X-Forwarded-User $remote_user;
     proxy_set_header            X-Url-Scheme $scheme;
     proxy_set_header            X-Host $http_host;
     proxy_set_header            X-Real-IP $remote_addr;
     proxy_set_header            X-Forwarded-For $proxy_add_x_forwarded_for;
     proxy_set_header            Proxy-host $proxy_host;
     proxy_buffering             off;
     proxy_connect_timeout       7200;
     proxy_send_timeout          7200;
     proxy_read_timeout          7200;
     proxy_buffers               8 32k;
     client_max_body_size        1024m;
     client_body_buffer_size     128k;

docs/upgrade.rst

➞

Show inline comments

 .. _upgrade:
 ===================
 Upgrading Kallithea
 ===================
 This describes the process for upgrading Kallithea, independently of the
 Kallithea installation method.
 .. note::
     If you are upgrading from a RhodeCode installation, you must first
     install Kallithea 0.3.2 and follow the instructions in the 0.3.2
     README to perform a one-time conversion of the database from
     RhodeCode to Kallithea, before upgrading to the latest version
     of Kallithea.
 . Stop the Kallithea web application
 -------------------------------------
 This step depends entirely on the web server software used to serve
 Kallithea, but in any case, Kallithea should not be running during
 the upgrade.
 .. note::
     If you're using Celery, make sure you stop all instances during the
     upgrade.
 . Create a backup of both database and configuration
 -----------------------------------------------------
 You are of course strongly recommended to make backups regularly, but it
 is *especially* important to make a full database and configuration
 backup before performing a Kallithea upgrade.
 Back up your configuration
 ^^^^^^^^^^^^^^^^^^^^^^^^^^
 Make a copy of your Kallithea configuration (``.ini``) file.
 If you are using :ref:`rcextensions <customization>`, you should also
 make a copy of the entire ``rcextensions`` directory.
 Back up your database
 ^^^^^^^^^^^^^^^^^^^^^
 If using SQLite, simply make a copy of the Kallithea database (``.db``)
 file.
 If using PostgreSQL, please consult the documentation for the ``pg_dump``
 utility.
 If using MySQL, please consult the documentation for the ``mysqldump``
 utility.
 Look for ``sqlalchemy.url`` in your configuration file to determine
 database type, settings, location, etc.
 . Activate the Kallithea virtual environment (if any)
 ------------------------------------------------------
 Verify that you are using the Python environment that you originally
 installed Kallithea in by running::
     pip freeze
 This will list all packages installed in the current environment. If
 Kallithea isn't listed, activate the correct virtual environment.
 See the appropriate installation page for details.
 . Install new version of Kallithea
 -----------------------------------
 Please refer to the instructions for the installation method you
 originally used to install Kallithea.
 If you originally installed using pip, it is as simple as::
     pip install --upgrade kallithea
 If you originally installed from version control, it is as simple as::
     cd my-kallithea-clone
     hg pull -u
     pip install --upgrade -e .
 Temporarily, in the current version, an extra step is required to build
 front-end files:
 Find the right ``kallithea/public/less`` path with::
     python -c "import os, kallithea; print os.path.join(os.path.dirname(os.path.abspath(kallithea.__file__)), 'public', 'less')"
 Then run::
     npm install
     npm run less
 . Upgrade your configuration
 -----------------------------
 Run the following command to create a new configuration (``.ini``) file::
-    gearbox make-config new.ini
+    kallithea-cli config-create new.ini
 Then compare it with your old config file and see what changed.
 .. note::
     Please always make sure your ``.ini`` files are up to date. Errors
     can often be caused by missing parameters added in new versions.
 .. _upgrade_db:
 . Upgrade your database
 ------------------------
 .. note::
     If you are *downgrading* Kallithea, you should perform the database
     migration step *before* installing the older version. (That is,
     always perform migrations using the most recent of the two versions
     you're migrating between.)
 First, run the following command to see your current database version::
     alembic -c my.ini current
 Typical output will be something like "9358dc3d6828 (head)", which is
 the current Alembic database "revision ID". Write down the entire output
 for troubleshooting purposes.
 The output will be empty if you're upgrading from Kallithea 0.3.x or
 older. That's expected. If you get an error that the config file was not
 found or has no ``[alembic]`` section, see the next section.
 Next, if you are performing an *upgrade*: Run the following command to
 upgrade your database to the current Kallithea version::
     alembic -c my.ini upgrade head
 If you are performing a *downgrade*: Run the following command to
 downgrade your database to the given version::
     alembic -c my.ini downgrade 0.4
 Alembic will show the necessary migrations (if any) as it executes them.
 If no "ERROR" is displayed, the command was successful.
 Should an error occur, the database may be "stranded" half-way
 through the migration, and you should restore it from backup.
 Enabling old Kallithea config files for Alembic use
 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
 Kallithea configuration files created before the introduction of Alembic
 (i.e. predating Kallithea 0.4) need to be updated for use with Alembic.
 Without this, Alembic will fail with an error like this::
     FAILED: No config file 'my.ini' found, or file has no '[alembic]' section
 If Alembic complains specifically about a missing ``alembic.ini``, it is
 likely because you did not specify a config file using the ``-c`` option.
 On the other hand, if the mentioned config file actually exists, you
 need to append the following lines to it::
     [alembic]
     script_location = kallithea:alembic
 Your config file should now work with Alembic.
 . Update Git repository hooks
 ------------------------------
 It is possible that an upgrade involves changes to the Git hooks installed by
 Kallithea. As these hooks are created inside the repositories on the server
 filesystem, they are not updated automatically when upgrading Kallithea itself.
 To update the hooks of your Git repositories:
 * Go to *Admin > Settings > Remap and Rescan*
 * Select the checkbox *Install Git hooks*
 * Click the button *Rescan repositories*
 .. note::
     Kallithea does not use hooks on Mercurial repositories. This step is thus
     not necessary if you only have Mercurial repositories.
 . Rebuild the Whoosh full-text index
 -------------------------------------
 It is recommended that you rebuild the Whoosh index after upgrading since
 new Whoosh versions can introduce incompatible index changes.
 . Start the Kallithea web application
 --------------------------------------
 This step once again depends entirely on the web server software used to
 serve Kallithea.
 Before starting the new version of Kallithea, you may find it helpful to
 clear out your log file so that new errors are readily apparent.
 .. note::
     If you're using Celery, make sure you restart all instances of it after
     upgrade.
 .. _virtualenv: http://pypi.python.org/pypi/virtualenv

kallithea/bin/kallithea_cli.py

➞

Show inline comments

 # -*- coding: utf-8 -*-
 # This program is free software: you can redistribute it and/or modify
 # it under the terms of the GNU General Public License as published by
 # the Free Software Foundation, either version 3 of the License, or
 # (at your option) any later version.
+#
 # This program is distributed in the hope that it will be useful,
 # but WITHOUT ANY WARRANTY; without even the implied warranty of
 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 # GNU General Public License for more details.
+#
 # You should have received a copy of the GNU General Public License
 # along with this program.  If not, see <http://www.gnu.org/licenses/>.
 # 'cli' is the main entry point for 'kallithea-cli', specified in setup.py as entry_points console_scripts
 from kallithea.bin.kallithea_cli_base import cli
 # import commands (they will add themselves to the 'cli' object)
 import kallithea.bin.kallithea_cli_config

kallithea/bin/kallithea_cli_config.py

➞

Show inline comments

 # -*- coding: utf-8 -*-
 # This program is free software: you can redistribute it and/or modify
 # it under the terms of the GNU General Public License as published by
 # the Free Software Foundation, either version 3 of the License, or
 # (at your option) any later version.
+#
 # This program is distributed in the hope that it will be useful,
 # but WITHOUT ANY WARRANTY; without even the implied warranty of
 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 # GNU General Public License for more details.
+#
 # You should have received a copy of the GNU General Public License
 # along with this program.  If not, see <http://www.gnu.org/licenses/>.
 """
 kallithea.lib.paster_commands.make_config
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 make-config gearbox command for Kallithea
 :license: GPLv3, see LICENSE.md for more details.
 """
 import click
 import kallithea.bin.kallithea_cli_base as cli_base
 import os
 import sys
 import uuid
 import argparse
 from collections import defaultdict
 import mako.exceptions
 from kallithea.lib.paster_commands.common import BasePasterCommand
 from kallithea.lib import inifile
 def show_defaults(ctx, param, value):
     # Following construct is taken from the Click documentation:
     # https://click.palletsprojects.com/en/7.x/options/#callbacks-and-eager-options
     # "The resilient_parsing flag is applied to the context if Click wants to
     # parse the command line without any destructive behavior that would change
     # the execution flow. In this case, because we would exit the program, we
     # instead do nothing."
     if not value or ctx.resilient_parsing:
         return
 class Command(BasePasterCommand):
     """Kallithea: Create a new config file
     for key, value in inifile.default_variables.items():
         click.echo('%s=%s' % (key, value))
     make-config is the first part of the two step setup process. This first
     step creates a customized .ini configuration file. The next step is to run
     setup-db to populate the database that is referenced in the configuration
     file.
     ctx.exit()
 @cli_base.register_command()
 @click.option('--show-defaults', callback=show_defaults,
               is_flag=True, expose_value=False, is_eager=True,
               help='Show the default values that can be overridden')
 @click.argument('config_file', type=click.Path(dir_okay=False, writable=True), required=True)
 @click.argument('key_value_pairs', nargs=-1)
 def config_create(config_file, key_value_pairs):
     """Create a new configuration file.
     This command creates a default configuration file, possibly adding/updating
     settings you specify.
     The primary high level configuration keys and their default values are
     shown with --show-defaults . Custom values can be specified on the command
     line as key=value arguments when creating a config file.
     shown with --show-defaults . Custom values for these keys can be specified
     on the command line as key=value arguments.
     Additional key=value arguments will be patched/inserted in the [app:main]
     section ... until another section name specifies where any following values
     should go.
     """
     takes_config_file = False # at least not an existing one ...
     def take_action(self, args):
         _run(args)
     def get_parser(self, prog_name):
         parser = super(Command, self).get_parser(prog_name)
         parser.add_argument('config_file', nargs='?',
             help='application config file to write')
         parser.add_argument('custom', nargs=argparse.REMAINDER,
             help='"key=value" for customizing the config file')
         parser.add_argument('--show-defaults', action='store_true',
             help="Show the default values that can be overridden")
         return parser
 def _run(args):
     if args.show_defaults:
         if args.config_file is not None:
             raise ValueError("Can't specify both config file and --show-defaults")
         for key, value in inifile.default_variables.items():
             print '%s=%s' % (key, value)
         sys.exit(0)
     if args.config_file is None:
         raise ValueError("Missing argument: config file")
     mako_variable_values = {}
     ini_settings = defaultdict(dict)
     section_name = None
-    for parameter in args.custom:
+    for parameter in key_value_pairs:
         parts = parameter.split('=', 1)
         if len(parts) == 1 and parameter.startswith('[') and parameter.endswith(']'):
             section_name = parameter
         elif len(parts) == 2:
             key, value = parts
             if section_name is None and key in inifile.default_variables:
                 mako_variable_values[key] = value
             else:
                 if section_name is None:
                     section_name = '[app:main]'
                 ini_settings[section_name][key] = value
         else:
             raise ValueError("Invalid name=value parameter %r" % parameter)
     # use default that cannot be replaced
     mako_variable_values.update({
         'uuid': lambda: uuid.uuid4().hex,
     })
     try:
         config_file = os.path.abspath(args.config_file)
         inifile.create(config_file, mako_variable_values, ini_settings)
         print 'Wrote new config file in %s' % config_file
         config_file_abs = os.path.abspath(config_file)
         inifile.create(config_file_abs, mako_variable_values, ini_settings)
         click.echo('Wrote new config file in %s' % config_file_abs)
     except Exception:
-        print mako.exceptions.text_error_template().render()
+        click.echo(mako.exceptions.text_error_template().render())

setup.py

➞

Show inline comments

 #!/usr/bin/env python2
 # -*- coding: utf-8 -*-
 import os
 import sys
 import platform
 if sys.version_info < (2, 6) or sys.version_info >= (3,):
     raise Exception('Kallithea requires python 2.6 or 2.7')
 here = os.path.abspath(os.path.dirname(__file__))
 def _get_meta_var(name, data, callback_handler=None):
     import re
     matches = re.compile(r'(?:%s)\s*=\s*(.*)' % name).search(data)
     if matches:
         if not callable(callback_handler):
             callback_handler = lambda v: v
         return callback_handler(eval(matches.groups()[0]))
 _meta = open(os.path.join(here, 'kallithea', '__init__.py'), 'rb')
 _metadata = _meta.read()
 _meta.close()
 callback = lambda V: ('.'.join(map(str, V[:3])) + '.'.join(V[3:]))
 __version__ = _get_meta_var('VERSION', _metadata, callback)
 __license__ = _get_meta_var('__license__', _metadata)
 __author__ = _get_meta_var('__author__', _metadata)
 __url__ = _get_meta_var('__url__', _metadata)
 # defines current platform
 __platform__ = platform.system()
 is_windows = __platform__ in ['Windows']
 requirements = [
     "alembic >= 0.8.0, < 1.1",
     "gearbox < 1",
     "waitress >= 0.8.8, < 1.2",
     "WebOb >= 1.7, < 1.8", # turbogears2 2.3.12 requires WebOb<1.8.0
     "backlash >= 0.1.2, < 1",
     "TurboGears2 >= 2.3.10, < 3",
     "tgext.routes >= 0.2.0, < 1",
     "Beaker >= 1.7.0, < 2",
     "WebHelpers >= 1.3, < 1.4",
     "FormEncode >= 1.2.4, < 1.4",
     "SQLAlchemy >= 1.1, < 1.3",
     "Mako >= 0.9.0, < 1.1",
     "Pygments >= 1.5, < 2.3",
     "Whoosh >= 2.5.0, < 2.8",
     "celery >= 3.1, < 4.0", # celery 4 doesn't work
     "Babel >= 0.9.6, < 2.7",
     "python-dateutil >= 1.5.0, < 2.8",
     "Markdown >= 2.2.1, < 2.7",
     "docutils >= 0.8.1, < 0.15",
     "URLObject >= 2.3.4, < 2.5",
     "Routes >= 1.13, < 2",
     "dulwich >= 0.14.1, < 0.20",
     "mercurial >= 4.1.1, < 4.9",
     "decorator >= 3.3.2, < 4.4",
     "Paste >= 2.0.3, < 3",
     "bleach >= 3.0, < 3.1",
     "Click >= 7.0, < 8",
+]
 if sys.version_info < (2, 7):
     requirements.append("importlib == 1.0.1")
     requirements.append("argparse")
 if not is_windows:
     requirements.append("bcrypt >= 3.1.0, < 3.2")
 dependency_links = [
+]
 classifiers = [
     'Development Status :: 4 - Beta',
     'Environment :: Web Environment',
     'Framework :: Pylons',
     'Intended Audience :: Developers',
     'License :: OSI Approved :: GNU General Public License (GPL)',
     'Operating System :: OS Independent',
     'Programming Language :: Python',
     'Programming Language :: Python :: 2.6',
     'Programming Language :: Python :: 2.7',
     'Topic :: Software Development :: Version Control',
+]
 # additional files from project that goes somewhere in the filesystem
 # relative to sys.prefix
 data_files = []
 description = ('Kallithea is a fast and powerful management tool '
                'for Mercurial and Git with a built in push/pull server, '
                'full text search and code-review.')
 keywords = ' '.join([
     'kallithea', 'mercurial', 'git', 'code review',
     'repo groups', 'ldap', 'repository management', 'hgweb replacement',
     'hgwebdir', 'gitweb replacement', 'serving hgweb',
 ])
 # long description
 README_FILE = 'README.rst'
 try:
     long_description = open(README_FILE).read()
 except IOError as err:
     sys.stderr.write(
         "[WARNING] Cannot find file specified as long_description (%s)\n"
         % README_FILE
+    )
     long_description = description
 import setuptools
 # monkey patch setuptools to use distutils owner/group functionality
 from setuptools.command import sdist
 sdist_org = sdist.sdist
 class sdist_new(sdist_org):
     def initialize_options(self):
         sdist_org.initialize_options(self)
         self.owner = self.group = 'root'
 sdist.sdist = sdist_new
 packages = setuptools.find_packages(exclude=['ez_setup'])
 setuptools.setup(
     name='Kallithea',
     version=__version__,
     description=description,
     long_description=long_description,
     keywords=keywords,
     license=__license__,
     author=__author__,
     author_email='kallithea@sfconservancy.org',
     dependency_links=dependency_links,
     url=__url__,
     install_requires=requirements,
     classifiers=classifiers,
     data_files=data_files,
     packages=packages,
     include_package_data=True,
     message_extractors={'kallithea': [
             ('**.py', 'python', None),
             ('templates/**.mako', 'mako', {'input_encoding': 'utf-8'}),
             ('templates/**.html', 'mako', {'input_encoding': 'utf-8'}),
             ('public/**', 'ignore', None)]},
     zip_safe=False,
     entry_points="""
     [console_scripts]
     kallithea-api =    kallithea.bin.kallithea_api:main
     kallithea-gist =   kallithea.bin.kallithea_gist:main
     kallithea-config = kallithea.bin.kallithea_config:main
     kallithea-cli =    kallithea.bin.kallithea_cli:cli
     [paste.app_factory]
     main = kallithea.config.middleware:make_app
     [gearbox.commands]
     cache-keys=kallithea.lib.paster_commands.cache_keys:Command
     celeryd=kallithea.lib.paster_commands.celeryd:Command
     cleanup-repos=kallithea.lib.paster_commands.cleanup:Command
     install-iis=kallithea.lib.paster_commands.install_iis:Command
     ishell=kallithea.lib.paster_commands.ishell:Command
     make-config=kallithea.lib.paster_commands.make_config:Command
     make-index=kallithea.lib.paster_commands.make_index:Command
     make-rcext=kallithea.lib.paster_commands.make_rcextensions:Command
     repo-scan=kallithea.lib.paster_commands.repo_scan:Command
     setup-db=kallithea.lib.paster_commands.setup_db:Command
     update-repoinfo=kallithea.lib.paster_commands.update_repoinfo:Command
     upgrade-db=kallithea.lib.dbmigrate:UpgradeDb
     """,
+)

0 comments (0 inline, 0 general)