Changes between Version 1 and Version 2 of WikiStart


Ignore:
Timestamp:
08/02/21 09:37:11 (3 years ago)
Author:
wouter
Comment:

--

Legend:

Unmodified
Added
Removed
Modified

  • WikiStart

    v1 v2  
    1 = Welcome to Trac
     1[[PageOutline]]
    22
    3 Trac is a '''minimalistic''' approach to '''web-based''' management of
    4 '''software projects'''. Its goal is to simplify effective tracking and
    5 handling of software issues, enhancements and overall progress.
     3= GeniusWebPython Parties Server
     4This is the homepage of the GeniusWeb parties server. This server can provide a list of runnable parties, and create running instances of specified parties on a HTPT GET request. When an instance is made, a websocket link to the running party is provided to the caller.
    65
    7 All aspects of Trac have been designed with the single goal to
    8 '''help developers write great software''' while '''staying out of the way'''
    9 and imposing as little as possible on a team's established process and
    10 culture.
     6The GeniusWeb main page is [https://tracinsy.ewi.tudelft.nl/pubtrac/GeniusWeb here].
    117
    12 As all Wiki pages, this page is editable, this means that you can
    13 modify the contents of this page simply by using your
    14 web-browser. Simply click on the "Edit this page" link at the bottom
    15 of the page. WikiFormatting will give you a detailed description of
    16 available Wiki formatting commands.
     8The Parties server runs on Tomcat 8 and is developed with Eclipse EE.
    179
    18 "[wiki:TracAdmin trac-admin] ''yourenvdir'' initenv" created
    19 a new Trac environment, containing a default set of wiki pages and some sample
    20 data. This newly created environment also contains
    21 [wiki:TracGuide documentation] to help you get started with your project.
     10This server behaves almost identical to the java-oriented [https://tracinsy.ewi.tudelft.nl/pubtrac/GeniusWebPartiesServer partiesserver] and in fact is mostly a copy of it. The main difference is that this server can run python parties instead of java-based parties.
    2211
    23 You can use [wiki:TracAdmin trac-admin] to configure
    24 [http://trac.edgewall.org/ Trac] to better fit your project, especially in
    25 regard to ''components'', ''versions'' and ''milestones''.
     12The only difference is that in this server, instead of java-based parties inside a jar file, you plug in python-based parties inside a tar.gz file.
     13
     14== Installation ==
     15* Have python **3.8 or 3.9** installed on your machine, for use with the pythonpartiesserver.
     16* Install your apache-tomcat 8 installation ​https://tomcat.apache.org/download-80.cgi. You can re-use an existing installation.
     17* Download the parties server war file from [http://artifactory.ewi.tudelft.nl/artifactory/webapp/#/artifacts/browse/tree/General/libs-release-local/geniusweb/pypartiesserver the artifactory]. Go into the latest version of the pypartiesserver and download (right click) the war file. NOTICE: your browser must have cookies enabled to access the artifactory.
     18* Copy the downloaded war file into the tomcat webapps directory
     19* Set the environment variable PYTHON3EXE to point to python 3.8 or 3.9 (the python application you installed).
     20* (Re)start tomcat
     21
     22Now your local pypartiesserver should be up and running.
     23
     24== Upgrade
     25To upgrade,
     26* Stop tomcat
     27* remove the old war file plus the unzipped version (if exists) from the tomcat webapps directory
     28* repeat the installation as above
    2629
    2730
    28 TracGuide is a good place to start.
     31= GUI
     32After installing and starting, go to [http://localhost:8080/pypartiesserver-2.0.0] (replace 2.0.0 with the version you installed). You should get this webpage
    2933
    30 Enjoy! [[BR]]
    31 ''The Trac Team''
     34[[Image(home.png)]]
    3235
    33 == Starting Points
     36To create your own parties, refer to [https://tracinsy.ewi.tudelft.nl/pubtrac/GeniusWebPython/wiki/WikiStart#Writingaparty  Writing a party].
    3437
    35  * TracGuide --  Built-in Documentation
    36  * [http://trac.edgewall.org/ The Trac project] -- Trac Open Source Project
    37  * [http://trac.edgewall.org/wiki/TracFaq Trac FAQ] -- Frequently Asked Questions
    38  * TracSupport --  Trac Support
     38== Adding or changing a Party
    3939
    40 For a complete list of local wiki pages, see TitleIndex.
     40To change a profile or add a new party,
     41
     42* Make sure the profiles server has been run (apache will unzip the war file)
     43* Locate the unzipped pypartiesserver folder inside your tomcat webapps directory
     44* locate the partiesrepo directory inside that folder. This folder contains all current parties
     45* Copy your new version of a party.tar.gz over an existing one. Or copy a new party.tar.gz into this folder.
     46* The parties should now show up in the "list of party files" on the server webpage. Make sure you force refresh the page as some browsers show only old cached data.
     47* If the file is visible in that list, but does not show up in list of "currently runnable parties" then the tar.gz does not contain a valid party. Check the apache tomcat logs to see why the tar.gz has been rejected.
     48
     49
     50
     51= Log file
     52The log file name can be set by the party in its constructor. If it uses the default (None),
     53then the party class name is used as log filename, and {{{.log}}} as extension.
     54
     55The {{{.log}}} file is in the directory where you start the server
     56If you run from tomcat, it often is in the Eclipse application directory, eg in {{{Eclipse2020EE.app/Contents/MacOS}}}; if you manually start it, in the directory where you executed the startup.sh command; etc.
     57
     58= Debugging
     59Debugging on the server is complicated because python programs are run as native processes, and thus are not directly controlled by your IDE. We recommend debugging directly in [https://tracinsy.ewi.tudelft.nl/pubtrac/GeniusWebPython#Debugging GeniusWebPython]. If you really need to debug on the server, you may try [https://coderwall.com/p/ttbtgq/python-remote-debugging-with-pdb remote debugging with pdb],
     60[http://charmyin.github.io/python/2014/11/09/debugger-python-remotely/ remote debugging eclipse] or [https://docs.microsoft.com/en-us/visualstudio/python/debugging-python-code-on-remote-linux-machines?view=vs-2019 remote debug visual studio].
     61
     62= Communication protocol
     63For the communication protocol of partiesservers, please refer to [https://tracinsy.ewi.tudelft.nl/pubtrac/GeniusWebPartiesServer/wiki/WikiStart#Communicationprotocol GeniusWebPartiesServer documentation]
     64
     65= Source code
     66 You can download the source repository of the implementation. Note that you don't need this if you just want to use the parties server to host your parties or to compile parties.
     67
     68{{{svn co https://tracinsy.ewi.tudelft.nl/pub/svn/GeniusWebPythonPartiesServer}}}
     69
     70 Since this is a tomcat web application, you need Eclipse Enterprise edition if you want to run this from Eclipse. Also, to checkout from Eclipse, you need to prepare Eclipse for this. Check ​https://tracinsy.ewi.tudelft.nl/pubtrac/GeniusWeb/wiki/WikiStart
     71
     72It is maven based so you only need maven to compile the code.
     73