About

ArchMap

build-status coverage docs-status license

archmap generates GeoJSON and KML files which can be used to display a map of Arch Linux users, it does this by parsing data from the ArchWiki.

One rendering of the data is on a map over at mapbox.com - This is updated manually so it may be out of date.

Have a look at the ArchMap page on the ArchWiki for more information about this project.

The documentation is hosted by readthedocs.org.

Synopsis

By default, running archmap will output three files to /tmp, archmap_users.txt, archmap.geojson and archmap.kml, this can be overridden by either using the config file or by the command line switches.

The config file should be placed in /etc/archmap.conf, this can be overridden by using --config <path-to-config-file>

Use

Running archmap --help will display this help message:

archmap [-h] [-v] [--config FILE] [--users FILE] [--geojson FILE] [--kml FILE] [--csv FILE]

optional arguments:
-h, --help      show this help message and exit
-v, --verbose   Show info messages
--config FILE   Use an alternative configuration file instead of /etc/archmap.conf
--users FILE    Use FILE for a list of users instead of getting the list from the ArchWiki
--geojson FILE  Output the GeoJSON to FILE, use 'no' to disable output
--kml FILE      Output the KML to FILE, use 'no' to disable output
--csv FILE      Output the CSV to FILE, use 'no' to disable output

License

Everything in the ArchMap repo is unlicensed.

All of the files that this script can generate (archmap_users.txt, archmap.geojson, archmap.kml, and archmap.csv) will contain text from the ArchWiki which puts them under the GNU Free Documentation License 1.3 or later.

Unlicense

This is free and unencumbered software released into the public domain.

Anyone is free to copy, modify, publish, use, compile, sell, or distribute this software, either in source code form or as a compiled binary, for any purpose, commercial or non-commercial, and by any means.

In jurisdictions that recognize copyright laws, the author or authors of this software dedicate any and all copyright interest in the software to the public domain. We make this dedication for the benefit of the public at large and to the detriment of our heirs and successors. We intend this dedication to be an overt act of relinquishment in perpetuity of all present and future rights to this software under copyright law.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

For more information, please refer to <http://unlicense.org/>