11.1.2. What is the status of the project? Is it “official”?¶
It is a work-in-progress. It is aimed to become “official”.
11.1.3. What is the roadmap for this project?¶
11.1.4. Can I copy/extend it? What is its License, in practical terms?¶
In a broad view, the core algorithm of the project is “copylefted” with the EUPL-1.1+ license, and it includes files from other “non-copyleft” open source licenses like -MIT MIT License* and Apache License, appropriately marked as such. So in an nutshell, you can study it, copy it, or import and use ot from your programs is without any obligation. You may distribute & publish a modified version, as long as you always distribute & publish the sources of your changes.
11.2.1. I followed the instructions but i still cannot install/run/do X. What now?¶
If you have no previous experience in python, setting up your environment and installing a new project is a demanding, but manageable, task. Here is a checklist of things that might go wrong:
Did you send each command to the appropriate shell/interpreter?
You should enter sample commands starting
$into your shell (cmd or bash), and those starting with
>>>into the python-interpreter (but don’t include the previous symbols and/or the output of the commands).
Is python contained in your PATH ?
To check it, type
pythonin your console/command-shell prompt and press [Enter]. If nothing happens, you have to inspect
PATHand modify it accordingly to include your python-installation.
Under Windows type
pathin your command-shell prompt.
Under Unix type
echo $PATH$in your console. To change it, modify your “rc” files, ie:
Is the correct version of python running?
Have you upgraded/downgraded the project into a more recent/older version?
This project is still in development, so the names of data and functions often differ from version to version. Check the Changes for point that you have to be aware of when upgrading.
Did you search whether a similar issue has already been reported?
Did you ask google for an answer??
If the above suggestions still do not work, feel free to open a new issue and ask for help here. Write down your platform (Windows, OS X, Linux), your exact python distribution and version, and include the print-out of the failed command along with its error-message.
This last step will improve the documentation and help others as well.