alasco 0.0.8

A SDK to facilitate the interaction with the Alasco API.

Alasco

Introduction

This package is an SDK for python to facilitate interaction with the Alasco API.

The official documentation from Alasco can be found here.

How to install it

Run the following command in your terminal:

pip install alasco

Get started

Import the alasco module and then instantiate the client like this:

from alasco import Alasco
from dotenv import load_dotenv, find_dotenv

_ = load_dotenv(find_dotenv(raise_error_if_not_found=True))

token = os.environ["token"] # your alasco token
key = os.environ["key"] # your alasco key

alasco = Alasco(token=token, key=key, verbose=True)

Example 1 : fetch all DataFrames

dfs = alasco.data_fetcher.get_all_df()
dfs["properties"].head(2)

Output:

	id	type	name	description	address	zip_code	city	country	date_created	relationships.projects.links.related
0	97bad92e-0fd8-4987-9f8e-aafcd4eafcd7	PROPERTY	Wohnpark Unteraching		Am Sportpark 4	82008	Unterhaching		2022-09-19T12:15:55.539340+00:00	https://api.alasco.de/v1/properties/97bad92e-0fd8-4987-9f8e-aafcd4eafcd7/projects/
1	6ee2f67d-6911-4085-a7b3-4dbc370f494f	PROPERTY	Grundstück Leopoldstraße		Leopoldstr. 21	80802	München		2021-07-14T09:50:47.760738+00:00	https://api.alasco.de/v1/properties/6ee2f67d-6911-4085-a7b3-4dbc370f494f/projects/

Example 2 : Batch download documents

Download all documents (contracts, invoices, change orders) for a particular property locally. This can be useful for backup purposes.

property_name = "YOUR_PROPERTY_NAME"
dfs = alasco.data_fetcher.get_all_df(property_name = property_name)
alasco.document_downloader.batch_download_documents(dfs=dfs, property_name = property_name)