Skip to content

Latest commit

 

History

History
48 lines (37 loc) · 2.1 KB

README.rst

File metadata and controls

48 lines (37 loc) · 2.1 KB
https://coveralls.io/repos/github/gocept/gocept.collmex/badge.svg?branch=master Current version on PyPI Supported Python versions

Collmex is an online ERP system for (small) companies with a focus on simple accounting. <http://www.collmex.de> (Note: Collmex is Germany-based but seems to support English. You're bound to stumble over German strings, though.)

This package aims to provide pythonic bindings to program against Collmex' API. It includes transaction management for integration with the ZODB or other databases that can integrate with the transaction package.

To initialize a connection to the collmex server, login-credentials are required. These can be given explicitely when the gocept.collmex.collmex.Collmex object is created or via an ini file named collmex.ini. The ini file must live in the project directory or any of it's parent directories, e.g. it is possible to place collmex.ini in your home directory to use those credentials for all of your projects. The ini file must contain the section [credentials] for production and [test-credentials] for testing purposes. Each section must have the following options: customer_id, company_id, username and password. The file collmex.ini-example can be used as a template.

Example:

[credentials]
customer_id = 42555
company_id = 1
username = realuser
password = realpassword

[test-credentials]
customer_id = 41222
company_id = 1
username = testuser
password = testpassword