{ "info": { "author": "\u00d6zer Sahin", "author_email": "o.sahin@oesah.de", "bugtrack_url": null, "classifiers": [ "Development Status :: 3 - Alpha", "Framework :: Django", "Framework :: Django :: 1.10", "Framework :: Django :: 1.8", "Framework :: Django :: 1.9", "Intended Audience :: Developers", "License :: OSI Approved :: BSD License", "Natural Language :: English", "Programming Language :: Python :: 2", "Programming Language :: Python :: 2.7", "Programming Language :: Python :: 3", "Programming Language :: Python :: 3.3", "Programming Language :: Python :: 3.4", "Programming Language :: Python :: 3.5" ], "description": "=============================\nBexio API Python Client\n=============================\n\n.. image:: https://badge.fury.io/py/bexio-api-python-client.svg\n :target: https://badge.fury.io/py/bexio-api-python-client\n\n.. image:: https://travis-ci.org/oesah/bexio-api-python-client.svg?branch=master\n :target: https://travis-ci.org/oesah/bexio-api-python-client\n\n.. image:: https://codecov.io/gh/oesah/bexio-api-python-client/branch/master/graph/badge.svg\n :target: https://codecov.io/gh/oesah/bexio-api-python-client\n\n.. image:: https://api.codeclimate.com/v1/badges/a3b970ccfc691d06c052/maintainability\n :target: https://codeclimate.com/github/oesah/bexio-api-python-client/maintainability\n :alt: Maintainability\n\n\nBexio API Python Client. It works as a standalone lib in python, but needs\nadditional work to get it started. There is a Django integration, that works\nout of the box, once you set it up properly as described later. If you wish to \nuse it with Python alone, you can take a look at the Django integration. It\nshows how you can use it with python alone.\n\nFeatures\n--------\n\n* API connection to your Bexio instance\n* Django integration\n* Creation & Auto-renewal of access token\n\nDocumentation\n-------------\n\nThe full documentation is at https://bexio-api-python-client.readthedocs.io.\n\nQuickstart\n----------\n\nInstall Bexio API Python Client::\n\n pip install bexio-api-python-client\n\nIf you are using anything other than Django with this module, you need to\nwrite some more code to authenticate and use the API. Check out the Django\nparts of the module to see how it can be done.\n\nDjango Integration\n------------------\n\nYou can use the API directly with Django. There are URLs, Views and other\nhelpers to integrate the API into your Django project.\n\nAdd it to your :code:`INSTALLED_APPS`:\n\n.. code-block:: python\n\n INSTALLED_APPS = (\n ...\n 'bexiopy.apps.BexiopyConfig',\n ...\n )\n\nAdd Bexio API Python Client's URL patterns to your main :code:`urls.py`:\n\n.. code-block:: python\n\n from bexiopy import urls as bexiopy_urls\n\n\n urlpatterns = [\n ...\n url(r'bexiopy/', include('bexiopy.urls', namespace='bexiopy')),\n ...\n ]\n\nStart your server and visit the homepage (e.g. :code:`localhost:8000`).\nYou should see a navigation bar at the top where you can click on \"Authenticate\"\nto create your token. Afterwards, you should see some data on the front page,\nif you have any data in your Bexio instance.\n\n\nDocker\n------\n\nIf you use docker, you can configure a volume to store the token:\n\nExample:\n\n.. code-block:: yaml\n \n # docker-compose.yml\n volumes:\n bexio_token: {}\n\n services:\n app:\n volumes:\n - bexio_token:/app/secrets\n\n # app/Dockerfile\n ...\n RUN mkdir /app/secrets\n ...\n\n\nBasic Usage\n-----------\n\nSee docs for basic usage: https://bexio-api-python-client.readthedocs.io/en/latest/bexiopy.html#bexiopy.api.Client\n\nYou can also use helper functions, so you don't need to create the :code:`call` every time (see docs).\nThese helper functions are added over time, but you can use the API fully, with the\n`call` function. The helper methods only offer nicer ways to query the API (e.g. :code:`Bexiopy().contacts.get(2)`).\nThe progress of the helper functions are documented below under \"Progress\".\n\n\nSettings\n--------\n\nConfigure the minimum :code:`settings.py` (check docs for all options):\n\n.. code-block:: python\n\n BEXIO_CLIENT_SECRET = 'my_secret'\n BEXIO_CLIENT_ID = 'my_id'\n BEXIO_APPLICATION_SCOPES = ['my_scope_1', 'my_scope_2']\n BEXIO_APPLICATION_REDIRECTION_URL = 'https://example.com'\n\n\nStart the server and go to :code:`/bexiopy/auth/` and authenticate with Bexio.\n\n**i18n URLs**\n\nIf you have internationalized URLs, then make sure you place the Bexiopy\nurl outside the internationalized ones, so it can be called without any\nlanguage code (:code:`/bexiopy/auth/` instead of :code:`/en/bexiopy/auth/`).\n\n\nRunning Tests\n-------------\n\nDoes the code actually work?\n\n::\n\n source /bin/activate\n (myenv) $ pip install tox\n (myenv) $ tox\n\nCredits\n-------\n\nTools and libs used in creating this package:\n\n* Cookiecutter_\n* `cookiecutter-djangopackage`_\n* `Christian Ruhstaller (bexio-api-php-client)`_\n\n.. _Cookiecutter: https://github.com/audreyr/cookiecutter\n.. _`cookiecutter-djangopackage`: https://github.com/pydanny/cookiecutter-djangopackage\n.. _`Christian Ruhstaller (bexio-api-php-client)`: https://github.com/christianruhstaller/bexio-api-php-client\n\n\nProgress\n--------\n[ ] = Open\n\n[~] = In Progress\n\n[X] = Done\n\n[-] = Not possible / Ignored\n\n\n\nContacts\n^^^^^^^^\n\nContacts\n========\n\n* [X] List contacts\n* [X] Search contacts\n* [X] Show contact\n* [X] Create contact\n* [X] Overwrite contact\n* [X] Edit contact\n* [X] Delete contact\n* [ ] Bulk create contact\n\n\nSalutations\n===========\n\n* [ ] List salutations\n* [ ] Search salutations\n* [ ] Show salutation\n* [ ] Create salutation\n* [ ] Overwrite salutation\n* [ ] Edit salutation\n* [ ] Delete salutation\n\n\nTitles\n======\n\n* [ ] List titles\n* [ ] Search titles\n* [ ] Show title\n* [ ] Create title\n* [ ] Overwrite title\n* [ ] Edit title\n* [ ] Delete title\n\n\nInvoices\n^^^^^^^^\n* [X] List invoices \n* [X] Search invoices \n* [X] Show invoice \n* [X] Create invoice \n* [X] Overwrite invoice \n* [X] Edit invoice \n* [X] Delete invoice \n* [X] Show invoice pdf \n* [X] Copy invoice \n* [ ] Issue invoice \n* [ ] Mark invoice as sent \n* [ ] Send invoice \n* [ ] List comments \n* [ ] Search comments \n* [ ] Show comment \n* [ ] Create comment \n* [-] List payments \n* [-] Show payments \n* [-] Create payments \n* [-] Delete payments \n\n\n\n\nHistory\n-------\n\n0.1.5 (2017-10-23)\n++++++++++++++++++\n\n* added suport for Python 3.6\n* changed logic, so that you can visit the index page without having a token yet\n\n0.1.0 (2017-10-23)\n++++++++++++++++++\n\n* First release on PyPI.\n", "description_content_type": "", "docs_url": null, "download_url": "", "downloads": { "last_day": -1, "last_month": -1, "last_week": -1 }, "home_page": "https://github.com/oesah/bexio-api-python-client", "keywords": "bexio-api-python-client", "license": "MIT", "maintainer": "", "maintainer_email": "", "name": "bexio-api-python-client", "package_url": "https://pypi.org/project/bexio-api-python-client/", "platform": "", "project_url": "https://pypi.org/project/bexio-api-python-client/", "project_urls": { "Homepage": "https://github.com/oesah/bexio-api-python-client" }, "release_url": "https://pypi.org/project/bexio-api-python-client/0.1.5/", "requires_dist": null, "requires_python": "", "summary": "Bexio API Python Client", "version": "0.1.5" }, "last_serial": 3696751, "releases": { "0.1.0": [ { "comment_text": "", "digests": { "md5": "f3cb96ce92a0fed7fd38226a3b6871b0", "sha256": "870428da4828400d6da17e69abde58f2761d9d373a0a8ed707dd20ef44672bca" }, "downloads": -1, "filename": "bexio_api_python_client-0.1.0-py2.py3-none-any.whl", "has_sig": false, "md5_digest": "f3cb96ce92a0fed7fd38226a3b6871b0", "packagetype": "bdist_wheel", "python_version": "2.7", "requires_python": null, "size": 18649, "upload_time": "2017-12-03T16:40:17", "url": "https://files.pythonhosted.org/packages/5f/24/bdd25e30939ca4fa1a0b20eebb6e20af5c938c98fe48ea1b5792691e7fbe/bexio_api_python_client-0.1.0-py2.py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "dd52938fd0caa5590e16c4393dc7cdca", "sha256": "891c184a599bdabb10e08686121c2597d7c2c387ab982b4701e59a1ac20d67a0" }, "downloads": -1, "filename": "bexio-api-python-client-0.1.0.tar.gz", "has_sig": false, "md5_digest": "dd52938fd0caa5590e16c4393dc7cdca", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 16682, "upload_time": "2017-12-03T16:40:15", "url": "https://files.pythonhosted.org/packages/d3/fa/f0ff18a09a7dbaa4512e08ec4e102c55254e6e92c66cf9894c9be17d035d/bexio-api-python-client-0.1.0.tar.gz" } ], "0.1.1": [ { "comment_text": "", "digests": { "md5": "59c2abbdc5032d6d0abb0e57e6b85d15", "sha256": "dd0e6844d3624a76e8d8880675f9161c40dc2e0199f875f5f0472bc3bff7d13d" }, "downloads": -1, "filename": "bexio_api_python_client-0.1.1-py2.py3-none-any.whl", "has_sig": false, "md5_digest": "59c2abbdc5032d6d0abb0e57e6b85d15", "packagetype": "bdist_wheel", "python_version": "2.7", "requires_python": null, "size": 19394, "upload_time": "2018-01-28T17:27:28", "url": "https://files.pythonhosted.org/packages/d4/6e/b8a0688ee6ab1684730bdfe7ec4bdc1bdfed7d9944ffbee459ec448006d5/bexio_api_python_client-0.1.1-py2.py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "47e7d002508d213a77f3e12e7b623645", "sha256": "46f69428a47de4736912123c9c3ae4f3542bddde1dd242f7ac4d6d1613db0693" }, "downloads": -1, "filename": "bexio-api-python-client-0.1.1.tar.gz", "has_sig": false, "md5_digest": "47e7d002508d213a77f3e12e7b623645", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 17486, "upload_time": "2018-01-28T17:27:25", "url": "https://files.pythonhosted.org/packages/a5/ec/b7fbc58dc65e6949693b8af52c098b205e89068576297000cd0fd40265a9/bexio-api-python-client-0.1.1.tar.gz" } ], "0.1.2": [ { "comment_text": "", "digests": { "md5": "8533ee4bd33aa77b5cfa6366a93adc0a", "sha256": "e1c7c6698722a01e0f1fba20f19c08d7c8d658ac8fefdc032fd5697ed6eb7817" }, "downloads": -1, "filename": "bexio_api_python_client-0.1.2-py2.py3-none-any.whl", "has_sig": false, "md5_digest": "8533ee4bd33aa77b5cfa6366a93adc0a", "packagetype": "bdist_wheel", "python_version": "2.7", "requires_python": null, "size": 19398, "upload_time": "2018-01-28T17:39:43", "url": "https://files.pythonhosted.org/packages/5c/6d/000436dccb70e5c72d30e0a0b7c1127874054e2d86c201dd9c5f356bc216/bexio_api_python_client-0.1.2-py2.py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "74d894bc0f044ce2925bd184c9399c1f", "sha256": "f1ed91e387827b78a50ae373e90b179cd79f6311379026cc7df26a83c67be0b8" }, "downloads": -1, "filename": "bexio-api-python-client-0.1.2.tar.gz", "has_sig": false, "md5_digest": "74d894bc0f044ce2925bd184c9399c1f", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 17495, "upload_time": "2018-01-28T17:39:40", "url": "https://files.pythonhosted.org/packages/53/a4/887d47048cb4c7dbc2dce684c64d62182994ce1e6425a358b2efa3fba7a5/bexio-api-python-client-0.1.2.tar.gz" } ], "0.1.3": [ { "comment_text": "", "digests": { "md5": "664156627c804e7a61519efa568b4a26", "sha256": "99b2c3034588cf53b3902ff6f39e50ed405dd03c2e64a9a2a8dd7ccf35c432ba" }, "downloads": -1, "filename": "bexio_api_python_client-0.1.3-py2.py3-none-any.whl", "has_sig": false, "md5_digest": "664156627c804e7a61519efa568b4a26", "packagetype": "bdist_wheel", "python_version": "2.7", "requires_python": null, "size": 19380, "upload_time": "2018-01-28T18:34:40", "url": "https://files.pythonhosted.org/packages/08/3e/6f19f6766358d2f68af5d0fbccb11b61dae0068d20736b2062cefcd16803/bexio_api_python_client-0.1.3-py2.py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "ae8938d6c4857ad41eaa25482bdf18db", "sha256": "9a98215c7979cfdd654eb7221d830bfc4b8537022ef1e4468bb5cf2f063c613d" }, "downloads": -1, "filename": "bexio-api-python-client-0.1.3.tar.gz", "has_sig": false, "md5_digest": "ae8938d6c4857ad41eaa25482bdf18db", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 17474, "upload_time": "2018-01-28T18:34:38", "url": "https://files.pythonhosted.org/packages/7e/e1/0e147d93f058d1bb4a91755708ec4b7585fc0e6dfd13984947829e4bc091/bexio-api-python-client-0.1.3.tar.gz" } ], "0.1.4": [ { "comment_text": "", "digests": { "md5": "b7f35c8aad07e700872977366fb292c0", "sha256": "819dbbac54288655976a8e93cd0ee52a723b0075bb200e59ace1d7a536d22b02" }, "downloads": -1, "filename": "bexio_api_python_client-0.1.4-py2.py3-none-any.whl", "has_sig": false, "md5_digest": "b7f35c8aad07e700872977366fb292c0", "packagetype": "bdist_wheel", "python_version": "2.7", "requires_python": null, "size": 19393, "upload_time": "2018-02-01T00:29:33", "url": "https://files.pythonhosted.org/packages/2f/6d/e337dcee56b7e59f4fe66d3d1e2a7b3bc24887b9b081e85bce051780d9dc/bexio_api_python_client-0.1.4-py2.py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "1d0f0bb0f93103d71cdfc232a6c5684a", "sha256": "4dc0d19c3e70872bf46231f4c39382d4727cf14e219143e5f7c7ae12c2eef784" }, "downloads": -1, "filename": "bexio-api-python-client-0.1.4.tar.gz", "has_sig": false, "md5_digest": "1d0f0bb0f93103d71cdfc232a6c5684a", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 17493, "upload_time": "2018-02-01T00:29:31", "url": "https://files.pythonhosted.org/packages/58/13/0bc249f3c70915b1be2660e86d508d27b0f977dc96242b17568b45d93532/bexio-api-python-client-0.1.4.tar.gz" } ], "0.1.5": [ { "comment_text": "", "digests": { "md5": "76b85351ad8c8d9147200a705e323fec", "sha256": "5718142d7ac2ae8d4f281671ae25f0766b64f2c6c97aea9bcadbaa33fabf326e" }, "downloads": -1, "filename": "bexio_api_python_client-0.1.5-py2.py3-none-any.whl", "has_sig": false, "md5_digest": "76b85351ad8c8d9147200a705e323fec", "packagetype": "bdist_wheel", "python_version": "3.6", "requires_python": null, "size": 19739, "upload_time": "2018-03-22T20:33:21", "url": "https://files.pythonhosted.org/packages/c1/03/f24bca3274e148b27a268aa1ad297c953c850ff81ea5e2f833a53276f5d9/bexio_api_python_client-0.1.5-py2.py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "888d5c86b00fa6dcce513dd0f59635c3", "sha256": "3cc928262efe53eea496547434474c07d42d111f37990148d7d97577ab63bf46" }, "downloads": -1, "filename": "bexio-api-python-client-0.1.5.tar.gz", "has_sig": false, "md5_digest": "888d5c86b00fa6dcce513dd0f59635c3", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 17876, "upload_time": "2018-03-22T20:33:19", "url": "https://files.pythonhosted.org/packages/72/1a/6465a3ff77804a161be4e59867b7e59fdd98dc4e386be66d1d63fe06a015/bexio-api-python-client-0.1.5.tar.gz" } ] }, "urls": [ { "comment_text": "", "digests": { "md5": "76b85351ad8c8d9147200a705e323fec", "sha256": "5718142d7ac2ae8d4f281671ae25f0766b64f2c6c97aea9bcadbaa33fabf326e" }, "downloads": -1, "filename": "bexio_api_python_client-0.1.5-py2.py3-none-any.whl", "has_sig": false, "md5_digest": "76b85351ad8c8d9147200a705e323fec", "packagetype": "bdist_wheel", "python_version": "3.6", "requires_python": null, "size": 19739, "upload_time": "2018-03-22T20:33:21", "url": "https://files.pythonhosted.org/packages/c1/03/f24bca3274e148b27a268aa1ad297c953c850ff81ea5e2f833a53276f5d9/bexio_api_python_client-0.1.5-py2.py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "888d5c86b00fa6dcce513dd0f59635c3", "sha256": "3cc928262efe53eea496547434474c07d42d111f37990148d7d97577ab63bf46" }, "downloads": -1, "filename": "bexio-api-python-client-0.1.5.tar.gz", "has_sig": false, "md5_digest": "888d5c86b00fa6dcce513dd0f59635c3", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 17876, "upload_time": "2018-03-22T20:33:19", "url": "https://files.pythonhosted.org/packages/72/1a/6465a3ff77804a161be4e59867b7e59fdd98dc4e386be66d1d63fe06a015/bexio-api-python-client-0.1.5.tar.gz" } ] }