CDB Reimplementation for Python
C Python Shell
Switch branches/tags
Nothing to show
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
cdbx
docs
scripts
tasks
tests
.editorconfig
.flake8
.gitattributes
.gitignore
LICENSE
MANIFEST.in
README.md
cext.h
debug.unix.cflags
development.txt
pylintrc
setup.py
test.ini

README.md

cdbx - CDB Reimplementation for Python

TABLE OF CONTENTS

  1. Introduction
  2. Development Status
  3. Copyright and License
  4. System Requirements
  5. Installation
  6. Documentation
  7. Bugs
  8. Author Information

INTRODUCTION

cdbx is a CDB reimplementation for Python.

DEVELOPMENT STATUS

Beta.

COPYRIGHT AND LICENSE

Copyright 2016 - 2018 André Malo or his licensors, as applicable.

The whole package is distributed under the Apache License Version 2.0. You'll find a copy in the root directory of the distribution or online at: http://www.apache.org/licenses/LICENSE-2.0.

SYSTEM REQUIREMENTS

You need at least python 2.7 or Python 3 starting with version 3.3.

You also need a build environment for python C extensions (i.e. a compiler and the python development files).

INSTALLATION

Using pip

$ pip install cdbx

Using distutils

Download the package, unpack it, change into the directory

$ python setup.py install

The command above will install a new "cdbx" package into python's library path.

DOCUMENTATION

You'll find a user documentation in the docs/userdoc/ directory of the distribution package. Further, there's the code documentation, generated by epydoc, which can be found in the docs/apidoc/ subdirectory.

The latest documentation is also available online at http://opensource.perlig.de/cdbx/.

BUGS

No bugs, of course. ;-)

But if you've found one or have an idea how to improve cdbx, feel free to send a pull request on github or send a mail to cdbx-bugs@perlig.de.

AUTHOR INFORMATION

André "nd" Malo nd@perlig.de, GPG: 0x8103A37E

If God intended people to be naked, they would be born that way. -- Oscar Wilde