Skip to main content
This is a pre-production deployment of Warehouse. Changes made here affect the production instance of PyPI (pypi.python.org).
Help us improve Python packaging - Donate today!

Bexio API Python Client

Project Description
=============================
Bexio API Python Client
=============================

.. image:: https://badge.fury.io/py/bexio-api-python-client.svg
:target: https://badge.fury.io/py/bexio-api-python-client

.. image:: https://travis-ci.org/oesah/bexio-api-python-client.svg?branch=master
:target: https://travis-ci.org/oesah/bexio-api-python-client

.. image:: https://codecov.io/gh/oesah/bexio-api-python-client/branch/master/graph/badge.svg
:target: https://codecov.io/gh/oesah/bexio-api-python-client

Bexio API Python Client. It works as a standalone lib in python, but needs
additional work to get it started. There is a Django integration, that works
out of the box, once you set it up properly as described later. If you wish to
use it with Python alone, you can take a look at the Django integration. It
shows how you can use it with python alone.

Features
--------

* API connection to your Bexio instance
* Django integration
* Creation & Auto-renewal of access token

Documentation
-------------

The full documentation is at https://bexio-api-python-client.readthedocs.io.

Quickstart
----------

Install Bexio API Python Client::

pip install bexio-api-python-client

If you are using anything other than Django with this module, you need to
write some more code to authenticate and use the API. Check out the Django
parts of the module to see how it can be done.

Django Integration
------------------

You can use the API directly with Django. There are URLs, Views and other
helpers to integrate the API into your Django project.

Add it to your :code:`INSTALLED_APPS`:

.. code-block:: python

INSTALLED_APPS = (
...
'bexiopy.apps.BexiopyConfig',
...
)

Add Bexio API Python Client's URL patterns to your main :code:`urls.py`:

.. code-block:: python

from bexiopy import urls as bexiopy_urls


urlpatterns = [
...
url(r'bexiopy/', include('bexiopy.urls', namespace='bexiopy')),
...
]


Configure the minimum :code:`settings.py` (check docs for all options):

.. code-block:: python

BEXIO_CLIENT_SECRET = 'my_secret'
BEXIO_CLIENT_ID = 'my_id'
BEXIO_APPLICATION_SCOPES = ['my_scope_1', 'my_scope_2']
BEXIO_APPLICATION_REDIRECTION_URL = 'https://example.com'


Start the server and go to :code:`/bexiopy/auth/` and authenticate with Bexio.

**i18n URLs**

If you have internationalized URLs, then make sure you place the Bexiopy
url outside the internationalized ones, so it can be called without any
language code (:code:`/bexiopy/auth/` instead of :code:`/en/bexiopy/auth/`).


Running Tests
-------------

Does the code actually work?

::

source <YOURVIRTUALENV>/bin/activate
(myenv) $ pip install tox
(myenv) $ tox

Credits
-------

Tools and libs used in creating this package:

* Cookiecutter_
* `cookiecutter-djangopackage`_
* `Christian Ruhstaller (bexio-api-php-client)`_

.. _Cookiecutter: https://github.com/audreyr/cookiecutter
.. _`cookiecutter-djangopackage`: https://github.com/pydanny/cookiecutter-djangopackage
.. _`Christian Ruhstaller (bexio-api-php-client)`: https://github.com/christianruhstaller/bexio-api-php-client


Progress
--------
[ ] = Open

[~] = In Progress

[X] = Done

[-] = Not possible / Ignored



Contacts
^^^^^^^^

Contacts
========

* [X] List contacts
* [X] Search contacts
* [X] Show contact
* [X] Create contact
* [X] Overwrite contact
* [X] Edit contact
* [X] Delete contact
* [ ] Bulk create contact


Salutations
===========

* [ ] List salutations
* [ ] Search salutations
* [ ] Show salutation
* [ ] Create salutation
* [ ] Overwrite salutation
* [ ] Edit salutation
* [ ] Delete salutation


Titles
======

* [ ] List titles
* [ ] Search titles
* [ ] Show title
* [ ] Create title
* [ ] Overwrite title
* [ ] Edit title
* [ ] Delete title


Invoices
^^^^^^^^
* [X] List invoices
* [X] Search invoices
* [X] Show invoice
* [X] Create invoice
* [X] Overwrite invoice
* [X] Edit invoice
* [X] Delete invoice
* [X] Show invoice pdf
* [X] Copy invoice
* [ ] Issue invoice
* [ ] Mark invoice as sent
* [ ] Send invoice
* [ ] List comments
* [ ] Search comments
* [ ] Show comment
* [ ] Create comment
* [-] List payments
* [-] Show payments
* [-] Create payments
* [-] Delete payments




History
-------

0.1.0 (2017-10-23)
++++++++++++++++++

* First release on PyPI.
Release History

Release History

This version
History Node

0.1.0

Download Files

Download Files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

File Name & Checksum SHA256 Checksum Help Version File Type Upload Date
bexio_api_python_client-0.1.0-py2.py3-none-any.whl (18.6 kB) Copy SHA256 Checksum SHA256 2.7 Wheel Dec 3, 2017
bexio-api-python-client-0.1.0.tar.gz (16.7 kB) Copy SHA256 Checksum SHA256 Source Dec 3, 2017

Supported By

WebFaction WebFaction Technical Writing Elastic Elastic Search Pingdom Pingdom Monitoring Dyn Dyn DNS Sentry Sentry Error Logging CloudAMQP CloudAMQP RabbitMQ Heroku Heroku PaaS Kabu Creative Kabu Creative UX & Design Fastly Fastly CDN DigiCert DigiCert EV Certificate Rackspace Rackspace Cloud Servers DreamHost DreamHost Log Hosting