If this is so, replace any usage of 'python' in the examples below with the appropriate invocation. You can test the version by python –version or python3 –version. It is possible that the normal invocation of python starts up Python 2.x, and that to start up Python 3.x requires invoking with python3 or python3.4 etc. On some systems, both Python 2.x and 3.x are installed. If you have more than one version of Python installed, then you must use the correct version for these scripts. If you have installed Gramps 4.2 or higher on your Linux system already, then a sufficient version of Python will be present. You must have at least that version installed. Gramps uses Python version 3.2 or higher.They won't work on Windows without modifications. These instructions, the make.py script etc.Īre designed to operate in a Linux environment. Git checkout -b gramps51 origin/maintenance/gramps51 To switch to a local copy of the gramps51 maintenance branch: Git clone :gramps-project/gramps.git gramps Git clone :gramps-project/addons.git addons Git clone :gramps-project/addons-source.git addons-source From the base directory, run the following commands to create a copy of each repository. This wiki assumes that all three git repositories local locations are put into the same base directory and named with the repository names in order for the make.py script commands to work as shown. To fully build and advertise a new addon will require local copies of the three repositories, the 'addons-source', 'addons' and the main Gramps source 'gramps'. Also Connecting to GitHub with SSH will help with setting up credentials for GitHub. See also git introduction for instructions on installing git and getting basic settings configured. Request GIT write access for the project by emailing the gramps-devel mailing list.Get an account if you don't already have one.These steps show how to download the addon sources. Get a local copy of Gramps and its addons The addons git repository holds built versions of the addons for each release of Gramps, and has the following structure: The addons-source git repository has the following structure, with the code for each addon in its own folder: The developers are currently merging changes to the most recent maintenance branch into master as necessary, so you don't have to do anything for that unless you are in a hurry. (Currently gramps 5.2, which is not the typical target for addons.)Įxample commands are shown below referring to the public release rather than the master branch. If you are working on an addon for gramps for the current Gramps 5.1 public release, be sure to use the maintenance/gramps51 git branch, as the default is master branch for the developmental pre-release. The addons-source repository holds the source code for the addons with branches holding the version for different gramps. We'll now expand upon each of these steps individually. Maintain the code as Gramps continues to evolve. Announce it on the Gramps Forum - Let users know it exist and how to use it.Register your addon with the Plugin Manager.Document your addon and publish it to the addon list.Invite translation of your addon into multiple natural languages.Create a Gramps Plugin Registration file (.gpr.py).The general steps to writing an addon and sharing your own addons are: And sharing your addon is the right thing to do. Writing an addon is fairly straightforward if you have just a little bit of Python experience. Rule (Introduced Gramps 5.1.x and greater).Database (Introduced Gramps 5.x and greater).You can add any of the following types of addons: 13 Example code adding common enhancementsĪddons for Gramps can extend the program in many different ways.12 Maintain the code as Gramps continues to evolve.9 List and document your addon on the wiki.8 List your addon in the Gramps Plugin Manager.6 Get translators to translate your addon into multiple languages.5 List the Prerequistes your addon depends on.4 Create a Gramps Plugin Registration file. 3.4 Follow the development API for your tool.3.1 Get a local copy of Gramps and its addons.
0 Comments
Leave a Reply. |
AuthorWrite something about yourself. No need to be fancy, just an overview. ArchivesCategories |