HoLcStore
HoLcStore is a Django app for creating a simple TimeSeries store in your database.
Getting Started
- Add "holcstore" to your INSTALLED_APPS setting like this
INSTALLED_APPS = [
...,
"holcstore",
]
- Start using the abstract model
Storeby importing it
from hostore.models import Store
class YourStore(Store):
# add new fields
class Meta(Store.Meta):
abstract = False
# add your meta
Basic Usage : Store class
Saving a timeserie to database
from path.to.YourStore import YourStore
import pandas as pd
key = "3000014324556"
client_id = 0
idx = pd.date_range('2024-01-01 00:00:00+00:00', '2024-01-02 00:00:00+00:00', freq='30min')
ds = pd.Series(data=[1]*len(idx), index=idx)
# Put the load curve to the store without versionning
YourStore.set_lc(key, ds, client_id)
# If you want to activate the versionning
YourStore.set_lc(key, ds, client_id, versionning=True)
# Each time you call set_lc with your id, a new version will be saved in the database
Saving multiple timeseries to database
from path.to.YourStore import YourStore
import pandas as pd
key = "3000014324556"
client_id = 0
idx = pd.date_range('2024-01-01 00:00:00+00:00', '2024-01-02 00:00:00+00:00', freq='30min')
df = pd.Series(data={'key1': [1]*len(idx), 'key2': [2]*len(idx), }, index=idx)
# Put the load curve to the store without versionning
YourStore.set_many_lc(df, client_id)
# If you want to activate the versionning
YourStore.set_many_lc(df, client_id, versionning=True)
Getting a load curve from the database
from path.to.YourStore import YourStore
key = "3000014324556"
client_id = 0
# Get the load curve from the database
# I multiple versions exists, they will be combined beginning with the version 0 and using
# https://pandas.pydata.org/docs/reference/api/pandas.DataFrame.combine_first.html
datas = YourStore.get_lc(key, client_id)
if not datas:
my_timeserie = datas[0]['data']
last_updated = datas[0]['last_modified']
# If you want to retreive all versions
datas = YourStore.get_lc(key, client_id, combined_versions=False)
# datas contains all timeseries linked to key
# If you want to retreive a specific version
datas = YourStore.get_lc(key, client_id, version=1)
Basic Usage : TimeseriesStore class
Define your class in models.py
class MyTimeseriesStore(TimeseriesStore):
year = models.IntegerField()
kind = models.CharField(max_length=100)
class Meta(TimeseriesStore.Meta):
unique_together = ('year', 'kind')
Usage samples
# specify attributes to set
ts_attrs = dict(year=2020, kind='a')
# build a timeserie
ds_ts = pd.Series(...)
# set timeserie to db
MyTimeseriesStore.set_ts(ts_attrs, ds_ts)
# update existing timeserie in db (will combine ds_ts + ds_ts_v2, giving priority to ds_ts_v2 datas)
MyTimeseriesStore.set_ts(ts_attrs, ds_ts_v2, update=True)
# get timeserie from db if unique match
ds_ts = MyTimeseriesStore.get_ts(ts_attrs, flat=True)
# get timeseries from db if multiple match
datas = MyTimeseriesStore.get_ts(ts_attrs)
ds_ts1 = datas[0]['data']
Metadata
Release files for holcstore 0.3.3
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 |
|---|---|---|---|---|
| holcstore-0.3.3.tar.gz | 20.6 kB | Without provenance | Details for holcstore-0.3.3.tar.gz |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Actions Reset |
|---|---|---|---|---|
| holcstore-0.3.3-py3-none-any.whl | Python 3 | none | any | Details for holcstore-0.3.3-py3-none-any.whl |
Total release size: 49.8 kB
Release files / holcstore-0.3.3.tar.gz
| Download URL | holcstore-0.3.3.tar.gz |
|---|---|
| Size | 20.6 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
0601dd6898d7fea41e3a24c0ee7aef154b3e10273c7cb92f237b9ab675262b06
|
|
BLAKE2b-256 checksum How to use checksums |
e1b76eeea0c8ef14422ae2cd35c1e08f439d570f384533cc5ce499bcf9a77f60
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/5.1.1 CPython/3.12.6
|
Release files / holcstore-0.3.3-py3-none-any.whl
| Download URL | holcstore-0.3.3-py3-none-any.whl |
|---|---|
| Size | 29.2 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
ab34020119afa1d5001b26b8ddda53b13c5e9c9ef22552fadaa3b44396b206dc
|
|
BLAKE2b-256 checksum How to use checksums |
8e6dda3ec96fe37cc6b2626dd1c7dd14ce401da2e358bb756b2fff1989002c1c
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/5.1.1 CPython/3.12.6
|
Security for holcstore 0.3.3
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.