README.md
1The GAP 4 package "PackageManager"
2==================================
3
4[![Build Status](https://travis-ci.org/gap-packages/PackageManager.svg?branch=master)](https://travis-ci.org/gap-packages/PackageManager)
5[![Code Coverage](https://codecov.io/github/gap-packages/PackageManager/coverage.svg?branch=master&token=)](https://codecov.io/gh/gap-packages/PackageManager)
6[![Binder](https://mybinder.org/badge_logo.svg)](https://mybinder.org/v2/gh/gap-packages/PackageManager/master?filepath=PackageManager-demo.ipynb)
7
8A basic collection of simple functions for installing and removing GAP packages,
9with the eventual aim of becoming a full pip-style package manager for the GAP
10system.
11
12Example invocations:
13
14 gap> LoadPackage("PackageManager");
15
16 gap> InstallPackage("digraphs");
17
18 gap> InstallPackage("https://github.com/gap-packages/Semigroups.git");
19
20 gap> InstallPackage("https://www.gap-system.org/pub/gap/gap4/tar.gz/packages/mapclass-1.2.tar.gz");
21
22 gap> RemovePackage("semigroups");
23
24By default, verbose information about a command's progress is printed to the
25screen. To see less of this information, try using:
26
27 gap> SetInfoLevel(InfoPackageManager, 1);
28
29For more information on the features of PackageManager, see the documentation at
30https://gap-packages.github.io/PackageManager/doc/chap1.html
31or enter GAP and call, for example,
32
33 gap> ?InstallPackage
34
35Citing
36------
37Please cite this package as:
38
39[Tor19]
40M. Torpey,
41PackageManager (GAP package),
42Easily download and install GAP packages,
43Version X.Y (20XX),
44https://github.com/gap-packages/PackageManager.
45
46Acknowledgements
47----------------
48
49<table class="none">
50<tr>
51<td>
52 <img src="https://opendreamkit.org/public/logos/odk-elected-logo.svg" width="128">
53</td>
54<td>
55 PackageManager was partly created with funding from the OpenDreamKit project: https://opendreamkit.org
56</td>
57</tr>
58<tr>
59<td>
60 <img src="http://opendreamkit.org/public/logos/Flag_of_Europe.svg" width="128">
61</td>
62<td>
63 This infrastructure is part of a project that has received funding from the
64 European Union's Horizon 2020 research and innovation programme under grant
65 agreement No 676541.
66</td>
67</tr>
68</table>
69