Metadata-Version: 2.1
Name: gocept.collmex
Version: 2.0
Summary: Python-bindings for the Collmex import/export API
Home-page: https://github.com/gocept/gocept.collmex
Author: gocept
Author-email: mail@gocept.com
License: ZPL 2.1
Classifier: Development Status :: 5 - Production/Stable
Classifier: Environment :: Plugins
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved
Classifier: License :: OSI Approved :: Zope Public License
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: Implementation :: CPython
Classifier: Programming Language :: Python :: Implementation :: PyPy
Requires-Python: >=3.7
Provides-Extra: test

.. contents::

.. image:: https://github.com/gocept/gocept.collmex/workflows/tests/badge.svg
           :target: https://github.com/gocept/gocept.collmex/actions?query=workflow%3Atests
.. image:: https://coveralls.io/repos/github/gocept/gocept.collmex/badge.svg?branch=master
           :target: https://coveralls.io/github/gocept/gocept.collmex?branch=master
.. image:: https://img.shields.io/pypi/v/gocept.collmex.svg
           :target: https://pypi.org/project/gocept.collmex/
           :alt: Current version on PyPI
.. image:: https://img.shields.io/pypi/pyversions/gocept.collmex.svg
           :target: https://pypi.org/project/gocept.collmex/
           :alt: Supported Python versions


Introduction
============

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.


Credentials
===========

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


Collmex API
===========

Collmex provides a POST- and CSV-based API, which is encapsulated into a
utility that provides methods for the various CSV record types.  API
documentation is available at
http://www.collmex.de/cgi-bin/cgi.exe?1005,1,help,api.


The collmex object
------------------

The collmex object is a central place to access collmex. In the Zope 3 jargon
it is a global utility:

>>> import os
>>> import gocept.collmex.collmex
>>> os.environ['collmex_credential_section'] = 'test-credentials'
>>> collmex = gocept.collmex.collmex.Collmex()


Pre flight cleanup
------------------

First we need to clean up the Collmex environment:

>>> import gocept.collmex.testing
>>> gocept.collmex.testing.cleanup_collmex()


Transaction integration
-----------------------

gocept.collmex has support for transaction integration. All modifying calls are
buffered until the transaction is commited. XXX explain more.

>>> import transaction


Customers: ``create_customer`` and ``get_customers``
----------------------------------------------------

>>> customer = gocept.collmex.model.Customer()
>>> customer['Kundennummer'] = 10000
>>> customer['Firma'] = 'Testkunden'
>>> collmex.create(customer)
>>> transaction.commit()

Customers can be listed using the get_customers method:

>>> customers = collmex.get_customers()
>>> customers
[<gocept.collmex.model.Customer object at 0x...>, <gocept.collmex.model.Customer object at 0x...>]
>>> len(customers)
2

The first customer is the generic one:

>>> customer = customers[0]
>>> customer['Satzart']
'CMXKND'
>>> customer['Kundennummer']
'9999'
>>> customer['Firma']
'Allgemeiner Geschäftspartner'

The second customer is one created during test setup:

>>> customer = customers[1]
>>> customer['Satzart']
'CMXKND'
>>> customer['Kundennummer']
'10000'
>>> customer['Firma']
'Testkunden'

Products: ``create_product`` and ``get_products``
-------------------------------------------------

Products are created using the ``create_product`` method:

>>> product = gocept.collmex.model.Product()
>>> product['Produktnummer'] = 'TEST'
>>> product['Bezeichnung'] = 'Testprodukt'
>>> product['Produktart'] = 1 # Dienstleistung
>>> product['Basismengeneinheit'] = 'HR'
>>> product['Verkaufs-Preis'] = 5
>>> collmex.create(product)
>>> transaction.commit()
>>> collmex.get_products()[0]['Bezeichnung']
'Testprodukt'

Invoices: ``create_invoice`` and ``get_invoices``
-------------------------------------------------

Invoices are created using the ``create_invoice`` method:

>>> import datetime
>>> start_date = datetime.datetime.now()
>>> item = gocept.collmex.model.InvoiceItem()
>>> item['Kunden-Nr'] = '10000'
>>> item['Rechnungsnummer'] = 100000
>>> item['Menge'] = 3
>>> item['Produktnummer'] = 'TEST'
>>> item['Rechnungstext'] = 'item text \u2013 with non-ascii characters'
>>> item['Positionstyp'] = 0
>>> collmex.create_invoice([item])

Invoices can be looked up again, using the ``get_invoices`` method. However, as
discussed above the invoice was only registered for addition. Querying right
now does *not* return the invoice:

>>> collmex.get_invoices(customer_id='10000', start_date=start_date)
[]

After committing, the invoice is found:

>>> transaction.commit()
>>> collmex.get_invoices(customer_id='10000',
...                      start_date=start_date)[0]['Rechnungstext']
'item text – with non-ascii characters'

Activities
----------

This section describes the API for activities (Taetigkeiten erfassen)

Create an activity
~~~~~~~~~~~~~~~~~~

A project with one set and an employee are required to submit activities:

>>> import datetime
>>> import gocept.collmex.testing
>>> gocept.collmex.testing.create_project('Testprojekt', collmex=collmex)
>>> gocept.collmex.testing.create_employee(collmex)
>>> act = gocept.collmex.model.Activity()
>>> act['Projekt Nr'] = '1' # Testprojekt
>>> act['Mitarbeiter Nr'] = '1' # Sebastian Wehrmann
>>> act['Satz Nr'] = '1' # TEST
>>> act['Beschreibung'] = 'allgemeine T\xe4tigkeit'
>>> act['Datum'] = datetime.date(2012, 1, 23)
>>> act['Von'] = datetime.time(8, 7)
>>> act['Bis'] = datetime.time(14, 28)
>>> act['Pausen'] = datetime.timedelta(hours=1, minutes=12)
>>> collmex.create(act)
>>> transaction.commit()

Export using ``get_activities``
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

``get_activities`` returns Activity objects.

.. ATTENTION:: In previous versions this method returnd a raw CSV string. This
      was due to Collmex not having an actual API.


>>> activities = collmex.get_activities()
>>> activities[0]['Beschreibung']
'allgemeine T\xe4tigkeit'


Projects: ``get_projects``
--------------------------

Projects can be exported with the ``get_projects`` API. It returns an entry
for every project set (Projektsatz) of each project (Projekt):

>>> proj = collmex.get_projects()
>>> len(proj)
2
>>> proj[0]['Projektnummer'] == proj[1]['Projektnummer']
True

>>> proj[0]['Satz']
'5,00'
>>> proj[1]['Satz']
'9,65'
>>> proj[0]['Inaktiv']
'0'

Caching
-------

Results queried from Collmex are cached for the duration of the transaction.

To demonstrate this, we instrument the _post() method that performs the actual
HTTP communication to show when it is called:

>>> original_post = collmex._post
>>> def tracing_post(self, *args, **kw):
...     print('cache miss')
...     return original_post(*args, **kw)
>>> collmex._post = tracing_post.__get__(collmex, type(collmex))

The first time in an transaction is retrieved from Collmex, of course:

>>> transaction.abort()
>>> collmex.get_products()[0]['Bezeichnung']
cache miss
'Testprodukt'

But after that, values are cached:

>>> collmex.get_products()[0]['Bezeichnung']
'Testprodukt'

When the transaction ends, the cache is invalidated:

>>> transaction.commit()
>>> collmex.get_products()[0]['Bezeichnung']
cache miss
'Testprodukt'

>>> collmex.get_products()[0]['Bezeichnung']
'Testprodukt'

Remove tracing instrumentation:

>>> collmex._post = original_post


Changes
=======

2.0 (2023-08-23)
----------------

- Drop support for Python 2.7, 3.5, 3.6.

- Add support for Python 3.9, 3.10, 3.11.

- Avoid password exhaustion by using invalid username for tests.

- Fix the tests to use fewer connections.


1.9 (2019-09-02)
----------------

- Drop support for Python 3.3 and 3.4.

- Add support for Python 3.6, 3.7 and 3.8b4.

- Migrate code to GitHub.

- Update tests to new Collmex URLs.


1.8.3 (2018-03-16)
------------------

- Implemented CMXABO, only applicable for "collmex Verein".


1.8.2 (2017-01-23)
------------------

- Implemented `MITGLIED_GET` as `get_members()` and `CMXMGD`
  as `models.Member`, both only applicable for "collmex Verein".


1.8.1 (2016-06-09)
------------------

- Extend `Project` to retrieve budget and summed up work via API.


1.8.0 (2016-01-27)
------------------

- Declared compatibility with Python 3.4.

- Drop support for Python 3.2.

- Made sure tests don't use invalid credentials on test account too many times
  in a row.

- Raise ``ValueError`` if the Collmex website returned an error during
  ``Collmex.browser_login``. Until now the error was hidden, but the following
  action failed. In particular this should help to spot invalid credentials.



1.7.0 (2014-09-04)
------------------

- Use collmex.ini file given by the path in environment variable
  ``COLLMEX_INI`` if present, only otherwise look upward from the current
  directory.

- Don't log the password in our debug output.


1.6.0 (2014-08-18)
------------------

- Un-deprecate method ``Collmex.create_invoice``, it now takes care of
  automatically allocating invoice ids.

- Add ``gocept.collmex.testing.ConsoleDump`` utility that fakes a collmex
  connection, but only logs method calls.


1.5.1 (2013-12-09)
------------------

- Fix brown bag release 1.5.0


1.5.0 (2013-12-09)
------------------

- Added methods to Activity to parse/calculate the dates, times, breaks,
  duration.


1.4.4 (2013-09-25)
------------------

- Improve check for invalid credentials when ``gocept.collmex.collmex.Collmex``
  is created.

- Yield more detailed information when parsing of the ini file failed.

1.4.3 (2013-09-24)
------------------

- Fix the check for invalid credentials when ``gocept.collmex.collmex.Collmex``
  is created.


1.4.2 (2013-09-23)
------------------

- Credentials to log into Collmex can be given via an `collmex.ini` file.


1.4.1 (2013-09-16)
------------------

- Creation of test activities is now fully customizable


1.4 (2013-09-13)
----------------

- gocept.collmex is now compatible with Python 3.2 and Python 3.3!


1.3 (2013-02-22)
----------------

- Implement activities API (#11954).


1.2.1 (2012-03-09)
------------------

- Fix ``gocept.collmex.collmex.Collmex.browser_login()`` after collmex website
  changed wich included a rename of form elements.



1.2 (2012-02-21)
----------------

Note: This version was accidentally released without the changes in 1.1.1,
however, the release itself contained the changes of 1.1 and thus isn't
broken.

- Add ``Inaktiv`` attribute on ``CMXPRJ`` (projects)


1.1.1 (2012-02-17)
------------------

- Rectify previous brown-bag release.


1.1 (2012-02-17)
----------------

- Do not honour Collmex' robots.txt as of 2012-02-09. :(


1.0 (2012-01-23)
----------------

- Forced usage of Python 2.7.

- Added testing helper ``get_collmex`` to create a collmex object from
  environment variables.

- Made testing helper ``collmex_login()`` a method: ``gocept.collmex.collmex.Collmex.browser_login()``

- Modified signature of testing helper ``create_activity``, so it no longer
  needs a parameter.


0.9 (2012-01-20)
----------------

- Added testing helper ``create_activity``.


0.8 (2012-01-20)
----------------

- Added API for retrieving activities (``get_activities``).

- Updated tests and test infrastructure to recent changes in Collmex.


0.7 (2009-11-05)
----------------

- Added API for retrieving projects and creation of activities.

0.6 (2009-02-16)
----------------

- Make models robust against API changes so they don't immediately break when
  the record becomes longer.
- Updated customer model to current API.

0.5.1 (2009-01-08)
------------------

- Fixed multi-threading bug: thread-local data needs to be intialized for each
  thread.

0.5 (2008-12-19)
----------------

- Values returned from Collmex are converted to unicode.
- Cache results for the duration of the transaction.

0.4 (2008-12-11)
----------------

- Added `get_products` and `create_product`.
- Added `create_customer`.
- gocept.collmex.testing.cleanup_collmex() now only deletes any existing data,
  it does not add any sample customers or products, use the API for that.

0.3.1 (2008-12-02)
------------------

- Python 2.5 compatibility.

0.3 (2008-12-01)
----------------

- Using Windows-1252 as encoding when uploading data (used to be ISO-8859-1).
- Fixed transaction integration when upload fails.

0.2 (2008-11-28)
----------------

- Modifications for changed Collmex API.
- Added ``get_customers`` to query customers (API ``CUSTOMER_GET``).

0.1 (2008-10-14)
----------------

- first release. Supports getting and storing invoices.
