python-homegate
python-homegate (https://github.com/arteria/python-homegate) is a python library used to interact with Homegate (http://www.homegate.ch) using the IDX3.01 API. python-homegate implements the official IDX3.01 API but is not an official library by Homegate. For all non python-homegate related issues, contracts, credentials, question regarding Homegate, etc. please contact Homegate AG directly!
Use the issue tracking system for all pyhton-homegate related issues, bug reports, feature request, etc.
Installation
If you want the latest stable version of python-homegate from PyPi, install using
pip install homegate
Or, if you prefer to install the latest and greates commit from GitHub, install using
pip install -e git+https://github.com/arteria/python-homegate.git#egg=homegate
You should know what you do by choosing the second option. ;-)
Usage
NOT WORKING CURRENTLY - WORK IN PROGRESS!
Connect to Homegate
>>> from homegate.homegate import Homegate, IdxRecord >>> hg = Homegate(MY_AGENCY_ID, HOST, USERNAME, PASSWORD)
Create an empty record and set/update data
>>> rec = IdxRecord()
>>> rec.update({'object_city':'Basel', 'object_country':'CH'})
>>> rec.update({'picture_1_filename': '/Users/phi/Desktop/country-house.jpg', 'picture_1_title': 'Country house front view'})
Publish (push) to Homegate and disconnect
>>> hg.push(rec) >>> del hg good bye >>>
Options
Define a prefix for IdxRcords. This allows to have unique filenames for the FTP processing. The process is triggered three times a day (at 6h00, 12h00 and 18h00).
>>> rec_1234 = IdxRecord(prefix='1234-')
To push multiple records at once, pass a list of records.
>>> rec_2345 = IdxRecord(prefix='2345-') >>> rec_3465 = IdxRecord(prefix='3456-') >>> hg.push([rec_1234, rec_2345, rec_3465])
Contribution
Fork the python-homegate repository
Make your well commented and clean commits to the repository
Send a pull request (https://help.github.com/articles/using-pull-requests)
TODO
WIP: Type and length validation for each field
Changelog
0.0.2
Added convert to X functions for automatic type and length conversion of fields in an IDX record.
0.0.1
arteria GmbH open sourced the initial working version of [python-homegate](https://github.com/arteria/python-homegate) allowing to push real estate objects and property to Homegate using the IDX3.01 API.
1 maintainer
Metadata
1 maintainer
Release files for homegate 0.0.2
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | Provenance | Actions |
|---|---|---|---|---|
| homegate-0.0.2.tar.gz | 4.9 kB | Without provenance | Details for homegate-0.0.2.tar.gz |
Release files / homegate-0.0.2.tar.gz
| Download URL | homegate-0.0.2.tar.gz |
|---|---|
| Size | 4.9 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
f0dd4c641235e29fcf9239648119592fa35cd6e4f5247552b864619baedcfb4c
|
|
BLAKE2b-256 checksum How to use checksums |
5cacf3df5d4aa8fd1ce0de4fd86e065602ff286c9be8e2bc3551a3bae96f28ca
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
Security for homegate 0.0.2
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
No provenance found
None of the files in this release were uploaded with provenance metadata.
A note on package security
PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.
To learn more about protecting yourself from malicious actors, visit our package security documentation.
