Name | Date | Size | #Lines | LOC | ||
---|---|---|---|---|---|---|
.. | 03-May-2022 | - | ||||
doc/ | H | 03-May-2022 | - | 1,109 | 732 | |
khard/ | H | 13-Aug-2020 | - | 4,731 | 3,871 | |
khard.egg-info/ | H | 03-May-2022 | - | 101 | 82 | |
misc/ | H | 13-Aug-2020 | - | 574 | 447 | |
test/ | H | 13-Aug-2020 | - | 3,051 | 2,440 | |
.gitignore | H A D | 13-Aug-2020 | 154 | 12 | 11 | |
.readthedocs.yml | H A D | 07-Apr-2020 | 343 | 13 | 12 | |
.travis.yml | H A D | 07-Apr-2020 | 591 | 36 | 32 | |
CHANGES | H A D | 13-Aug-2020 | 9.3 KiB | 267 | 192 | |
CONTRIBUTING.rst | H A D | 13-Aug-2020 | 2.8 KiB | 80 | 63 | |
LICENSE | H A D | 18-Feb-2016 | 34.3 KiB | 675 | 553 | |
MANIFEST.in | H A D | 13-Aug-2020 | 114 | 5 | 4 | |
PKG-INFO | H A D | 13-Aug-2020 | 4.6 KiB | 101 | 82 | |
README.md | H A D | 07-Apr-2020 | 3.2 KiB | 79 | 61 | |
setup.cfg | H A D | 13-Aug-2020 | 38 | 5 | 3 | |
setup.py | H A D | 13-Aug-2020 | 1.6 KiB | 51 | 40 |
README.md
1khard 2===== 3 4Khard is an address book for the Unix console. It creates, reads, modifies and 5removes carddav address book entries at your local machine. Khard is also 6compatible to the email clients mutt and alot and the SIP client twinkle. You 7can find more information about khard and the whole synchronization process 8[here][blog]. 9 10Warning: If you want to create or modify contacts with khard, beware that the 11vcard standard is very inconsistent and lacks interoperability. Different 12actors in that sector have defined their own extensions and even produce 13non-standard output. A good example is the type value, which is tied to phone 14numbers, email and post addresses. Khard tries to avoid such incompatibilities 15but if you sync your contacts with an Android or iOS device, expect problems. 16You are on the safe side, if you only use khard to read contacts. For further 17information about the vcard compatibility issues have a look into [this blog 18post][sad]. 19 20Installation 21------------ 22 23[![Packaging status][repos-badge]][repos] 24 25Khard is already packaged for quite some distributions. Chances are you can 26install it with your default package manager. Releases are also published on 27[PyPi](https://pypi.org/project/khard/) and can be installed with `pip`. 28Further instructions can be found in the 29[documentation](https://khard.readthedocs.io/en/latest/#installation). 30 31Usage 32----- 33 34[![Documentation Status][docs-badge]][docs] 35 36There is an [example config file](doc/source/examples/khard.conf.example) which 37you can copy to the default config file location: `~/.config/khard/khard.conf`. 38`khard` has several subcommands which are all documented by their `--help` 39option. [The docs][docs] also have a chapter on [command line 40usage](https://khard.readthedocs.io/en/latest/commandline.html) and 41[configuration](https://khard.readthedocs.io/en/latest/#configuration). 42 43In order to build the documentation locally you need 44[Sphinx](https://www.sphinx-doc.org/). It can be build from the Makefile in 45the `doc` directory. 46 47Development 48----------- 49 50[![Build Status][travis-badge]][travis] 51 52Khard is developed [on GitHub](https://github.com/scheibler/khard) where you 53are welcome to post [bug reports](https://github.com/scheibler/khard/issues) 54and [feature requests](https://github.com/scheibler/khard/pulls). Also see the 55[notes for contributors](CONTRIBUTING.rst). 56 57Authors 58------- 59 60Khard was started by [Eric Scheibler](http://eric-scheibler.de) and is 61currently maintained by @lucc. [Several 62people](https://github.com/scheibler/khard/graphs/contributors) have 63contributed over the years. 64 65Related projects 66---------------- 67 68If you need a console based calendar too, try out 69[khal](https://github.com/geier/khal). 70 71 [blog]: http://eric-scheibler.de/en/blog/2014/10/Sync-calendars-and-address-books-between-Linux-and-Android/ 72 [sad]: http://alessandrorossini.org/2012/11/15/the-sad-story-of-the-vcard-format-and-its-lack-of-interoperability/ 73 [repos]: https://repology.org/project/khard/versions 74 [repos-badge]: https://repology.org/badge/tiny-repos/khard.svg 75 [docs]: https://khard.readthedocs.io/en/latest/ 76 [docs-badge]: https://readthedocs.org/projects/khard/badge/?version=latest 77 [travis]: https://travis-ci.org/scheibler/khard 78 [travis-badge]: https://travis-ci.org/scheibler/khard.svg?branch=develop 79