1Metadata-Version: 2.1
2Name: khard
3Version: 0.17.0
4Summary: A console carddav client
5Home-page: https://github.com/scheibler/khard/
6Author: Eric Scheibler
7Author-email: email@eric-scheibler.de
8License: GPL
9Description: khard
10        =====
11
12        Khard is an address book for the Unix console. It creates, reads, modifies and
13        removes carddav address book entries at your local machine. Khard is also
14        compatible to the email clients mutt and alot and the SIP client twinkle. You
15        can find more information about khard and the whole synchronization process
16        [here][blog].
17
18        Warning: If you want to create or modify contacts with khard, beware that the
19        vcard standard is very inconsistent and lacks interoperability. Different
20        actors in that sector have defined their own extensions and even produce
21        non-standard output. A good example is the type value, which is tied to phone
22        numbers, email and post addresses. Khard tries to avoid such incompatibilities
23        but if you sync your contacts with an Android or iOS device, expect problems.
24        You are on the safe side, if you only use khard to read contacts. For further
25        information about the vcard compatibility issues have a look into [this blog
26        post][sad].
27
28        Installation
29        ------------
30
31        [![Packaging status][repos-badge]][repos]
32
33        Khard is already packaged for quite some distributions.  Chances are you can
34        install it with your default package manager.  Releases are also published on
35        [PyPi](https://pypi.org/project/khard/) and can be installed with `pip`.
36        Further instructions can be found in the
37        [documentation](https://khard.readthedocs.io/en/latest/#installation).
38
39        Usage
40        -----
41
42        [![Documentation Status][docs-badge]][docs]
43
44        There is an [example config file](doc/source/examples/khard.conf.example) which
45        you can copy to the default config file location: `~/.config/khard/khard.conf`.
46        `khard` has several subcommands which are all documented by their `--help`
47        option. [The docs][docs] also have a chapter on [command line
48        usage](https://khard.readthedocs.io/en/latest/commandline.html) and
49        [configuration](https://khard.readthedocs.io/en/latest/#configuration).
50
51        In order to build the documentation locally you need
52        [Sphinx](https://www.sphinx-doc.org/).  It can be build from the Makefile in
53        the `doc` directory.
54
55        Development
56        -----------
57
58        [![Build Status][travis-badge]][travis]
59
60        Khard is developed [on GitHub](https://github.com/scheibler/khard) where you
61        are welcome to post [bug reports](https://github.com/scheibler/khard/issues)
62        and [feature requests](https://github.com/scheibler/khard/pulls).  Also see the
63        [notes for contributors](CONTRIBUTING.rst).
64
65        Authors
66        -------
67
68        Khard was started by [Eric Scheibler](http://eric-scheibler.de) and is
69        currently maintained by @lucc.  [Several
70        people](https://github.com/scheibler/khard/graphs/contributors) have
71        contributed over the years.
72
73        Related projects
74        ----------------
75
76        If you need a console based calendar too, try out
77        [khal](https://github.com/geier/khal).
78
79          [blog]: http://eric-scheibler.de/en/blog/2014/10/Sync-calendars-and-address-books-between-Linux-and-Android/
80          [sad]: http://alessandrorossini.org/2012/11/15/the-sad-story-of-the-vcard-format-and-its-lack-of-interoperability/
81          [repos]: https://repology.org/project/khard/versions
82          [repos-badge]: https://repology.org/badge/tiny-repos/khard.svg
83          [docs]: https://khard.readthedocs.io/en/latest/
84          [docs-badge]: https://readthedocs.org/projects/khard/badge/?version=latest
85          [travis]: https://travis-ci.org/scheibler/khard
86          [travis-badge]: https://travis-ci.org/scheibler/khard.svg?branch=develop
87
88Keywords: Carddav console addressbook
89Platform: UNKNOWN
90Classifier: Development Status :: 4 - Beta
91Classifier: Environment :: Console
92Classifier: Topic :: Utilities
93Classifier: Topic :: Communications :: Email :: Address Book
94Classifier: License :: OSI Approved :: GNU General Public License (GPL)
95Classifier: Intended Audience :: End Users/Desktop
96Classifier: Operating System :: POSIX
97Classifier: Programming Language :: Python :: 3 :: Only
98Requires-Python: >=3.6
99Description-Content-Type: text/markdown
100Provides-Extra: doc
101