ArchMap GeoJSON/KML generator
Branch: master
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
docs
pkgbuild
systemd
tests
.coveragerc
.gitignore
.pre-commit-config.yaml
.travis-coveragerc
.travis.yml
MANIFEST.in
README.rst
UNLICENSE
archmap.conf
archmap.py
dev-requirements.txt
requirements.txt
setup.cfg
setup.py

README.rst

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.

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

The documentation is hosted by readthedocs.org.

Installation

You can install archmap from PyPi by running pip3 install archmap or from the AUR by installing the archmap-git package.

Synopsis

By default, running archmap will output four files to /tmp; archmap.txt, archmap.geojson, archmap.kml and archmap.csv. 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:

usage:
archmap [-h] [-v] [-q] [--config FILE] [--url URL] [--file FILE] [--pretty] [--text FILE] [--geojson FILE] [--kml FILE] [--csv FILE]

optional arguments:
-h, --help      show this help message and exit
-v, --verbose   Show info messages
-q, --quiet     Disable info messages
--config FILE   Use an alternative configuration file instead of /etc/archmap.conf
--url URL       Use an alternative URL to parse the wiki list from
--file FILE     Use a file to parse the wiki list from
--pretty        Prettify the text user list. Only works if user output is enabled
--text FILE     Output the raw-text to FILE, use 'no' to disable output or '-' to print to stdout
--geojson FILE  Output the GeoJSON to FILE, use 'no' to disable output or '-' to print to stdout
--kml FILE      Output the KML to FILE, use 'no' to disable output or '-' to print to stdout
--csv FILE      Output the CSV to FILE, use 'no' to disable output or '-' to print to stdout

License

Everything in the ArchMap repo is unlicensed.

All of the files that this script can generate (archmap.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.